diff --git a/Makefile b/Makefile index 0dab8e71..75579514 100644 --- a/Makefile +++ b/Makefile @@ -10,13 +10,13 @@ sdk: test: @echo === Testing the SDK === - @python -m pytest test + @python -m pytest tests format: @echo @echo === Formatting the Generator === - @isort foundry test --profile black --multi-line NOQA -sl --project foundry - @python -m black foundry test + @isort foundry tests --profile black --multi-line NOQA -sl --project foundry + @python -m black foundry tests lint: @echo === Linting the SDK === diff --git a/README.md b/README.md index b71b9ef6..1c06c9d4 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ pip install foundry-platform-sdk Then, import the package: ```python -import foundry +import foundry.v2 ``` @@ -52,7 +52,7 @@ https:///api/v1/... ``` This SDK exposes several clients, one for each major version of the API. For example, the latest major version of the -SDK is **v2** and is exposed using the `FoundryV2Client` located in the +SDK is **v2** and is exposed using the `FoundryClient` located in the `foundry.v2` package. To use this SDK, you must choose the specific client (or clients) you would like to use. @@ -86,7 +86,7 @@ You can pass in the hostname and token as keyword arguments when initializing the `UserTokenAuth`: ```python -foundry_client = foundry.v2.FoundryV2Client( +foundry_client = foundry.v2.FoundryClient( auth=foundry.UserTokenAuth( hostname="example.palantirfoundry.com", token=os.environ["BEARER_TOKEN"], @@ -121,10 +121,10 @@ auth.sign_in_as_service_user() > Make sure to select the appropriate scopes when initializating the `ConfidentialClientAuth`. You can find the relevant scopes > in the [endpoint documentation](#apis-link). -After creating the `ConfidentialClientAuth` object, pass it in to the `FoundryV2Client`, +After creating the `ConfidentialClientAuth` object, pass it in to the `FoundryClient`, ```python -foundry_client = foundry.v2.FoundryV2Client(auth=auth, hostname="example.palantirfoundry.com") +foundry_client = foundry.v2.FoundryClient(auth=auth, hostname="example.palantirfoundry.com") ``` ## Quickstart @@ -134,25 +134,27 @@ best suited for your instance before following this example. For simplicity, the purposes. ```python -from foundry.v1 import FoundryV1Client +from foundry.v1 import FoundryClient from foundry import PalantirRPCException from pprint import pprint -foundry_client = FoundryV1Client( +foundry_client = FoundryClient( auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" ) # DatasetRid | datasetRid dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" - -# Union[CreateBranchRequest, CreateBranchRequestDict] | Body of the request -create_branch_request = {"branchId": "my-branch"} +# BranchId | +branch_id = "my-branch" +# Optional[TransactionRid] | +transaction_rid = None try: api_response = foundry_client.datasets.Dataset.Branch.create( dataset_rid, - create_branch_request, + branch_id=branch_id, + transaction_rid=transaction_rid, ) print("The create response:\n") pprint(api_response) @@ -170,13 +172,14 @@ Want to learn more about this Foundry SDK library? Review the following sections ## Error handling ### Data validation The SDK employs [Pydantic](https://docs.pydantic.dev/latest/) for runtime validation -of arguments. In the example below, we are passing in a number to `transactionRid` +of arguments. In the example below, we are passing in a number to `transaction_rid` which should actually be a string type: ```python foundry_client.datasets.Dataset.Branch.create( "ri.foundry.main.dataset.abc", - create_branch_request={"branchId": "123", "transactionRid": 123}, + name="123", + transaction_rid=123, ) ``` @@ -184,7 +187,7 @@ If you did this, you would receive an error that looks something like: ``` pydantic_core._pydantic_core.ValidationError: 1 validation error for create -create_branch_request.transactionRid +transaction_rid Input should be a valid string [type=string_type, input_value=123, input_type=int] For further information visit https://errors.pydantic.dev/2.5/v/string_type ``` @@ -249,42 +252,43 @@ while page.next_page_token: ## Static type analysis This library uses [Pydantic](https://docs.pydantic.dev) for creating and validating data models which you will see in the method definitions (see [Documentation for Models](#models-link) below for a full list of models). All request parameters with nested -objects use both [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict) and `Pydantic` models (either can -be passed in) whereas responses only use `Pydantic` models. For example, here is how `Branch.create` method is defined in the -datasets namespace: +models use a [TypedDict](https://docs.python.org/3/library/typing.html#typing.TypedDict) whereas responses use `Pydantic` +models. For example, here is how `Group.search` method is defined in the `Admin` namespace: ```python - def create( + @validate_call + @handle_unexpected + def search( self, - dataset_rid: DatasetRid, - create_branch_request: Union[CreateBranchRequest, CreateBranchRequestDict], *, + where: GroupSearchFilterDict, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + preview: Optional[PreviewMode] = None, request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Branch: + ) -> SearchGroupsResponse: ... ``` > [!TIP] > A `Pydantic` model can be converted into its `TypedDict` representation using the `to_dict` method. For example, if you handle -> a variable of type `CreateBranchRequest` and you called `to_dict()` on that variable you would receive a `CreateBranchRequestDict` +> a variable of type `Branch` and you called `to_dict()` on that variable you would receive a `BranchDict` > variable. If you are using a static type checker (for example, [mypy](https://mypy-lang.org), [pyright](https://github.com/microsoft/pyright)), you -get static type analysis for the arguments you provide to the function *and* with the response. For example, if you pass an `int` -to `branchId` while calling `create` and then try to access `branchId` in returned [`Branch`](docs/Branch.md) object (the -property is actually called `branch_id`), you will get the following errors: +get static type analysis for the arguments you provide to the function and with the response. For example, if you pass an `int` +to `name` but `name` expects a string or if you try to access `branchName` on the returned [`Branch`](docs/Branch.md) object (the +property is actually called `name`), you will get the following errors: ```python branch = foundry_client.datasets.Dataset.Branch.create( "ri.foundry.main.dataset.abc", - create_branch_request={ - # ERROR: "Literal[123]" is incompatible with "BranchId" - "branchId": 123 - }, + # ERROR: "Literal[123]" is incompatible with "BranchName" + name=123, ) -# ERROR: Cannot access member "branchId" for type "Branch" -print(branch.branchId) +# ERROR: Cannot access member "branchName" for type "Branch" +print(branch.branchName) ``` ## Common errors @@ -305,168 +309,299 @@ production use. Namespace | Resource | Operation | HTTP request | ------------ | ------------- | ------------- | ------------- | -**Admin** | Group | [**create**](docs/v2/namespaces/Admin/Group.md#create) | **POST** /v2/admin/groups | -**Admin** | Group | [**delete**](docs/v2/namespaces/Admin/Group.md#delete) | **DELETE** /v2/admin/groups/{groupId} | -**Admin** | Group | [**get**](docs/v2/namespaces/Admin/Group.md#get) | **GET** /v2/admin/groups/{groupId} | -**Admin** | Group | [**get_batch**](docs/v2/namespaces/Admin/Group.md#get_batch) | **POST** /v2/admin/groups/getBatch | -**Admin** | Group | [**list**](docs/v2/namespaces/Admin/Group.md#list) | **GET** /v2/admin/groups | -**Admin** | Group | [**page**](docs/v2/namespaces/Admin/Group.md#page) | **GET** /v2/admin/groups | -**Admin** | Group | [**search**](docs/v2/namespaces/Admin/Group.md#search) | **POST** /v2/admin/groups/search | -**Admin** | GroupMember | [**add**](docs/v2/namespaces/Admin/GroupMember.md#add) | **POST** /v2/admin/groups/{groupId}/groupMembers/add | -**Admin** | GroupMember | [**list**](docs/v2/namespaces/Admin/GroupMember.md#list) | **GET** /v2/admin/groups/{groupId}/groupMembers | -**Admin** | GroupMember | [**page**](docs/v2/namespaces/Admin/GroupMember.md#page) | **GET** /v2/admin/groups/{groupId}/groupMembers | -**Admin** | GroupMember | [**remove**](docs/v2/namespaces/Admin/GroupMember.md#remove) | **POST** /v2/admin/groups/{groupId}/groupMembers/remove | -**Admin** | GroupMembership | [**list**](docs/v2/namespaces/Admin/GroupMembership.md#list) | **GET** /v2/admin/users/{userId}/groupMemberships | -**Admin** | GroupMembership | [**page**](docs/v2/namespaces/Admin/GroupMembership.md#page) | **GET** /v2/admin/users/{userId}/groupMemberships | -**Admin** | User | [**delete**](docs/v2/namespaces/Admin/User.md#delete) | **DELETE** /v2/admin/users/{userId} | -**Admin** | User | [**get**](docs/v2/namespaces/Admin/User.md#get) | **GET** /v2/admin/users/{userId} | -**Admin** | User | [**get_batch**](docs/v2/namespaces/Admin/User.md#get_batch) | **POST** /v2/admin/users/getBatch | -**Admin** | User | [**get_current**](docs/v2/namespaces/Admin/User.md#get_current) | **GET** /v2/admin/users/getCurrent | -**Admin** | User | [**list**](docs/v2/namespaces/Admin/User.md#list) | **GET** /v2/admin/users | -**Admin** | User | [**page**](docs/v2/namespaces/Admin/User.md#page) | **GET** /v2/admin/users | -**Admin** | User | [**profile_picture**](docs/v2/namespaces/Admin/User.md#profile_picture) | **GET** /v2/admin/users/{userId}/profilePicture | -**Admin** | User | [**search**](docs/v2/namespaces/Admin/User.md#search) | **POST** /v2/admin/users/search | -**Datasets** | Branch | [**create**](docs/v2/namespaces/Datasets/Branch.md#create) | **POST** /v2/datasets/{datasetRid}/branches | -**Datasets** | Branch | [**delete**](docs/v2/namespaces/Datasets/Branch.md#delete) | **DELETE** /v2/datasets/{datasetRid}/branches/{branchName} | -**Datasets** | Branch | [**get**](docs/v2/namespaces/Datasets/Branch.md#get) | **GET** /v2/datasets/{datasetRid}/branches/{branchName} | -**Datasets** | Branch | [**list**](docs/v2/namespaces/Datasets/Branch.md#list) | **GET** /v2/datasets/{datasetRid}/branches | -**Datasets** | Branch | [**page**](docs/v2/namespaces/Datasets/Branch.md#page) | **GET** /v2/datasets/{datasetRid}/branches | -**Datasets** | Dataset | [**create**](docs/v2/namespaces/Datasets/Dataset.md#create) | **POST** /v2/datasets | -**Datasets** | Dataset | [**get**](docs/v2/namespaces/Datasets/Dataset.md#get) | **GET** /v2/datasets/{datasetRid} | -**Datasets** | Dataset | [**read_table**](docs/v2/namespaces/Datasets/Dataset.md#read_table) | **GET** /v2/datasets/{datasetRid}/readTable | -**Datasets** | File | [**content**](docs/v2/namespaces/Datasets/File.md#content) | **GET** /v2/datasets/{datasetRid}/files/{filePath}/content | -**Datasets** | File | [**delete**](docs/v2/namespaces/Datasets/File.md#delete) | **DELETE** /v2/datasets/{datasetRid}/files/{filePath} | -**Datasets** | File | [**get**](docs/v2/namespaces/Datasets/File.md#get) | **GET** /v2/datasets/{datasetRid}/files/{filePath} | -**Datasets** | File | [**list**](docs/v2/namespaces/Datasets/File.md#list) | **GET** /v2/datasets/{datasetRid}/files | -**Datasets** | File | [**page**](docs/v2/namespaces/Datasets/File.md#page) | **GET** /v2/datasets/{datasetRid}/files | -**Datasets** | File | [**upload**](docs/v2/namespaces/Datasets/File.md#upload) | **POST** /v2/datasets/{datasetRid}/files/{filePath}/upload | -**Datasets** | Transaction | [**abort**](docs/v2/namespaces/Datasets/Transaction.md#abort) | **POST** /v2/datasets/{datasetRid}/transactions/{transactionRid}/abort | -**Datasets** | Transaction | [**commit**](docs/v2/namespaces/Datasets/Transaction.md#commit) | **POST** /v2/datasets/{datasetRid}/transactions/{transactionRid}/commit | -**Datasets** | Transaction | [**create**](docs/v2/namespaces/Datasets/Transaction.md#create) | **POST** /v2/datasets/{datasetRid}/transactions | -**Datasets** | Transaction | [**get**](docs/v2/namespaces/Datasets/Transaction.md#get) | **GET** /v2/datasets/{datasetRid}/transactions/{transactionRid} | -**Ontologies** | Action | [**apply**](docs/v2/namespaces/Ontologies/Action.md#apply) | **POST** /v2/ontologies/{ontology}/actions/{action}/apply | -**Ontologies** | Action | [**apply_batch**](docs/v2/namespaces/Ontologies/Action.md#apply_batch) | **POST** /v2/ontologies/{ontology}/actions/{action}/applyBatch | -**Ontologies** | ActionType | [**get**](docs/v2/namespaces/Ontologies/ActionType.md#get) | **GET** /v2/ontologies/{ontology}/actionTypes/{actionType} | -**Ontologies** | ActionType | [**list**](docs/v2/namespaces/Ontologies/ActionType.md#list) | **GET** /v2/ontologies/{ontology}/actionTypes | -**Ontologies** | ActionType | [**page**](docs/v2/namespaces/Ontologies/ActionType.md#page) | **GET** /v2/ontologies/{ontology}/actionTypes | -**Ontologies** | Attachment | [**get**](docs/v2/namespaces/Ontologies/Attachment.md#get) | **GET** /v2/ontologies/attachments/{attachmentRid} | -**Ontologies** | Attachment | [**read**](docs/v2/namespaces/Ontologies/Attachment.md#read) | **GET** /v2/ontologies/attachments/{attachmentRid}/content | -**Ontologies** | Attachment | [**upload**](docs/v2/namespaces/Ontologies/Attachment.md#upload) | **POST** /v2/ontologies/attachments/upload | -**Ontologies** | AttachmentProperty | [**get_attachment**](docs/v2/namespaces/Ontologies/AttachmentProperty.md#get_attachment) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property} | -**Ontologies** | AttachmentProperty | [**get_attachment_by_rid**](docs/v2/namespaces/Ontologies/AttachmentProperty.md#get_attachment_by_rid) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid} | -**Ontologies** | AttachmentProperty | [**read_attachment**](docs/v2/namespaces/Ontologies/AttachmentProperty.md#read_attachment) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content | -**Ontologies** | AttachmentProperty | [**read_attachment_by_rid**](docs/v2/namespaces/Ontologies/AttachmentProperty.md#read_attachment_by_rid) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content | -**Ontologies** | LinkedObject | [**get_linked_object**](docs/v2/namespaces/Ontologies/LinkedObject.md#get_linked_object) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} | -**Ontologies** | LinkedObject | [**list_linked_objects**](docs/v2/namespaces/Ontologies/LinkedObject.md#list_linked_objects) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} | -**Ontologies** | LinkedObject | [**page_linked_objects**](docs/v2/namespaces/Ontologies/LinkedObject.md#page_linked_objects) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} | -**Ontologies** | ObjectType | [**get**](docs/v2/namespaces/Ontologies/ObjectType.md#get) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType} | -**Ontologies** | ObjectType | [**get_outgoing_link_type**](docs/v2/namespaces/Ontologies/ObjectType.md#get_outgoing_link_type) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} | -**Ontologies** | ObjectType | [**list**](docs/v2/namespaces/Ontologies/ObjectType.md#list) | **GET** /v2/ontologies/{ontology}/objectTypes | -**Ontologies** | ObjectType | [**list_outgoing_link_types**](docs/v2/namespaces/Ontologies/ObjectType.md#list_outgoing_link_types) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes | -**Ontologies** | ObjectType | [**page**](docs/v2/namespaces/Ontologies/ObjectType.md#page) | **GET** /v2/ontologies/{ontology}/objectTypes | -**Ontologies** | ObjectType | [**page_outgoing_link_types**](docs/v2/namespaces/Ontologies/ObjectType.md#page_outgoing_link_types) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes | -**Ontologies** | Ontology | [**get**](docs/v2/namespaces/Ontologies/Ontology.md#get) | **GET** /v2/ontologies/{ontology} | -**Ontologies** | Ontology | [**get_full_metadata**](docs/v2/namespaces/Ontologies/Ontology.md#get_full_metadata) | **GET** /v2/ontologies/{ontology}/fullMetadata | -**Ontologies** | OntologyInterface | [**aggregate**](docs/v2/namespaces/Ontologies/OntologyInterface.md#aggregate) | **POST** /v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate | -**Ontologies** | OntologyInterface | [**get**](docs/v2/namespaces/Ontologies/OntologyInterface.md#get) | **GET** /v2/ontologies/{ontology}/interfaceTypes/{interfaceType} | -**Ontologies** | OntologyInterface | [**list**](docs/v2/namespaces/Ontologies/OntologyInterface.md#list) | **GET** /v2/ontologies/{ontology}/interfaceTypes | -**Ontologies** | OntologyInterface | [**page**](docs/v2/namespaces/Ontologies/OntologyInterface.md#page) | **GET** /v2/ontologies/{ontology}/interfaceTypes | -**Ontologies** | OntologyObject | [**aggregate**](docs/v2/namespaces/Ontologies/OntologyObject.md#aggregate) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/aggregate | -**Ontologies** | OntologyObject | [**count**](docs/v2/namespaces/Ontologies/OntologyObject.md#count) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/count | -**Ontologies** | OntologyObject | [**get**](docs/v2/namespaces/Ontologies/OntologyObject.md#get) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey} | -**Ontologies** | OntologyObject | [**list**](docs/v2/namespaces/Ontologies/OntologyObject.md#list) | **GET** /v2/ontologies/{ontology}/objects/{objectType} | -**Ontologies** | OntologyObject | [**page**](docs/v2/namespaces/Ontologies/OntologyObject.md#page) | **GET** /v2/ontologies/{ontology}/objects/{objectType} | -**Ontologies** | OntologyObject | [**search**](docs/v2/namespaces/Ontologies/OntologyObject.md#search) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/search | -**Ontologies** | OntologyObjectSet | [**aggregate**](docs/v2/namespaces/Ontologies/OntologyObjectSet.md#aggregate) | **POST** /v2/ontologies/{ontology}/objectSets/aggregate | -**Ontologies** | OntologyObjectSet | [**create_temporary**](docs/v2/namespaces/Ontologies/OntologyObjectSet.md#create_temporary) | **POST** /v2/ontologies/{ontology}/objectSets/createTemporary | -**Ontologies** | OntologyObjectSet | [**get**](docs/v2/namespaces/Ontologies/OntologyObjectSet.md#get) | **GET** /v2/ontologies/{ontology}/objectSets/{objectSetRid} | -**Ontologies** | OntologyObjectSet | [**load**](docs/v2/namespaces/Ontologies/OntologyObjectSet.md#load) | **POST** /v2/ontologies/{ontology}/objectSets/loadObjects | -**Ontologies** | Query | [**execute**](docs/v2/namespaces/Ontologies/Query.md#execute) | **POST** /v2/ontologies/{ontology}/queries/{queryApiName}/execute | -**Ontologies** | QueryType | [**get**](docs/v2/namespaces/Ontologies/QueryType.md#get) | **GET** /v2/ontologies/{ontology}/queryTypes/{queryApiName} | -**Ontologies** | QueryType | [**list**](docs/v2/namespaces/Ontologies/QueryType.md#list) | **GET** /v2/ontologies/{ontology}/queryTypes | -**Ontologies** | QueryType | [**page**](docs/v2/namespaces/Ontologies/QueryType.md#page) | **GET** /v2/ontologies/{ontology}/queryTypes | -**Ontologies** | TimeSeriesPropertyV2 | [**get_first_point**](docs/v2/namespaces/Ontologies/TimeSeriesPropertyV2.md#get_first_point) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint | -**Ontologies** | TimeSeriesPropertyV2 | [**get_last_point**](docs/v2/namespaces/Ontologies/TimeSeriesPropertyV2.md#get_last_point) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint | -**Ontologies** | TimeSeriesPropertyV2 | [**stream_points**](docs/v2/namespaces/Ontologies/TimeSeriesPropertyV2.md#stream_points) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints | -**Orchestration** | Build | [**create**](docs/v2/namespaces/Orchestration/Build.md#create) | **POST** /v2/orchestration/builds/create | -**Orchestration** | Build | [**get**](docs/v2/namespaces/Orchestration/Build.md#get) | **GET** /v2/orchestration/builds/{buildRid} | -**Orchestration** | Schedule | [**get**](docs/v2/namespaces/Orchestration/Schedule.md#get) | **GET** /v2/orchestration/schedules/{scheduleRid} | -**Orchestration** | Schedule | [**pause**](docs/v2/namespaces/Orchestration/Schedule.md#pause) | **POST** /v2/orchestration/schedules/{scheduleRid}/pause | -**Orchestration** | Schedule | [**run**](docs/v2/namespaces/Orchestration/Schedule.md#run) | **POST** /v2/orchestration/schedules/{scheduleRid}/run | -**Orchestration** | Schedule | [**unpause**](docs/v2/namespaces/Orchestration/Schedule.md#unpause) | **POST** /v2/orchestration/schedules/{scheduleRid}/unpause | -**ThirdPartyApplications** | ThirdPartyApplication | [**get**](docs/v2/namespaces/ThirdPartyApplications/ThirdPartyApplication.md#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid} | -**ThirdPartyApplications** | Version | [**delete**](docs/v2/namespaces/ThirdPartyApplications/Version.md#delete) | **DELETE** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | -**ThirdPartyApplications** | Version | [**get**](docs/v2/namespaces/ThirdPartyApplications/Version.md#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | -**ThirdPartyApplications** | Version | [**list**](docs/v2/namespaces/ThirdPartyApplications/Version.md#list) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions | -**ThirdPartyApplications** | Version | [**page**](docs/v2/namespaces/ThirdPartyApplications/Version.md#page) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions | -**ThirdPartyApplications** | Version | [**upload**](docs/v2/namespaces/ThirdPartyApplications/Version.md#upload) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/upload | -**ThirdPartyApplications** | Website | [**deploy**](docs/v2/namespaces/ThirdPartyApplications/Website.md#deploy) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/deploy | -**ThirdPartyApplications** | Website | [**get**](docs/v2/namespaces/ThirdPartyApplications/Website.md#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website | -**ThirdPartyApplications** | Website | [**undeploy**](docs/v2/namespaces/ThirdPartyApplications/Website.md#undeploy) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/undeploy | +**Admin** | Group | [**create**](docs/v2/Admin/Group.md#create) | **POST** /v2/admin/groups | +**Admin** | Group | [**delete**](docs/v2/Admin/Group.md#delete) | **DELETE** /v2/admin/groups/{groupId} | +**Admin** | Group | [**get**](docs/v2/Admin/Group.md#get) | **GET** /v2/admin/groups/{groupId} | +**Admin** | Group | [**get_batch**](docs/v2/Admin/Group.md#get_batch) | **POST** /v2/admin/groups/getBatch | +**Admin** | Group | [**list**](docs/v2/Admin/Group.md#list) | **GET** /v2/admin/groups | +**Admin** | Group | [**page**](docs/v2/Admin/Group.md#page) | **GET** /v2/admin/groups | +**Admin** | Group | [**search**](docs/v2/Admin/Group.md#search) | **POST** /v2/admin/groups/search | +**Admin** | GroupMember | [**add**](docs/v2/Admin/GroupMember.md#add) | **POST** /v2/admin/groups/{groupId}/groupMembers/add | +**Admin** | GroupMember | [**list**](docs/v2/Admin/GroupMember.md#list) | **GET** /v2/admin/groups/{groupId}/groupMembers | +**Admin** | GroupMember | [**page**](docs/v2/Admin/GroupMember.md#page) | **GET** /v2/admin/groups/{groupId}/groupMembers | +**Admin** | GroupMember | [**remove**](docs/v2/Admin/GroupMember.md#remove) | **POST** /v2/admin/groups/{groupId}/groupMembers/remove | +**Admin** | GroupMembership | [**list**](docs/v2/Admin/GroupMembership.md#list) | **GET** /v2/admin/users/{userId}/groupMemberships | +**Admin** | GroupMembership | [**page**](docs/v2/Admin/GroupMembership.md#page) | **GET** /v2/admin/users/{userId}/groupMemberships | +**Admin** | User | [**delete**](docs/v2/Admin/User.md#delete) | **DELETE** /v2/admin/users/{userId} | +**Admin** | User | [**get**](docs/v2/Admin/User.md#get) | **GET** /v2/admin/users/{userId} | +**Admin** | User | [**get_batch**](docs/v2/Admin/User.md#get_batch) | **POST** /v2/admin/users/getBatch | +**Admin** | User | [**get_current**](docs/v2/Admin/User.md#get_current) | **GET** /v2/admin/users/getCurrent | +**Admin** | User | [**list**](docs/v2/Admin/User.md#list) | **GET** /v2/admin/users | +**Admin** | User | [**page**](docs/v2/Admin/User.md#page) | **GET** /v2/admin/users | +**Admin** | User | [**profile_picture**](docs/v2/Admin/User.md#profile_picture) | **GET** /v2/admin/users/{userId}/profilePicture | +**Admin** | User | [**search**](docs/v2/Admin/User.md#search) | **POST** /v2/admin/users/search | +**Datasets** | Branch | [**create**](docs/v2/Datasets/Branch.md#create) | **POST** /v2/datasets/{datasetRid}/branches | +**Datasets** | Branch | [**delete**](docs/v2/Datasets/Branch.md#delete) | **DELETE** /v2/datasets/{datasetRid}/branches/{branchName} | +**Datasets** | Branch | [**get**](docs/v2/Datasets/Branch.md#get) | **GET** /v2/datasets/{datasetRid}/branches/{branchName} | +**Datasets** | Branch | [**list**](docs/v2/Datasets/Branch.md#list) | **GET** /v2/datasets/{datasetRid}/branches | +**Datasets** | Branch | [**page**](docs/v2/Datasets/Branch.md#page) | **GET** /v2/datasets/{datasetRid}/branches | +**Datasets** | Dataset | [**create**](docs/v2/Datasets/Dataset.md#create) | **POST** /v2/datasets | +**Datasets** | Dataset | [**get**](docs/v2/Datasets/Dataset.md#get) | **GET** /v2/datasets/{datasetRid} | +**Datasets** | Dataset | [**read_table**](docs/v2/Datasets/Dataset.md#read_table) | **GET** /v2/datasets/{datasetRid}/readTable | +**Datasets** | File | [**content**](docs/v2/Datasets/File.md#content) | **GET** /v2/datasets/{datasetRid}/files/{filePath}/content | +**Datasets** | File | [**delete**](docs/v2/Datasets/File.md#delete) | **DELETE** /v2/datasets/{datasetRid}/files/{filePath} | +**Datasets** | File | [**get**](docs/v2/Datasets/File.md#get) | **GET** /v2/datasets/{datasetRid}/files/{filePath} | +**Datasets** | File | [**list**](docs/v2/Datasets/File.md#list) | **GET** /v2/datasets/{datasetRid}/files | +**Datasets** | File | [**page**](docs/v2/Datasets/File.md#page) | **GET** /v2/datasets/{datasetRid}/files | +**Datasets** | File | [**upload**](docs/v2/Datasets/File.md#upload) | **POST** /v2/datasets/{datasetRid}/files/{filePath}/upload | +**Datasets** | Transaction | [**abort**](docs/v2/Datasets/Transaction.md#abort) | **POST** /v2/datasets/{datasetRid}/transactions/{transactionRid}/abort | +**Datasets** | Transaction | [**commit**](docs/v2/Datasets/Transaction.md#commit) | **POST** /v2/datasets/{datasetRid}/transactions/{transactionRid}/commit | +**Datasets** | Transaction | [**create**](docs/v2/Datasets/Transaction.md#create) | **POST** /v2/datasets/{datasetRid}/transactions | +**Datasets** | Transaction | [**get**](docs/v2/Datasets/Transaction.md#get) | **GET** /v2/datasets/{datasetRid}/transactions/{transactionRid} | +**OntologiesV2** | Action | [**apply**](docs/v2/OntologiesV2/Action.md#apply) | **POST** /v2/ontologies/{ontology}/actions/{action}/apply | +**OntologiesV2** | Action | [**apply_batch**](docs/v2/OntologiesV2/Action.md#apply_batch) | **POST** /v2/ontologies/{ontology}/actions/{action}/applyBatch | +**OntologiesV2** | ActionTypeV2 | [**get**](docs/v2/OntologiesV2/ActionTypeV2.md#get) | **GET** /v2/ontologies/{ontology}/actionTypes/{actionType} | +**OntologiesV2** | ActionTypeV2 | [**list**](docs/v2/OntologiesV2/ActionTypeV2.md#list) | **GET** /v2/ontologies/{ontology}/actionTypes | +**OntologiesV2** | ActionTypeV2 | [**page**](docs/v2/OntologiesV2/ActionTypeV2.md#page) | **GET** /v2/ontologies/{ontology}/actionTypes | +**OntologiesV2** | Attachment | [**read**](docs/v2/OntologiesV2/Attachment.md#read) | **GET** /v2/ontologies/attachments/{attachmentRid}/content | +**OntologiesV2** | Attachment | [**upload**](docs/v2/OntologiesV2/Attachment.md#upload) | **POST** /v2/ontologies/attachments/upload | +**OntologiesV2** | AttachmentPropertyV2 | [**get_attachment**](docs/v2/OntologiesV2/AttachmentPropertyV2.md#get_attachment) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property} | +**OntologiesV2** | AttachmentPropertyV2 | [**get_attachment_by_rid**](docs/v2/OntologiesV2/AttachmentPropertyV2.md#get_attachment_by_rid) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid} | +**OntologiesV2** | AttachmentPropertyV2 | [**read_attachment**](docs/v2/OntologiesV2/AttachmentPropertyV2.md#read_attachment) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content | +**OntologiesV2** | AttachmentPropertyV2 | [**read_attachment_by_rid**](docs/v2/OntologiesV2/AttachmentPropertyV2.md#read_attachment_by_rid) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content | +**OntologiesV2** | LinkedObjectV2 | [**get_linked_object**](docs/v2/OntologiesV2/LinkedObjectV2.md#get_linked_object) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} | +**OntologiesV2** | LinkedObjectV2 | [**list_linked_objects**](docs/v2/OntologiesV2/LinkedObjectV2.md#list_linked_objects) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} | +**OntologiesV2** | LinkedObjectV2 | [**page_linked_objects**](docs/v2/OntologiesV2/LinkedObjectV2.md#page_linked_objects) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} | +**OntologiesV2** | ObjectTypeV2 | [**get**](docs/v2/OntologiesV2/ObjectTypeV2.md#get) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType} | +**OntologiesV2** | ObjectTypeV2 | [**get_outgoing_link_type**](docs/v2/OntologiesV2/ObjectTypeV2.md#get_outgoing_link_type) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} | +**OntologiesV2** | ObjectTypeV2 | [**list**](docs/v2/OntologiesV2/ObjectTypeV2.md#list) | **GET** /v2/ontologies/{ontology}/objectTypes | +**OntologiesV2** | ObjectTypeV2 | [**list_outgoing_link_types**](docs/v2/OntologiesV2/ObjectTypeV2.md#list_outgoing_link_types) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes | +**OntologiesV2** | ObjectTypeV2 | [**page**](docs/v2/OntologiesV2/ObjectTypeV2.md#page) | **GET** /v2/ontologies/{ontology}/objectTypes | +**OntologiesV2** | ObjectTypeV2 | [**page_outgoing_link_types**](docs/v2/OntologiesV2/ObjectTypeV2.md#page_outgoing_link_types) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes | +**OntologiesV2** | OntologyObjectSet | [**aggregate**](docs/v2/OntologiesV2/OntologyObjectSet.md#aggregate) | **POST** /v2/ontologies/{ontology}/objectSets/aggregate | +**OntologiesV2** | OntologyObjectSet | [**load**](docs/v2/OntologiesV2/OntologyObjectSet.md#load) | **POST** /v2/ontologies/{ontology}/objectSets/loadObjects | +**OntologiesV2** | OntologyObjectV2 | [**aggregate**](docs/v2/OntologiesV2/OntologyObjectV2.md#aggregate) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/aggregate | +**OntologiesV2** | OntologyObjectV2 | [**get**](docs/v2/OntologiesV2/OntologyObjectV2.md#get) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey} | +**OntologiesV2** | OntologyObjectV2 | [**list**](docs/v2/OntologiesV2/OntologyObjectV2.md#list) | **GET** /v2/ontologies/{ontology}/objects/{objectType} | +**OntologiesV2** | OntologyObjectV2 | [**page**](docs/v2/OntologiesV2/OntologyObjectV2.md#page) | **GET** /v2/ontologies/{ontology}/objects/{objectType} | +**OntologiesV2** | OntologyObjectV2 | [**search**](docs/v2/OntologiesV2/OntologyObjectV2.md#search) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/search | +**OntologiesV2** | OntologyV2 | [**get**](docs/v2/OntologiesV2/OntologyV2.md#get) | **GET** /v2/ontologies/{ontology} | +**OntologiesV2** | Query | [**execute**](docs/v2/OntologiesV2/Query.md#execute) | **POST** /v2/ontologies/{ontology}/queries/{queryApiName}/execute | +**OntologiesV2** | QueryType | [**get**](docs/v2/OntologiesV2/QueryType.md#get) | **GET** /v2/ontologies/{ontology}/queryTypes/{queryApiName} | +**OntologiesV2** | QueryType | [**list**](docs/v2/OntologiesV2/QueryType.md#list) | **GET** /v2/ontologies/{ontology}/queryTypes | +**OntologiesV2** | QueryType | [**page**](docs/v2/OntologiesV2/QueryType.md#page) | **GET** /v2/ontologies/{ontology}/queryTypes | +**OntologiesV2** | TimeSeriesPropertyV2 | [**get_first_point**](docs/v2/OntologiesV2/TimeSeriesPropertyV2.md#get_first_point) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint | +**OntologiesV2** | TimeSeriesPropertyV2 | [**get_last_point**](docs/v2/OntologiesV2/TimeSeriesPropertyV2.md#get_last_point) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint | +**OntologiesV2** | TimeSeriesPropertyV2 | [**stream_points**](docs/v2/OntologiesV2/TimeSeriesPropertyV2.md#stream_points) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints | +**Orchestration** | Build | [**create**](docs/v2/Orchestration/Build.md#create) | **POST** /v2/orchestration/builds/create | +**Orchestration** | Build | [**get**](docs/v2/Orchestration/Build.md#get) | **GET** /v2/orchestration/builds/{buildRid} | +**Orchestration** | Schedule | [**get**](docs/v2/Orchestration/Schedule.md#get) | **GET** /v2/orchestration/schedules/{scheduleRid} | +**Orchestration** | Schedule | [**pause**](docs/v2/Orchestration/Schedule.md#pause) | **POST** /v2/orchestration/schedules/{scheduleRid}/pause | +**Orchestration** | Schedule | [**run**](docs/v2/Orchestration/Schedule.md#run) | **POST** /v2/orchestration/schedules/{scheduleRid}/run | +**Orchestration** | Schedule | [**unpause**](docs/v2/Orchestration/Schedule.md#unpause) | **POST** /v2/orchestration/schedules/{scheduleRid}/unpause | +**ThirdPartyApplications** | Version | [**delete**](docs/v2/ThirdPartyApplications/Version.md#delete) | **DELETE** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | +**ThirdPartyApplications** | Version | [**get**](docs/v2/ThirdPartyApplications/Version.md#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | +**ThirdPartyApplications** | Version | [**list**](docs/v2/ThirdPartyApplications/Version.md#list) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions | +**ThirdPartyApplications** | Version | [**page**](docs/v2/ThirdPartyApplications/Version.md#page) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions | +**ThirdPartyApplications** | Version | [**upload**](docs/v2/ThirdPartyApplications/Version.md#upload) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/upload | +**ThirdPartyApplications** | Website | [**deploy**](docs/v2/ThirdPartyApplications/Website.md#deploy) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/deploy | +**ThirdPartyApplications** | Website | [**get**](docs/v2/ThirdPartyApplications/Website.md#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website | +**ThirdPartyApplications** | Website | [**undeploy**](docs/v2/ThirdPartyApplications/Website.md#undeploy) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/undeploy | ## Documentation for V1 API endpoints Namespace | Resource | Operation | HTTP request | ------------ | ------------- | ------------- | ------------- | -**Datasets** | Branch | [**create**](docs/v1/namespaces/Datasets/Branch.md#create) | **POST** /v1/datasets/{datasetRid}/branches | -**Datasets** | Branch | [**delete**](docs/v1/namespaces/Datasets/Branch.md#delete) | **DELETE** /v1/datasets/{datasetRid}/branches/{branchId} | -**Datasets** | Branch | [**get**](docs/v1/namespaces/Datasets/Branch.md#get) | **GET** /v1/datasets/{datasetRid}/branches/{branchId} | -**Datasets** | Branch | [**list**](docs/v1/namespaces/Datasets/Branch.md#list) | **GET** /v1/datasets/{datasetRid}/branches | -**Datasets** | Branch | [**page**](docs/v1/namespaces/Datasets/Branch.md#page) | **GET** /v1/datasets/{datasetRid}/branches | -**Datasets** | Dataset | [**create**](docs/v1/namespaces/Datasets/Dataset.md#create) | **POST** /v1/datasets | -**Datasets** | Dataset | [**delete_schema**](docs/v1/namespaces/Datasets/Dataset.md#delete_schema) | **DELETE** /v1/datasets/{datasetRid}/schema | -**Datasets** | Dataset | [**get**](docs/v1/namespaces/Datasets/Dataset.md#get) | **GET** /v1/datasets/{datasetRid} | -**Datasets** | Dataset | [**get_schema**](docs/v1/namespaces/Datasets/Dataset.md#get_schema) | **GET** /v1/datasets/{datasetRid}/schema | -**Datasets** | Dataset | [**read**](docs/v1/namespaces/Datasets/Dataset.md#read) | **GET** /v1/datasets/{datasetRid}/readTable | -**Datasets** | Dataset | [**replace_schema**](docs/v1/namespaces/Datasets/Dataset.md#replace_schema) | **PUT** /v1/datasets/{datasetRid}/schema | -**Datasets** | File | [**delete**](docs/v1/namespaces/Datasets/File.md#delete) | **DELETE** /v1/datasets/{datasetRid}/files/{filePath} | -**Datasets** | File | [**get**](docs/v1/namespaces/Datasets/File.md#get) | **GET** /v1/datasets/{datasetRid}/files/{filePath} | -**Datasets** | File | [**list**](docs/v1/namespaces/Datasets/File.md#list) | **GET** /v1/datasets/{datasetRid}/files | -**Datasets** | File | [**page**](docs/v1/namespaces/Datasets/File.md#page) | **GET** /v1/datasets/{datasetRid}/files | -**Datasets** | File | [**read**](docs/v1/namespaces/Datasets/File.md#read) | **GET** /v1/datasets/{datasetRid}/files/{filePath}/content | -**Datasets** | File | [**upload**](docs/v1/namespaces/Datasets/File.md#upload) | **POST** /v1/datasets/{datasetRid}/files:upload | -**Datasets** | Transaction | [**abort**](docs/v1/namespaces/Datasets/Transaction.md#abort) | **POST** /v1/datasets/{datasetRid}/transactions/{transactionRid}/abort | -**Datasets** | Transaction | [**commit**](docs/v1/namespaces/Datasets/Transaction.md#commit) | **POST** /v1/datasets/{datasetRid}/transactions/{transactionRid}/commit | -**Datasets** | Transaction | [**create**](docs/v1/namespaces/Datasets/Transaction.md#create) | **POST** /v1/datasets/{datasetRid}/transactions | -**Datasets** | Transaction | [**get**](docs/v1/namespaces/Datasets/Transaction.md#get) | **GET** /v1/datasets/{datasetRid}/transactions/{transactionRid} | -**Ontologies** | Action | [**apply**](docs/v1/namespaces/Ontologies/Action.md#apply) | **POST** /v1/ontologies/{ontologyRid}/actions/{actionType}/apply | -**Ontologies** | Action | [**apply_batch**](docs/v1/namespaces/Ontologies/Action.md#apply_batch) | **POST** /v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch | -**Ontologies** | Action | [**validate**](docs/v1/namespaces/Ontologies/Action.md#validate) | **POST** /v1/ontologies/{ontologyRid}/actions/{actionType}/validate | -**Ontologies** | ActionType | [**get**](docs/v1/namespaces/Ontologies/ActionType.md#get) | **GET** /v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName} | -**Ontologies** | ActionType | [**list**](docs/v1/namespaces/Ontologies/ActionType.md#list) | **GET** /v1/ontologies/{ontologyRid}/actionTypes | -**Ontologies** | ActionType | [**page**](docs/v1/namespaces/Ontologies/ActionType.md#page) | **GET** /v1/ontologies/{ontologyRid}/actionTypes | -**Ontologies** | ObjectType | [**get**](docs/v1/namespaces/Ontologies/ObjectType.md#get) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType} | -**Ontologies** | ObjectType | [**get_outgoing_link_type**](docs/v1/namespaces/Ontologies/ObjectType.md#get_outgoing_link_type) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} | -**Ontologies** | ObjectType | [**list**](docs/v1/namespaces/Ontologies/ObjectType.md#list) | **GET** /v1/ontologies/{ontologyRid}/objectTypes | -**Ontologies** | ObjectType | [**list_outgoing_link_types**](docs/v1/namespaces/Ontologies/ObjectType.md#list_outgoing_link_types) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes | -**Ontologies** | ObjectType | [**page**](docs/v1/namespaces/Ontologies/ObjectType.md#page) | **GET** /v1/ontologies/{ontologyRid}/objectTypes | -**Ontologies** | ObjectType | [**page_outgoing_link_types**](docs/v1/namespaces/Ontologies/ObjectType.md#page_outgoing_link_types) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes | -**Ontologies** | Ontology | [**get**](docs/v1/namespaces/Ontologies/Ontology.md#get) | **GET** /v1/ontologies/{ontologyRid} | -**Ontologies** | Ontology | [**list**](docs/v1/namespaces/Ontologies/Ontology.md#list) | **GET** /v1/ontologies | -**Ontologies** | OntologyObject | [**aggregate**](docs/v1/namespaces/Ontologies/OntologyObject.md#aggregate) | **POST** /v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate | -**Ontologies** | OntologyObject | [**get**](docs/v1/namespaces/Ontologies/OntologyObject.md#get) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey} | -**Ontologies** | OntologyObject | [**get_linked_object**](docs/v1/namespaces/Ontologies/OntologyObject.md#get_linked_object) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} | -**Ontologies** | OntologyObject | [**list**](docs/v1/namespaces/Ontologies/OntologyObject.md#list) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType} | -**Ontologies** | OntologyObject | [**list_linked_objects**](docs/v1/namespaces/Ontologies/OntologyObject.md#list_linked_objects) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType} | -**Ontologies** | OntologyObject | [**page**](docs/v1/namespaces/Ontologies/OntologyObject.md#page) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType} | -**Ontologies** | OntologyObject | [**page_linked_objects**](docs/v1/namespaces/Ontologies/OntologyObject.md#page_linked_objects) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType} | -**Ontologies** | OntologyObject | [**search**](docs/v1/namespaces/Ontologies/OntologyObject.md#search) | **POST** /v1/ontologies/{ontologyRid}/objects/{objectType}/search | -**Ontologies** | Query | [**execute**](docs/v1/namespaces/Ontologies/Query.md#execute) | **POST** /v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute | -**Ontologies** | QueryType | [**get**](docs/v1/namespaces/Ontologies/QueryType.md#get) | **GET** /v1/ontologies/{ontologyRid}/queryTypes/{queryApiName} | -**Ontologies** | QueryType | [**list**](docs/v1/namespaces/Ontologies/QueryType.md#list) | **GET** /v1/ontologies/{ontologyRid}/queryTypes | -**Ontologies** | QueryType | [**page**](docs/v1/namespaces/Ontologies/QueryType.md#page) | **GET** /v1/ontologies/{ontologyRid}/queryTypes | +**Datasets** | Branch | [**create**](docs/v1/Datasets/Branch.md#create) | **POST** /v1/datasets/{datasetRid}/branches | +**Datasets** | Branch | [**delete**](docs/v1/Datasets/Branch.md#delete) | **DELETE** /v1/datasets/{datasetRid}/branches/{branchId} | +**Datasets** | Branch | [**get**](docs/v1/Datasets/Branch.md#get) | **GET** /v1/datasets/{datasetRid}/branches/{branchId} | +**Datasets** | Branch | [**list**](docs/v1/Datasets/Branch.md#list) | **GET** /v1/datasets/{datasetRid}/branches | +**Datasets** | Branch | [**page**](docs/v1/Datasets/Branch.md#page) | **GET** /v1/datasets/{datasetRid}/branches | +**Datasets** | Dataset | [**create**](docs/v1/Datasets/Dataset.md#create) | **POST** /v1/datasets | +**Datasets** | Dataset | [**get**](docs/v1/Datasets/Dataset.md#get) | **GET** /v1/datasets/{datasetRid} | +**Datasets** | Dataset | [**read**](docs/v1/Datasets/Dataset.md#read) | **GET** /v1/datasets/{datasetRid}/readTable | +**Datasets** | File | [**delete**](docs/v1/Datasets/File.md#delete) | **DELETE** /v1/datasets/{datasetRid}/files/{filePath} | +**Datasets** | File | [**get**](docs/v1/Datasets/File.md#get) | **GET** /v1/datasets/{datasetRid}/files/{filePath} | +**Datasets** | File | [**list**](docs/v1/Datasets/File.md#list) | **GET** /v1/datasets/{datasetRid}/files | +**Datasets** | File | [**page**](docs/v1/Datasets/File.md#page) | **GET** /v1/datasets/{datasetRid}/files | +**Datasets** | File | [**read**](docs/v1/Datasets/File.md#read) | **GET** /v1/datasets/{datasetRid}/files/{filePath}/content | +**Datasets** | File | [**upload**](docs/v1/Datasets/File.md#upload) | **POST** /v1/datasets/{datasetRid}/files:upload | +**Datasets** | Transaction | [**abort**](docs/v1/Datasets/Transaction.md#abort) | **POST** /v1/datasets/{datasetRid}/transactions/{transactionRid}/abort | +**Datasets** | Transaction | [**commit**](docs/v1/Datasets/Transaction.md#commit) | **POST** /v1/datasets/{datasetRid}/transactions/{transactionRid}/commit | +**Datasets** | Transaction | [**create**](docs/v1/Datasets/Transaction.md#create) | **POST** /v1/datasets/{datasetRid}/transactions | +**Datasets** | Transaction | [**get**](docs/v1/Datasets/Transaction.md#get) | **GET** /v1/datasets/{datasetRid}/transactions/{transactionRid} | +**Ontologies** | Action | [**apply**](docs/v1/Ontologies/Action.md#apply) | **POST** /v1/ontologies/{ontologyRid}/actions/{actionType}/apply | +**Ontologies** | Action | [**apply_batch**](docs/v1/Ontologies/Action.md#apply_batch) | **POST** /v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch | +**Ontologies** | Action | [**validate**](docs/v1/Ontologies/Action.md#validate) | **POST** /v1/ontologies/{ontologyRid}/actions/{actionType}/validate | +**Ontologies** | ActionType | [**get**](docs/v1/Ontologies/ActionType.md#get) | **GET** /v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName} | +**Ontologies** | ActionType | [**list**](docs/v1/Ontologies/ActionType.md#list) | **GET** /v1/ontologies/{ontologyRid}/actionTypes | +**Ontologies** | ActionType | [**page**](docs/v1/Ontologies/ActionType.md#page) | **GET** /v1/ontologies/{ontologyRid}/actionTypes | +**Ontologies** | ObjectType | [**get**](docs/v1/Ontologies/ObjectType.md#get) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType} | +**Ontologies** | ObjectType | [**get_outgoing_link_type**](docs/v1/Ontologies/ObjectType.md#get_outgoing_link_type) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} | +**Ontologies** | ObjectType | [**list**](docs/v1/Ontologies/ObjectType.md#list) | **GET** /v1/ontologies/{ontologyRid}/objectTypes | +**Ontologies** | ObjectType | [**list_outgoing_link_types**](docs/v1/Ontologies/ObjectType.md#list_outgoing_link_types) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes | +**Ontologies** | ObjectType | [**page**](docs/v1/Ontologies/ObjectType.md#page) | **GET** /v1/ontologies/{ontologyRid}/objectTypes | +**Ontologies** | ObjectType | [**page_outgoing_link_types**](docs/v1/Ontologies/ObjectType.md#page_outgoing_link_types) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes | +**Ontologies** | Ontology | [**get**](docs/v1/Ontologies/Ontology.md#get) | **GET** /v1/ontologies/{ontologyRid} | +**Ontologies** | Ontology | [**list**](docs/v1/Ontologies/Ontology.md#list) | **GET** /v1/ontologies | +**Ontologies** | OntologyObject | [**aggregate**](docs/v1/Ontologies/OntologyObject.md#aggregate) | **POST** /v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate | +**Ontologies** | OntologyObject | [**get**](docs/v1/Ontologies/OntologyObject.md#get) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey} | +**Ontologies** | OntologyObject | [**get_linked_object**](docs/v1/Ontologies/OntologyObject.md#get_linked_object) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} | +**Ontologies** | OntologyObject | [**list**](docs/v1/Ontologies/OntologyObject.md#list) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType} | +**Ontologies** | OntologyObject | [**list_linked_objects**](docs/v1/Ontologies/OntologyObject.md#list_linked_objects) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType} | +**Ontologies** | OntologyObject | [**page**](docs/v1/Ontologies/OntologyObject.md#page) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType} | +**Ontologies** | OntologyObject | [**page_linked_objects**](docs/v1/Ontologies/OntologyObject.md#page_linked_objects) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType} | +**Ontologies** | OntologyObject | [**search**](docs/v1/Ontologies/OntologyObject.md#search) | **POST** /v1/ontologies/{ontologyRid}/objects/{objectType}/search | +**Ontologies** | Query | [**execute**](docs/v1/Ontologies/Query.md#execute) | **POST** /v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute | +**Ontologies** | QueryType | [**get**](docs/v1/Ontologies/QueryType.md#get) | **GET** /v1/ontologies/{ontologyRid}/queryTypes/{queryApiName} | +**Ontologies** | QueryType | [**list**](docs/v1/Ontologies/QueryType.md#list) | **GET** /v1/ontologies/{ontologyRid}/queryTypes | +**Ontologies** | QueryType | [**page**](docs/v1/Ontologies/QueryType.md#page) | **GET** /v1/ontologies/{ontologyRid}/queryTypes | ## Documentation for V2 models -- [AbortOnFailure](docs/v2/models/AbortOnFailure.md) -- [AbsoluteTimeRange](docs/v2/models/AbsoluteTimeRange.md) +- [AttributeName](docs/v2/models/AttributeName.md) +- [AttributeValue](docs/v2/models/AttributeValue.md) +- [AttributeValues](docs/v2/models/AttributeValues.md) +- [GetGroupsBatchRequestElementDict](docs/v2/models/GetGroupsBatchRequestElementDict.md) +- [GetGroupsBatchResponse](docs/v2/models/GetGroupsBatchResponse.md) +- [GetGroupsBatchResponseDict](docs/v2/models/GetGroupsBatchResponseDict.md) +- [GetUserMarkingsResponse](docs/v2/models/GetUserMarkingsResponse.md) +- [GetUserMarkingsResponseDict](docs/v2/models/GetUserMarkingsResponseDict.md) +- [GetUsersBatchRequestElementDict](docs/v2/models/GetUsersBatchRequestElementDict.md) +- [GetUsersBatchResponse](docs/v2/models/GetUsersBatchResponse.md) +- [GetUsersBatchResponseDict](docs/v2/models/GetUsersBatchResponseDict.md) +- [Group](docs/v2/models/Group.md) +- [GroupDict](docs/v2/models/GroupDict.md) +- [GroupMember](docs/v2/models/GroupMember.md) +- [GroupMemberDict](docs/v2/models/GroupMemberDict.md) +- [GroupMembership](docs/v2/models/GroupMembership.md) +- [GroupMembershipDict](docs/v2/models/GroupMembershipDict.md) +- [GroupMembershipExpiration](docs/v2/models/GroupMembershipExpiration.md) +- [GroupName](docs/v2/models/GroupName.md) +- [GroupSearchFilterDict](docs/v2/models/GroupSearchFilterDict.md) +- [ListGroupMembershipsResponse](docs/v2/models/ListGroupMembershipsResponse.md) +- [ListGroupMembershipsResponseDict](docs/v2/models/ListGroupMembershipsResponseDict.md) +- [ListGroupMembersResponse](docs/v2/models/ListGroupMembersResponse.md) +- [ListGroupMembersResponseDict](docs/v2/models/ListGroupMembersResponseDict.md) +- [ListGroupsResponse](docs/v2/models/ListGroupsResponse.md) +- [ListGroupsResponseDict](docs/v2/models/ListGroupsResponseDict.md) +- [ListMarkingCategoriesResponse](docs/v2/models/ListMarkingCategoriesResponse.md) +- [ListMarkingCategoriesResponseDict](docs/v2/models/ListMarkingCategoriesResponseDict.md) +- [ListMarkingsResponse](docs/v2/models/ListMarkingsResponse.md) +- [ListMarkingsResponseDict](docs/v2/models/ListMarkingsResponseDict.md) +- [ListUsersResponse](docs/v2/models/ListUsersResponse.md) +- [ListUsersResponseDict](docs/v2/models/ListUsersResponseDict.md) +- [Marking](docs/v2/models/Marking.md) +- [MarkingCategory](docs/v2/models/MarkingCategory.md) +- [MarkingCategoryDict](docs/v2/models/MarkingCategoryDict.md) +- [MarkingCategoryDisplayName](docs/v2/models/MarkingCategoryDisplayName.md) +- [MarkingCategoryId](docs/v2/models/MarkingCategoryId.md) +- [MarkingCategoryType](docs/v2/models/MarkingCategoryType.md) +- [MarkingDict](docs/v2/models/MarkingDict.md) +- [MarkingDisplayName](docs/v2/models/MarkingDisplayName.md) +- [MarkingType](docs/v2/models/MarkingType.md) +- [PrincipalFilterType](docs/v2/models/PrincipalFilterType.md) +- [SearchGroupsResponse](docs/v2/models/SearchGroupsResponse.md) +- [SearchGroupsResponseDict](docs/v2/models/SearchGroupsResponseDict.md) +- [SearchUsersResponse](docs/v2/models/SearchUsersResponse.md) +- [SearchUsersResponseDict](docs/v2/models/SearchUsersResponseDict.md) +- [User](docs/v2/models/User.md) +- [UserDict](docs/v2/models/UserDict.md) +- [UserSearchFilterDict](docs/v2/models/UserSearchFilterDict.md) +- [UserUsername](docs/v2/models/UserUsername.md) +- [AttachmentType](docs/v2/models/AttachmentType.md) +- [AttachmentTypeDict](docs/v2/models/AttachmentTypeDict.md) +- [BooleanType](docs/v2/models/BooleanType.md) +- [BooleanTypeDict](docs/v2/models/BooleanTypeDict.md) +- [ByteType](docs/v2/models/ByteType.md) +- [ByteTypeDict](docs/v2/models/ByteTypeDict.md) +- [ContentLength](docs/v2/models/ContentLength.md) +- [ContentType](docs/v2/models/ContentType.md) +- [CreatedBy](docs/v2/models/CreatedBy.md) +- [CreatedTime](docs/v2/models/CreatedTime.md) +- [DateType](docs/v2/models/DateType.md) +- [DateTypeDict](docs/v2/models/DateTypeDict.md) +- [DecimalType](docs/v2/models/DecimalType.md) +- [DecimalTypeDict](docs/v2/models/DecimalTypeDict.md) +- [DisplayName](docs/v2/models/DisplayName.md) +- [Distance](docs/v2/models/Distance.md) +- [DistanceDict](docs/v2/models/DistanceDict.md) +- [DistanceUnit](docs/v2/models/DistanceUnit.md) +- [DoubleType](docs/v2/models/DoubleType.md) +- [DoubleTypeDict](docs/v2/models/DoubleTypeDict.md) +- [Duration](docs/v2/models/Duration.md) +- [DurationDict](docs/v2/models/DurationDict.md) +- [Filename](docs/v2/models/Filename.md) +- [FilePath](docs/v2/models/FilePath.md) +- [FloatType](docs/v2/models/FloatType.md) +- [FloatTypeDict](docs/v2/models/FloatTypeDict.md) +- [GeoPointType](docs/v2/models/GeoPointType.md) +- [GeoPointTypeDict](docs/v2/models/GeoPointTypeDict.md) +- [GeoShapeType](docs/v2/models/GeoShapeType.md) +- [GeoShapeTypeDict](docs/v2/models/GeoShapeTypeDict.md) +- [IntegerType](docs/v2/models/IntegerType.md) +- [IntegerTypeDict](docs/v2/models/IntegerTypeDict.md) +- [LongType](docs/v2/models/LongType.md) +- [LongTypeDict](docs/v2/models/LongTypeDict.md) +- [MarkingId](docs/v2/models/MarkingId.md) +- [MarkingType](docs/v2/models/MarkingType.md) +- [MarkingTypeDict](docs/v2/models/MarkingTypeDict.md) +- [MediaSetRid](docs/v2/models/MediaSetRid.md) +- [MediaType](docs/v2/models/MediaType.md) +- [NullType](docs/v2/models/NullType.md) +- [NullTypeDict](docs/v2/models/NullTypeDict.md) +- [OrganizationRid](docs/v2/models/OrganizationRid.md) +- [PageSize](docs/v2/models/PageSize.md) +- [PageToken](docs/v2/models/PageToken.md) +- [PreviewMode](docs/v2/models/PreviewMode.md) +- [PrincipalId](docs/v2/models/PrincipalId.md) +- [PrincipalType](docs/v2/models/PrincipalType.md) +- [Realm](docs/v2/models/Realm.md) +- [ReleaseStatus](docs/v2/models/ReleaseStatus.md) +- [ShortType](docs/v2/models/ShortType.md) +- [ShortTypeDict](docs/v2/models/ShortTypeDict.md) +- [SizeBytes](docs/v2/models/SizeBytes.md) +- [StringType](docs/v2/models/StringType.md) +- [StringTypeDict](docs/v2/models/StringTypeDict.md) +- [StructFieldName](docs/v2/models/StructFieldName.md) +- [TimeSeriesItemType](docs/v2/models/TimeSeriesItemType.md) +- [TimeSeriesItemTypeDict](docs/v2/models/TimeSeriesItemTypeDict.md) +- [TimeseriesType](docs/v2/models/TimeseriesType.md) +- [TimeseriesTypeDict](docs/v2/models/TimeseriesTypeDict.md) +- [TimestampType](docs/v2/models/TimestampType.md) +- [TimestampTypeDict](docs/v2/models/TimestampTypeDict.md) +- [TimeUnit](docs/v2/models/TimeUnit.md) +- [TotalCount](docs/v2/models/TotalCount.md) +- [UnsupportedType](docs/v2/models/UnsupportedType.md) +- [UnsupportedTypeDict](docs/v2/models/UnsupportedTypeDict.md) +- [UpdatedBy](docs/v2/models/UpdatedBy.md) +- [UpdatedTime](docs/v2/models/UpdatedTime.md) +- [UserId](docs/v2/models/UserId.md) +- [Branch](docs/v2/models/Branch.md) +- [BranchDict](docs/v2/models/BranchDict.md) +- [BranchName](docs/v2/models/BranchName.md) +- [Dataset](docs/v2/models/Dataset.md) +- [DatasetDict](docs/v2/models/DatasetDict.md) +- [DatasetName](docs/v2/models/DatasetName.md) +- [DatasetRid](docs/v2/models/DatasetRid.md) +- [File](docs/v2/models/File.md) +- [FileDict](docs/v2/models/FileDict.md) +- [FileUpdatedTime](docs/v2/models/FileUpdatedTime.md) +- [ListBranchesResponse](docs/v2/models/ListBranchesResponse.md) +- [ListBranchesResponseDict](docs/v2/models/ListBranchesResponseDict.md) +- [ListFilesResponse](docs/v2/models/ListFilesResponse.md) +- [ListFilesResponseDict](docs/v2/models/ListFilesResponseDict.md) +- [TableExportFormat](docs/v2/models/TableExportFormat.md) +- [Transaction](docs/v2/models/Transaction.md) +- [TransactionCreatedTime](docs/v2/models/TransactionCreatedTime.md) +- [TransactionDict](docs/v2/models/TransactionDict.md) +- [TransactionRid](docs/v2/models/TransactionRid.md) +- [TransactionStatus](docs/v2/models/TransactionStatus.md) +- [TransactionType](docs/v2/models/TransactionType.md) +- [FolderRid](docs/v2/models/FolderRid.md) +- [ProjectRid](docs/v2/models/ProjectRid.md) +- [BBox](docs/v2/models/BBox.md) +- [Coordinate](docs/v2/models/Coordinate.md) +- [GeoPoint](docs/v2/models/GeoPoint.md) +- [GeoPointDict](docs/v2/models/GeoPointDict.md) +- [LinearRing](docs/v2/models/LinearRing.md) +- [Polygon](docs/v2/models/Polygon.md) +- [PolygonDict](docs/v2/models/PolygonDict.md) +- [Position](docs/v2/models/Position.md) - [AbsoluteTimeRangeDict](docs/v2/models/AbsoluteTimeRangeDict.md) -- [Action](docs/v2/models/Action.md) -- [ActionDict](docs/v2/models/ActionDict.md) -- [ActionMode](docs/v2/models/ActionMode.md) - [ActionParameterArrayType](docs/v2/models/ActionParameterArrayType.md) - [ActionParameterArrayTypeDict](docs/v2/models/ActionParameterArrayTypeDict.md) - [ActionParameterType](docs/v2/models/ActionParameterType.md) @@ -475,182 +610,59 @@ Namespace | Resource | Operation | HTTP request | - [ActionParameterV2Dict](docs/v2/models/ActionParameterV2Dict.md) - [ActionResults](docs/v2/models/ActionResults.md) - [ActionResultsDict](docs/v2/models/ActionResultsDict.md) -- [ActionRid](docs/v2/models/ActionRid.md) -- [ActionType](docs/v2/models/ActionType.md) - [ActionTypeApiName](docs/v2/models/ActionTypeApiName.md) -- [ActionTypeDict](docs/v2/models/ActionTypeDict.md) - [ActionTypeRid](docs/v2/models/ActionTypeRid.md) - [ActionTypeV2](docs/v2/models/ActionTypeV2.md) - [ActionTypeV2Dict](docs/v2/models/ActionTypeV2Dict.md) -- [AddGroupMembersRequest](docs/v2/models/AddGroupMembersRequest.md) -- [AddGroupMembersRequestDict](docs/v2/models/AddGroupMembersRequestDict.md) - [AddLink](docs/v2/models/AddLink.md) - [AddLinkDict](docs/v2/models/AddLinkDict.md) - [AddObject](docs/v2/models/AddObject.md) - [AddObjectDict](docs/v2/models/AddObjectDict.md) -- [AggregateObjectSetRequestV2](docs/v2/models/AggregateObjectSetRequestV2.md) -- [AggregateObjectSetRequestV2Dict](docs/v2/models/AggregateObjectSetRequestV2Dict.md) -- [AggregateObjectsRequest](docs/v2/models/AggregateObjectsRequest.md) -- [AggregateObjectsRequestDict](docs/v2/models/AggregateObjectsRequestDict.md) -- [AggregateObjectsRequestV2](docs/v2/models/AggregateObjectsRequestV2.md) -- [AggregateObjectsRequestV2Dict](docs/v2/models/AggregateObjectsRequestV2Dict.md) -- [AggregateObjectsResponse](docs/v2/models/AggregateObjectsResponse.md) -- [AggregateObjectsResponseDict](docs/v2/models/AggregateObjectsResponseDict.md) -- [AggregateObjectsResponseItem](docs/v2/models/AggregateObjectsResponseItem.md) -- [AggregateObjectsResponseItemDict](docs/v2/models/AggregateObjectsResponseItemDict.md) - [AggregateObjectsResponseItemV2](docs/v2/models/AggregateObjectsResponseItemV2.md) - [AggregateObjectsResponseItemV2Dict](docs/v2/models/AggregateObjectsResponseItemV2Dict.md) - [AggregateObjectsResponseV2](docs/v2/models/AggregateObjectsResponseV2.md) - [AggregateObjectsResponseV2Dict](docs/v2/models/AggregateObjectsResponseV2Dict.md) -- [Aggregation](docs/v2/models/Aggregation.md) - [AggregationAccuracy](docs/v2/models/AggregationAccuracy.md) - [AggregationAccuracyRequest](docs/v2/models/AggregationAccuracyRequest.md) -- [AggregationDict](docs/v2/models/AggregationDict.md) -- [AggregationDurationGrouping](docs/v2/models/AggregationDurationGrouping.md) -- [AggregationDurationGroupingDict](docs/v2/models/AggregationDurationGroupingDict.md) -- [AggregationDurationGroupingV2](docs/v2/models/AggregationDurationGroupingV2.md) - [AggregationDurationGroupingV2Dict](docs/v2/models/AggregationDurationGroupingV2Dict.md) -- [AggregationExactGrouping](docs/v2/models/AggregationExactGrouping.md) -- [AggregationExactGroupingDict](docs/v2/models/AggregationExactGroupingDict.md) -- [AggregationExactGroupingV2](docs/v2/models/AggregationExactGroupingV2.md) - [AggregationExactGroupingV2Dict](docs/v2/models/AggregationExactGroupingV2Dict.md) -- [AggregationFixedWidthGrouping](docs/v2/models/AggregationFixedWidthGrouping.md) -- [AggregationFixedWidthGroupingDict](docs/v2/models/AggregationFixedWidthGroupingDict.md) -- [AggregationFixedWidthGroupingV2](docs/v2/models/AggregationFixedWidthGroupingV2.md) - [AggregationFixedWidthGroupingV2Dict](docs/v2/models/AggregationFixedWidthGroupingV2Dict.md) -- [AggregationGroupBy](docs/v2/models/AggregationGroupBy.md) -- [AggregationGroupByDict](docs/v2/models/AggregationGroupByDict.md) -- [AggregationGroupByV2](docs/v2/models/AggregationGroupByV2.md) - [AggregationGroupByV2Dict](docs/v2/models/AggregationGroupByV2Dict.md) -- [AggregationGroupKey](docs/v2/models/AggregationGroupKey.md) - [AggregationGroupKeyV2](docs/v2/models/AggregationGroupKeyV2.md) -- [AggregationGroupValue](docs/v2/models/AggregationGroupValue.md) - [AggregationGroupValueV2](docs/v2/models/AggregationGroupValueV2.md) - [AggregationMetricName](docs/v2/models/AggregationMetricName.md) -- [AggregationMetricResult](docs/v2/models/AggregationMetricResult.md) -- [AggregationMetricResultDict](docs/v2/models/AggregationMetricResultDict.md) - [AggregationMetricResultV2](docs/v2/models/AggregationMetricResultV2.md) - [AggregationMetricResultV2Dict](docs/v2/models/AggregationMetricResultV2Dict.md) -- [AggregationObjectTypeGrouping](docs/v2/models/AggregationObjectTypeGrouping.md) -- [AggregationObjectTypeGroupingDict](docs/v2/models/AggregationObjectTypeGroupingDict.md) -- [AggregationOrderBy](docs/v2/models/AggregationOrderBy.md) -- [AggregationOrderByDict](docs/v2/models/AggregationOrderByDict.md) -- [AggregationRange](docs/v2/models/AggregationRange.md) -- [AggregationRangeDict](docs/v2/models/AggregationRangeDict.md) -- [AggregationRangesGrouping](docs/v2/models/AggregationRangesGrouping.md) -- [AggregationRangesGroupingDict](docs/v2/models/AggregationRangesGroupingDict.md) -- [AggregationRangesGroupingV2](docs/v2/models/AggregationRangesGroupingV2.md) - [AggregationRangesGroupingV2Dict](docs/v2/models/AggregationRangesGroupingV2Dict.md) -- [AggregationRangeV2](docs/v2/models/AggregationRangeV2.md) - [AggregationRangeV2Dict](docs/v2/models/AggregationRangeV2Dict.md) -- [AggregationV2](docs/v2/models/AggregationV2.md) - [AggregationV2Dict](docs/v2/models/AggregationV2Dict.md) -- [AllTermsQuery](docs/v2/models/AllTermsQuery.md) -- [AllTermsQueryDict](docs/v2/models/AllTermsQueryDict.md) -- [AndQuery](docs/v2/models/AndQuery.md) -- [AndQueryDict](docs/v2/models/AndQueryDict.md) - [AndQueryV2](docs/v2/models/AndQueryV2.md) - [AndQueryV2Dict](docs/v2/models/AndQueryV2Dict.md) -- [AndTrigger](docs/v2/models/AndTrigger.md) -- [AndTriggerDict](docs/v2/models/AndTriggerDict.md) -- [AnyTermQuery](docs/v2/models/AnyTermQuery.md) -- [AnyTermQueryDict](docs/v2/models/AnyTermQueryDict.md) -- [AnyType](docs/v2/models/AnyType.md) -- [AnyTypeDict](docs/v2/models/AnyTypeDict.md) -- [ApiDefinition](docs/v2/models/ApiDefinition.md) -- [ApiDefinitionDeprecated](docs/v2/models/ApiDefinitionDeprecated.md) -- [ApiDefinitionDict](docs/v2/models/ApiDefinitionDict.md) -- [ApiDefinitionName](docs/v2/models/ApiDefinitionName.md) -- [ApiDefinitionRid](docs/v2/models/ApiDefinitionRid.md) - [ApplyActionMode](docs/v2/models/ApplyActionMode.md) -- [ApplyActionRequest](docs/v2/models/ApplyActionRequest.md) -- [ApplyActionRequestDict](docs/v2/models/ApplyActionRequestDict.md) -- [ApplyActionRequestOptions](docs/v2/models/ApplyActionRequestOptions.md) - [ApplyActionRequestOptionsDict](docs/v2/models/ApplyActionRequestOptionsDict.md) -- [ApplyActionRequestV2](docs/v2/models/ApplyActionRequestV2.md) -- [ApplyActionRequestV2Dict](docs/v2/models/ApplyActionRequestV2Dict.md) -- [ApplyActionResponse](docs/v2/models/ApplyActionResponse.md) -- [ApplyActionResponseDict](docs/v2/models/ApplyActionResponseDict.md) -- [ApproximateDistinctAggregation](docs/v2/models/ApproximateDistinctAggregation.md) -- [ApproximateDistinctAggregationDict](docs/v2/models/ApproximateDistinctAggregationDict.md) -- [ApproximateDistinctAggregationV2](docs/v2/models/ApproximateDistinctAggregationV2.md) - [ApproximateDistinctAggregationV2Dict](docs/v2/models/ApproximateDistinctAggregationV2Dict.md) -- [ApproximatePercentileAggregationV2](docs/v2/models/ApproximatePercentileAggregationV2.md) - [ApproximatePercentileAggregationV2Dict](docs/v2/models/ApproximatePercentileAggregationV2Dict.md) -- [ArchiveFileFormat](docs/v2/models/ArchiveFileFormat.md) -- [Arg](docs/v2/models/Arg.md) -- [ArgDict](docs/v2/models/ArgDict.md) - [ArraySizeConstraint](docs/v2/models/ArraySizeConstraint.md) - [ArraySizeConstraintDict](docs/v2/models/ArraySizeConstraintDict.md) - [ArtifactRepositoryRid](docs/v2/models/ArtifactRepositoryRid.md) -- [AsyncActionStatus](docs/v2/models/AsyncActionStatus.md) -- [AsyncApplyActionOperationResponseV2](docs/v2/models/AsyncApplyActionOperationResponseV2.md) -- [AsyncApplyActionOperationResponseV2Dict](docs/v2/models/AsyncApplyActionOperationResponseV2Dict.md) -- [AsyncApplyActionRequest](docs/v2/models/AsyncApplyActionRequest.md) -- [AsyncApplyActionRequestDict](docs/v2/models/AsyncApplyActionRequestDict.md) -- [AsyncApplyActionRequestV2](docs/v2/models/AsyncApplyActionRequestV2.md) -- [AsyncApplyActionRequestV2Dict](docs/v2/models/AsyncApplyActionRequestV2Dict.md) -- [AsyncApplyActionResponse](docs/v2/models/AsyncApplyActionResponse.md) -- [AsyncApplyActionResponseDict](docs/v2/models/AsyncApplyActionResponseDict.md) -- [AsyncApplyActionResponseV2](docs/v2/models/AsyncApplyActionResponseV2.md) -- [AsyncApplyActionResponseV2Dict](docs/v2/models/AsyncApplyActionResponseV2Dict.md) -- [Attachment](docs/v2/models/Attachment.md) -- [AttachmentDict](docs/v2/models/AttachmentDict.md) - [AttachmentMetadataResponse](docs/v2/models/AttachmentMetadataResponse.md) - [AttachmentMetadataResponseDict](docs/v2/models/AttachmentMetadataResponseDict.md) -- [AttachmentProperty](docs/v2/models/AttachmentProperty.md) -- [AttachmentPropertyDict](docs/v2/models/AttachmentPropertyDict.md) - [AttachmentRid](docs/v2/models/AttachmentRid.md) -- [AttachmentType](docs/v2/models/AttachmentType.md) -- [AttachmentTypeDict](docs/v2/models/AttachmentTypeDict.md) - [AttachmentV2](docs/v2/models/AttachmentV2.md) - [AttachmentV2Dict](docs/v2/models/AttachmentV2Dict.md) -- [AttributeName](docs/v2/models/AttributeName.md) -- [AttributeValue](docs/v2/models/AttributeValue.md) -- [AttributeValues](docs/v2/models/AttributeValues.md) -- [AvgAggregation](docs/v2/models/AvgAggregation.md) -- [AvgAggregationDict](docs/v2/models/AvgAggregationDict.md) -- [AvgAggregationV2](docs/v2/models/AvgAggregationV2.md) - [AvgAggregationV2Dict](docs/v2/models/AvgAggregationV2Dict.md) -- [BatchApplyActionRequest](docs/v2/models/BatchApplyActionRequest.md) -- [BatchApplyActionRequestDict](docs/v2/models/BatchApplyActionRequestDict.md) -- [BatchApplyActionRequestItem](docs/v2/models/BatchApplyActionRequestItem.md) - [BatchApplyActionRequestItemDict](docs/v2/models/BatchApplyActionRequestItemDict.md) -- [BatchApplyActionRequestOptions](docs/v2/models/BatchApplyActionRequestOptions.md) - [BatchApplyActionRequestOptionsDict](docs/v2/models/BatchApplyActionRequestOptionsDict.md) -- [BatchApplyActionRequestV2](docs/v2/models/BatchApplyActionRequestV2.md) -- [BatchApplyActionRequestV2Dict](docs/v2/models/BatchApplyActionRequestV2Dict.md) -- [BatchApplyActionResponse](docs/v2/models/BatchApplyActionResponse.md) -- [BatchApplyActionResponseDict](docs/v2/models/BatchApplyActionResponseDict.md) - [BatchApplyActionResponseV2](docs/v2/models/BatchApplyActionResponseV2.md) - [BatchApplyActionResponseV2Dict](docs/v2/models/BatchApplyActionResponseV2Dict.md) -- [BBox](docs/v2/models/BBox.md) -- [BinaryType](docs/v2/models/BinaryType.md) -- [BinaryTypeDict](docs/v2/models/BinaryTypeDict.md) - [BlueprintIcon](docs/v2/models/BlueprintIcon.md) - [BlueprintIconDict](docs/v2/models/BlueprintIconDict.md) -- [BooleanType](docs/v2/models/BooleanType.md) -- [BooleanTypeDict](docs/v2/models/BooleanTypeDict.md) - [BoundingBoxValue](docs/v2/models/BoundingBoxValue.md) - [BoundingBoxValueDict](docs/v2/models/BoundingBoxValueDict.md) -- [Branch](docs/v2/models/Branch.md) -- [BranchDict](docs/v2/models/BranchDict.md) -- [BranchId](docs/v2/models/BranchId.md) -- [BranchName](docs/v2/models/BranchName.md) -- [Build](docs/v2/models/Build.md) -- [BuildDict](docs/v2/models/BuildDict.md) -- [BuildRid](docs/v2/models/BuildRid.md) -- [BuildStatus](docs/v2/models/BuildStatus.md) -- [BuildTarget](docs/v2/models/BuildTarget.md) -- [BuildTargetDict](docs/v2/models/BuildTargetDict.md) -- [ByteType](docs/v2/models/ByteType.md) -- [ByteTypeDict](docs/v2/models/ByteTypeDict.md) - [CenterPoint](docs/v2/models/CenterPoint.md) - [CenterPointDict](docs/v2/models/CenterPointDict.md) - [CenterPointTypes](docs/v2/models/CenterPointTypes.md) - [CenterPointTypesDict](docs/v2/models/CenterPointTypesDict.md) -- [ConnectingTarget](docs/v2/models/ConnectingTarget.md) -- [ConnectingTargetDict](docs/v2/models/ConnectingTargetDict.md) - [ContainsAllTermsInOrderPrefixLastTerm](docs/v2/models/ContainsAllTermsInOrderPrefixLastTerm.md) - [ContainsAllTermsInOrderPrefixLastTermDict](docs/v2/models/ContainsAllTermsInOrderPrefixLastTermDict.md) - [ContainsAllTermsInOrderQuery](docs/v2/models/ContainsAllTermsInOrderQuery.md) @@ -659,156 +671,44 @@ Namespace | Resource | Operation | HTTP request | - [ContainsAllTermsQueryDict](docs/v2/models/ContainsAllTermsQueryDict.md) - [ContainsAnyTermQuery](docs/v2/models/ContainsAnyTermQuery.md) - [ContainsAnyTermQueryDict](docs/v2/models/ContainsAnyTermQueryDict.md) -- [ContainsQuery](docs/v2/models/ContainsQuery.md) -- [ContainsQueryDict](docs/v2/models/ContainsQueryDict.md) - [ContainsQueryV2](docs/v2/models/ContainsQueryV2.md) - [ContainsQueryV2Dict](docs/v2/models/ContainsQueryV2Dict.md) -- [ContentLength](docs/v2/models/ContentLength.md) -- [ContentType](docs/v2/models/ContentType.md) -- [Coordinate](docs/v2/models/Coordinate.md) -- [CountAggregation](docs/v2/models/CountAggregation.md) -- [CountAggregationDict](docs/v2/models/CountAggregationDict.md) -- [CountAggregationV2](docs/v2/models/CountAggregationV2.md) - [CountAggregationV2Dict](docs/v2/models/CountAggregationV2Dict.md) - [CountObjectsResponseV2](docs/v2/models/CountObjectsResponseV2.md) - [CountObjectsResponseV2Dict](docs/v2/models/CountObjectsResponseV2Dict.md) -- [CreateBranchRequest](docs/v2/models/CreateBranchRequest.md) -- [CreateBranchRequestDict](docs/v2/models/CreateBranchRequestDict.md) -- [CreateBuildsRequest](docs/v2/models/CreateBuildsRequest.md) -- [CreateBuildsRequestDict](docs/v2/models/CreateBuildsRequestDict.md) -- [CreateDatasetRequest](docs/v2/models/CreateDatasetRequest.md) -- [CreateDatasetRequestDict](docs/v2/models/CreateDatasetRequestDict.md) -- [CreatedBy](docs/v2/models/CreatedBy.md) -- [CreatedTime](docs/v2/models/CreatedTime.md) -- [CreateGroupRequest](docs/v2/models/CreateGroupRequest.md) -- [CreateGroupRequestDict](docs/v2/models/CreateGroupRequestDict.md) +- [CreateInterfaceObjectRule](docs/v2/models/CreateInterfaceObjectRule.md) +- [CreateInterfaceObjectRuleDict](docs/v2/models/CreateInterfaceObjectRuleDict.md) - [CreateLinkRule](docs/v2/models/CreateLinkRule.md) - [CreateLinkRuleDict](docs/v2/models/CreateLinkRuleDict.md) - [CreateObjectRule](docs/v2/models/CreateObjectRule.md) - [CreateObjectRuleDict](docs/v2/models/CreateObjectRuleDict.md) -- [CreateTemporaryObjectSetRequestV2](docs/v2/models/CreateTemporaryObjectSetRequestV2.md) -- [CreateTemporaryObjectSetRequestV2Dict](docs/v2/models/CreateTemporaryObjectSetRequestV2Dict.md) - [CreateTemporaryObjectSetResponseV2](docs/v2/models/CreateTemporaryObjectSetResponseV2.md) - [CreateTemporaryObjectSetResponseV2Dict](docs/v2/models/CreateTemporaryObjectSetResponseV2Dict.md) -- [CreateTransactionRequest](docs/v2/models/CreateTransactionRequest.md) -- [CreateTransactionRequestDict](docs/v2/models/CreateTransactionRequestDict.md) -- [CronExpression](docs/v2/models/CronExpression.md) -- [CustomTypeId](docs/v2/models/CustomTypeId.md) -- [Dataset](docs/v2/models/Dataset.md) -- [DatasetDict](docs/v2/models/DatasetDict.md) -- [DatasetName](docs/v2/models/DatasetName.md) -- [DatasetRid](docs/v2/models/DatasetRid.md) -- [DatasetUpdatedTrigger](docs/v2/models/DatasetUpdatedTrigger.md) -- [DatasetUpdatedTriggerDict](docs/v2/models/DatasetUpdatedTriggerDict.md) - [DataValue](docs/v2/models/DataValue.md) -- [DateType](docs/v2/models/DateType.md) -- [DateTypeDict](docs/v2/models/DateTypeDict.md) -- [DecimalType](docs/v2/models/DecimalType.md) -- [DecimalTypeDict](docs/v2/models/DecimalTypeDict.md) - [DeleteLinkRule](docs/v2/models/DeleteLinkRule.md) - [DeleteLinkRuleDict](docs/v2/models/DeleteLinkRuleDict.md) - [DeleteObjectRule](docs/v2/models/DeleteObjectRule.md) - [DeleteObjectRuleDict](docs/v2/models/DeleteObjectRuleDict.md) -- [DeployWebsiteRequest](docs/v2/models/DeployWebsiteRequest.md) -- [DeployWebsiteRequestDict](docs/v2/models/DeployWebsiteRequestDict.md) -- [DisplayName](docs/v2/models/DisplayName.md) -- [Distance](docs/v2/models/Distance.md) -- [DistanceDict](docs/v2/models/DistanceDict.md) -- [DistanceUnit](docs/v2/models/DistanceUnit.md) - [DoesNotIntersectBoundingBoxQuery](docs/v2/models/DoesNotIntersectBoundingBoxQuery.md) - [DoesNotIntersectBoundingBoxQueryDict](docs/v2/models/DoesNotIntersectBoundingBoxQueryDict.md) - [DoesNotIntersectPolygonQuery](docs/v2/models/DoesNotIntersectPolygonQuery.md) - [DoesNotIntersectPolygonQueryDict](docs/v2/models/DoesNotIntersectPolygonQueryDict.md) -- [DoubleType](docs/v2/models/DoubleType.md) -- [DoubleTypeDict](docs/v2/models/DoubleTypeDict.md) -- [Duration](docs/v2/models/Duration.md) -- [DurationDict](docs/v2/models/DurationDict.md) -- [EqualsQuery](docs/v2/models/EqualsQuery.md) -- [EqualsQueryDict](docs/v2/models/EqualsQueryDict.md) - [EqualsQueryV2](docs/v2/models/EqualsQueryV2.md) - [EqualsQueryV2Dict](docs/v2/models/EqualsQueryV2Dict.md) -- [Error](docs/v2/models/Error.md) -- [ErrorDict](docs/v2/models/ErrorDict.md) -- [ErrorName](docs/v2/models/ErrorName.md) -- [ExactDistinctAggregationV2](docs/v2/models/ExactDistinctAggregationV2.md) - [ExactDistinctAggregationV2Dict](docs/v2/models/ExactDistinctAggregationV2Dict.md) -- [ExecuteQueryRequest](docs/v2/models/ExecuteQueryRequest.md) -- [ExecuteQueryRequestDict](docs/v2/models/ExecuteQueryRequestDict.md) - [ExecuteQueryResponse](docs/v2/models/ExecuteQueryResponse.md) - [ExecuteQueryResponseDict](docs/v2/models/ExecuteQueryResponseDict.md) -- [FallbackBranches](docs/v2/models/FallbackBranches.md) -- [Feature](docs/v2/models/Feature.md) -- [FeatureCollection](docs/v2/models/FeatureCollection.md) -- [FeatureCollectionDict](docs/v2/models/FeatureCollectionDict.md) -- [FeatureCollectionTypes](docs/v2/models/FeatureCollectionTypes.md) -- [FeatureCollectionTypesDict](docs/v2/models/FeatureCollectionTypesDict.md) -- [FeatureDict](docs/v2/models/FeatureDict.md) -- [FeaturePropertyKey](docs/v2/models/FeaturePropertyKey.md) -- [FieldNameV1](docs/v2/models/FieldNameV1.md) -- [File](docs/v2/models/File.md) -- [FileDict](docs/v2/models/FileDict.md) -- [Filename](docs/v2/models/Filename.md) -- [FilePath](docs/v2/models/FilePath.md) -- [FilesystemResource](docs/v2/models/FilesystemResource.md) -- [FilesystemResourceDict](docs/v2/models/FilesystemResourceDict.md) -- [FileUpdatedTime](docs/v2/models/FileUpdatedTime.md) -- [FilterValue](docs/v2/models/FilterValue.md) -- [FloatType](docs/v2/models/FloatType.md) -- [FloatTypeDict](docs/v2/models/FloatTypeDict.md) -- [Folder](docs/v2/models/Folder.md) -- [FolderDict](docs/v2/models/FolderDict.md) -- [FolderRid](docs/v2/models/FolderRid.md) -- [ForceBuild](docs/v2/models/ForceBuild.md) - [FunctionRid](docs/v2/models/FunctionRid.md) - [FunctionVersion](docs/v2/models/FunctionVersion.md) -- [Fuzzy](docs/v2/models/Fuzzy.md) - [FuzzyV2](docs/v2/models/FuzzyV2.md) -- [GeoJsonObject](docs/v2/models/GeoJsonObject.md) -- [GeoJsonObjectDict](docs/v2/models/GeoJsonObjectDict.md) -- [Geometry](docs/v2/models/Geometry.md) -- [GeometryCollection](docs/v2/models/GeometryCollection.md) -- [GeometryCollectionDict](docs/v2/models/GeometryCollectionDict.md) -- [GeometryDict](docs/v2/models/GeometryDict.md) -- [GeoPoint](docs/v2/models/GeoPoint.md) -- [GeoPointDict](docs/v2/models/GeoPointDict.md) -- [GeoPointType](docs/v2/models/GeoPointType.md) -- [GeoPointTypeDict](docs/v2/models/GeoPointTypeDict.md) -- [GeoShapeType](docs/v2/models/GeoShapeType.md) -- [GeoShapeTypeDict](docs/v2/models/GeoShapeTypeDict.md) -- [GeotimeSeriesValue](docs/v2/models/GeotimeSeriesValue.md) -- [GeotimeSeriesValueDict](docs/v2/models/GeotimeSeriesValueDict.md) -- [GetGroupsBatchRequestElement](docs/v2/models/GetGroupsBatchRequestElement.md) -- [GetGroupsBatchRequestElementDict](docs/v2/models/GetGroupsBatchRequestElementDict.md) -- [GetGroupsBatchResponse](docs/v2/models/GetGroupsBatchResponse.md) -- [GetGroupsBatchResponseDict](docs/v2/models/GetGroupsBatchResponseDict.md) -- [GetUsersBatchRequestElement](docs/v2/models/GetUsersBatchRequestElement.md) -- [GetUsersBatchRequestElementDict](docs/v2/models/GetUsersBatchRequestElementDict.md) -- [GetUsersBatchResponse](docs/v2/models/GetUsersBatchResponse.md) -- [GetUsersBatchResponseDict](docs/v2/models/GetUsersBatchResponseDict.md) -- [Group](docs/v2/models/Group.md) -- [GroupDict](docs/v2/models/GroupDict.md) -- [GroupMember](docs/v2/models/GroupMember.md) - [GroupMemberConstraint](docs/v2/models/GroupMemberConstraint.md) - [GroupMemberConstraintDict](docs/v2/models/GroupMemberConstraintDict.md) -- [GroupMemberDict](docs/v2/models/GroupMemberDict.md) -- [GroupMembership](docs/v2/models/GroupMembership.md) -- [GroupMembershipDict](docs/v2/models/GroupMembershipDict.md) -- [GroupMembershipExpiration](docs/v2/models/GroupMembershipExpiration.md) -- [GroupName](docs/v2/models/GroupName.md) -- [GroupSearchFilter](docs/v2/models/GroupSearchFilter.md) -- [GroupSearchFilterDict](docs/v2/models/GroupSearchFilterDict.md) -- [GteQuery](docs/v2/models/GteQuery.md) -- [GteQueryDict](docs/v2/models/GteQueryDict.md) - [GteQueryV2](docs/v2/models/GteQueryV2.md) - [GteQueryV2Dict](docs/v2/models/GteQueryV2Dict.md) -- [GtQuery](docs/v2/models/GtQuery.md) -- [GtQueryDict](docs/v2/models/GtQueryDict.md) - [GtQueryV2](docs/v2/models/GtQueryV2.md) - [GtQueryV2Dict](docs/v2/models/GtQueryV2Dict.md) - [Icon](docs/v2/models/Icon.md) - [IconDict](docs/v2/models/IconDict.md) -- [IntegerType](docs/v2/models/IntegerType.md) -- [IntegerTypeDict](docs/v2/models/IntegerTypeDict.md) - [InterfaceLinkType](docs/v2/models/InterfaceLinkType.md) - [InterfaceLinkTypeApiName](docs/v2/models/InterfaceLinkTypeApiName.md) - [InterfaceLinkTypeCardinality](docs/v2/models/InterfaceLinkTypeCardinality.md) @@ -824,17 +724,8 @@ Namespace | Resource | Operation | HTTP request | - [IntersectsBoundingBoxQueryDict](docs/v2/models/IntersectsBoundingBoxQueryDict.md) - [IntersectsPolygonQuery](docs/v2/models/IntersectsPolygonQuery.md) - [IntersectsPolygonQueryDict](docs/v2/models/IntersectsPolygonQueryDict.md) -- [IrVersion](docs/v2/models/IrVersion.md) -- [IsNullQuery](docs/v2/models/IsNullQuery.md) -- [IsNullQueryDict](docs/v2/models/IsNullQueryDict.md) - [IsNullQueryV2](docs/v2/models/IsNullQueryV2.md) - [IsNullQueryV2Dict](docs/v2/models/IsNullQueryV2Dict.md) -- [JobSucceededTrigger](docs/v2/models/JobSucceededTrigger.md) -- [JobSucceededTriggerDict](docs/v2/models/JobSucceededTriggerDict.md) -- [LinearRing](docs/v2/models/LinearRing.md) -- [LineString](docs/v2/models/LineString.md) -- [LineStringCoordinates](docs/v2/models/LineStringCoordinates.md) -- [LineStringDict](docs/v2/models/LineStringDict.md) - [LinkedInterfaceTypeApiName](docs/v2/models/LinkedInterfaceTypeApiName.md) - [LinkedInterfaceTypeApiNameDict](docs/v2/models/LinkedInterfaceTypeApiNameDict.md) - [LinkedObjectTypeApiName](docs/v2/models/LinkedObjectTypeApiName.md) @@ -843,117 +734,47 @@ Namespace | Resource | Operation | HTTP request | - [LinkSideObjectDict](docs/v2/models/LinkSideObjectDict.md) - [LinkTypeApiName](docs/v2/models/LinkTypeApiName.md) - [LinkTypeRid](docs/v2/models/LinkTypeRid.md) -- [LinkTypeSide](docs/v2/models/LinkTypeSide.md) - [LinkTypeSideCardinality](docs/v2/models/LinkTypeSideCardinality.md) -- [LinkTypeSideDict](docs/v2/models/LinkTypeSideDict.md) - [LinkTypeSideV2](docs/v2/models/LinkTypeSideV2.md) - [LinkTypeSideV2Dict](docs/v2/models/LinkTypeSideV2Dict.md) -- [ListActionTypesResponse](docs/v2/models/ListActionTypesResponse.md) -- [ListActionTypesResponseDict](docs/v2/models/ListActionTypesResponseDict.md) - [ListActionTypesResponseV2](docs/v2/models/ListActionTypesResponseV2.md) - [ListActionTypesResponseV2Dict](docs/v2/models/ListActionTypesResponseV2Dict.md) - [ListAttachmentsResponseV2](docs/v2/models/ListAttachmentsResponseV2.md) - [ListAttachmentsResponseV2Dict](docs/v2/models/ListAttachmentsResponseV2Dict.md) -- [ListBranchesResponse](docs/v2/models/ListBranchesResponse.md) -- [ListBranchesResponseDict](docs/v2/models/ListBranchesResponseDict.md) -- [ListFilesResponse](docs/v2/models/ListFilesResponse.md) -- [ListFilesResponseDict](docs/v2/models/ListFilesResponseDict.md) -- [ListGroupMembershipsResponse](docs/v2/models/ListGroupMembershipsResponse.md) -- [ListGroupMembershipsResponseDict](docs/v2/models/ListGroupMembershipsResponseDict.md) -- [ListGroupMembersResponse](docs/v2/models/ListGroupMembersResponse.md) -- [ListGroupMembersResponseDict](docs/v2/models/ListGroupMembersResponseDict.md) -- [ListGroupsResponse](docs/v2/models/ListGroupsResponse.md) -- [ListGroupsResponseDict](docs/v2/models/ListGroupsResponseDict.md) - [ListInterfaceTypesResponse](docs/v2/models/ListInterfaceTypesResponse.md) - [ListInterfaceTypesResponseDict](docs/v2/models/ListInterfaceTypesResponseDict.md) -- [ListLinkedObjectsResponse](docs/v2/models/ListLinkedObjectsResponse.md) -- [ListLinkedObjectsResponseDict](docs/v2/models/ListLinkedObjectsResponseDict.md) - [ListLinkedObjectsResponseV2](docs/v2/models/ListLinkedObjectsResponseV2.md) - [ListLinkedObjectsResponseV2Dict](docs/v2/models/ListLinkedObjectsResponseV2Dict.md) -- [ListObjectsResponse](docs/v2/models/ListObjectsResponse.md) -- [ListObjectsResponseDict](docs/v2/models/ListObjectsResponseDict.md) - [ListObjectsResponseV2](docs/v2/models/ListObjectsResponseV2.md) - [ListObjectsResponseV2Dict](docs/v2/models/ListObjectsResponseV2Dict.md) -- [ListObjectTypesResponse](docs/v2/models/ListObjectTypesResponse.md) -- [ListObjectTypesResponseDict](docs/v2/models/ListObjectTypesResponseDict.md) - [ListObjectTypesV2Response](docs/v2/models/ListObjectTypesV2Response.md) - [ListObjectTypesV2ResponseDict](docs/v2/models/ListObjectTypesV2ResponseDict.md) -- [ListOntologiesResponse](docs/v2/models/ListOntologiesResponse.md) -- [ListOntologiesResponseDict](docs/v2/models/ListOntologiesResponseDict.md) -- [ListOntologiesV2Response](docs/v2/models/ListOntologiesV2Response.md) -- [ListOntologiesV2ResponseDict](docs/v2/models/ListOntologiesV2ResponseDict.md) -- [ListOutgoingLinkTypesResponse](docs/v2/models/ListOutgoingLinkTypesResponse.md) -- [ListOutgoingLinkTypesResponseDict](docs/v2/models/ListOutgoingLinkTypesResponseDict.md) - [ListOutgoingLinkTypesResponseV2](docs/v2/models/ListOutgoingLinkTypesResponseV2.md) - [ListOutgoingLinkTypesResponseV2Dict](docs/v2/models/ListOutgoingLinkTypesResponseV2Dict.md) -- [ListQueryTypesResponse](docs/v2/models/ListQueryTypesResponse.md) -- [ListQueryTypesResponseDict](docs/v2/models/ListQueryTypesResponseDict.md) - [ListQueryTypesResponseV2](docs/v2/models/ListQueryTypesResponseV2.md) - [ListQueryTypesResponseV2Dict](docs/v2/models/ListQueryTypesResponseV2Dict.md) -- [ListUsersResponse](docs/v2/models/ListUsersResponse.md) -- [ListUsersResponseDict](docs/v2/models/ListUsersResponseDict.md) -- [ListVersionsResponse](docs/v2/models/ListVersionsResponse.md) -- [ListVersionsResponseDict](docs/v2/models/ListVersionsResponseDict.md) -- [LoadObjectSetRequestV2](docs/v2/models/LoadObjectSetRequestV2.md) -- [LoadObjectSetRequestV2Dict](docs/v2/models/LoadObjectSetRequestV2Dict.md) - [LoadObjectSetResponseV2](docs/v2/models/LoadObjectSetResponseV2.md) - [LoadObjectSetResponseV2Dict](docs/v2/models/LoadObjectSetResponseV2Dict.md) -- [LocalFilePath](docs/v2/models/LocalFilePath.md) -- [LocalFilePathDict](docs/v2/models/LocalFilePathDict.md) - [LogicRule](docs/v2/models/LogicRule.md) - [LogicRuleDict](docs/v2/models/LogicRuleDict.md) -- [LongType](docs/v2/models/LongType.md) -- [LongTypeDict](docs/v2/models/LongTypeDict.md) -- [LteQuery](docs/v2/models/LteQuery.md) -- [LteQueryDict](docs/v2/models/LteQueryDict.md) - [LteQueryV2](docs/v2/models/LteQueryV2.md) - [LteQueryV2Dict](docs/v2/models/LteQueryV2Dict.md) -- [LtQuery](docs/v2/models/LtQuery.md) -- [LtQueryDict](docs/v2/models/LtQueryDict.md) - [LtQueryV2](docs/v2/models/LtQueryV2.md) - [LtQueryV2Dict](docs/v2/models/LtQueryV2Dict.md) -- [ManualTarget](docs/v2/models/ManualTarget.md) -- [ManualTargetDict](docs/v2/models/ManualTargetDict.md) -- [MarkingType](docs/v2/models/MarkingType.md) -- [MarkingTypeDict](docs/v2/models/MarkingTypeDict.md) -- [MaxAggregation](docs/v2/models/MaxAggregation.md) -- [MaxAggregationDict](docs/v2/models/MaxAggregationDict.md) -- [MaxAggregationV2](docs/v2/models/MaxAggregationV2.md) - [MaxAggregationV2Dict](docs/v2/models/MaxAggregationV2Dict.md) -- [MediaSetRid](docs/v2/models/MediaSetRid.md) -- [MediaSetUpdatedTrigger](docs/v2/models/MediaSetUpdatedTrigger.md) -- [MediaSetUpdatedTriggerDict](docs/v2/models/MediaSetUpdatedTriggerDict.md) -- [MediaType](docs/v2/models/MediaType.md) -- [MinAggregation](docs/v2/models/MinAggregation.md) -- [MinAggregationDict](docs/v2/models/MinAggregationDict.md) -- [MinAggregationV2](docs/v2/models/MinAggregationV2.md) - [MinAggregationV2Dict](docs/v2/models/MinAggregationV2Dict.md) +- [ModifyInterfaceObjectRule](docs/v2/models/ModifyInterfaceObjectRule.md) +- [ModifyInterfaceObjectRuleDict](docs/v2/models/ModifyInterfaceObjectRuleDict.md) - [ModifyObject](docs/v2/models/ModifyObject.md) - [ModifyObjectDict](docs/v2/models/ModifyObjectDict.md) - [ModifyObjectRule](docs/v2/models/ModifyObjectRule.md) - [ModifyObjectRuleDict](docs/v2/models/ModifyObjectRuleDict.md) -- [MultiLineString](docs/v2/models/MultiLineString.md) -- [MultiLineStringDict](docs/v2/models/MultiLineStringDict.md) -- [MultiPoint](docs/v2/models/MultiPoint.md) -- [MultiPointDict](docs/v2/models/MultiPointDict.md) -- [MultiPolygon](docs/v2/models/MultiPolygon.md) -- [MultiPolygonDict](docs/v2/models/MultiPolygonDict.md) -- [NestedQueryAggregation](docs/v2/models/NestedQueryAggregation.md) -- [NestedQueryAggregationDict](docs/v2/models/NestedQueryAggregationDict.md) -- [NewLogicTrigger](docs/v2/models/NewLogicTrigger.md) -- [NewLogicTriggerDict](docs/v2/models/NewLogicTriggerDict.md) -- [NotificationsEnabled](docs/v2/models/NotificationsEnabled.md) -- [NotQuery](docs/v2/models/NotQuery.md) -- [NotQueryDict](docs/v2/models/NotQueryDict.md) - [NotQueryV2](docs/v2/models/NotQueryV2.md) - [NotQueryV2Dict](docs/v2/models/NotQueryV2Dict.md) -- [NullType](docs/v2/models/NullType.md) -- [NullTypeDict](docs/v2/models/NullTypeDict.md) - [ObjectEdit](docs/v2/models/ObjectEdit.md) - [ObjectEditDict](docs/v2/models/ObjectEditDict.md) - [ObjectEdits](docs/v2/models/ObjectEdits.md) - [ObjectEditsDict](docs/v2/models/ObjectEditsDict.md) -- [ObjectPrimaryKey](docs/v2/models/ObjectPrimaryKey.md) - [ObjectPropertyType](docs/v2/models/ObjectPropertyType.md) - [ObjectPropertyTypeDict](docs/v2/models/ObjectPropertyTypeDict.md) - [ObjectPropertyValueConstraint](docs/v2/models/ObjectPropertyValueConstraint.md) @@ -976,26 +797,11 @@ Namespace | Resource | Operation | HTTP request | - [ObjectSetSearchAroundTypeDict](docs/v2/models/ObjectSetSearchAroundTypeDict.md) - [ObjectSetStaticType](docs/v2/models/ObjectSetStaticType.md) - [ObjectSetStaticTypeDict](docs/v2/models/ObjectSetStaticTypeDict.md) -- [ObjectSetStreamSubscribeRequest](docs/v2/models/ObjectSetStreamSubscribeRequest.md) -- [ObjectSetStreamSubscribeRequestDict](docs/v2/models/ObjectSetStreamSubscribeRequestDict.md) -- [ObjectSetStreamSubscribeRequests](docs/v2/models/ObjectSetStreamSubscribeRequests.md) -- [ObjectSetStreamSubscribeRequestsDict](docs/v2/models/ObjectSetStreamSubscribeRequestsDict.md) -- [ObjectSetSubscribeResponse](docs/v2/models/ObjectSetSubscribeResponse.md) -- [ObjectSetSubscribeResponseDict](docs/v2/models/ObjectSetSubscribeResponseDict.md) -- [ObjectSetSubscribeResponses](docs/v2/models/ObjectSetSubscribeResponses.md) -- [ObjectSetSubscribeResponsesDict](docs/v2/models/ObjectSetSubscribeResponsesDict.md) - [ObjectSetSubtractType](docs/v2/models/ObjectSetSubtractType.md) - [ObjectSetSubtractTypeDict](docs/v2/models/ObjectSetSubtractTypeDict.md) - [ObjectSetUnionType](docs/v2/models/ObjectSetUnionType.md) - [ObjectSetUnionTypeDict](docs/v2/models/ObjectSetUnionTypeDict.md) -- [ObjectSetUpdate](docs/v2/models/ObjectSetUpdate.md) -- [ObjectSetUpdateDict](docs/v2/models/ObjectSetUpdateDict.md) -- [ObjectSetUpdates](docs/v2/models/ObjectSetUpdates.md) -- [ObjectSetUpdatesDict](docs/v2/models/ObjectSetUpdatesDict.md) -- [ObjectState](docs/v2/models/ObjectState.md) -- [ObjectType](docs/v2/models/ObjectType.md) - [ObjectTypeApiName](docs/v2/models/ObjectTypeApiName.md) -- [ObjectTypeDict](docs/v2/models/ObjectTypeDict.md) - [ObjectTypeEdits](docs/v2/models/ObjectTypeEdits.md) - [ObjectTypeEditsDict](docs/v2/models/ObjectTypeEditsDict.md) - [ObjectTypeFullMetadata](docs/v2/models/ObjectTypeFullMetadata.md) @@ -1006,53 +812,26 @@ Namespace | Resource | Operation | HTTP request | - [ObjectTypeV2](docs/v2/models/ObjectTypeV2.md) - [ObjectTypeV2Dict](docs/v2/models/ObjectTypeV2Dict.md) - [ObjectTypeVisibility](docs/v2/models/ObjectTypeVisibility.md) -- [ObjectUpdate](docs/v2/models/ObjectUpdate.md) -- [ObjectUpdateDict](docs/v2/models/ObjectUpdateDict.md) - [OneOfConstraint](docs/v2/models/OneOfConstraint.md) - [OneOfConstraintDict](docs/v2/models/OneOfConstraintDict.md) -- [Ontology](docs/v2/models/Ontology.md) - [OntologyApiName](docs/v2/models/OntologyApiName.md) -- [OntologyArrayType](docs/v2/models/OntologyArrayType.md) -- [OntologyArrayTypeDict](docs/v2/models/OntologyArrayTypeDict.md) -- [OntologyDataType](docs/v2/models/OntologyDataType.md) -- [OntologyDataTypeDict](docs/v2/models/OntologyDataTypeDict.md) -- [OntologyDict](docs/v2/models/OntologyDict.md) - [OntologyFullMetadata](docs/v2/models/OntologyFullMetadata.md) - [OntologyFullMetadataDict](docs/v2/models/OntologyFullMetadataDict.md) - [OntologyIdentifier](docs/v2/models/OntologyIdentifier.md) -- [OntologyMapType](docs/v2/models/OntologyMapType.md) -- [OntologyMapTypeDict](docs/v2/models/OntologyMapTypeDict.md) -- [OntologyObject](docs/v2/models/OntologyObject.md) - [OntologyObjectArrayType](docs/v2/models/OntologyObjectArrayType.md) - [OntologyObjectArrayTypeDict](docs/v2/models/OntologyObjectArrayTypeDict.md) -- [OntologyObjectDict](docs/v2/models/OntologyObjectDict.md) - [OntologyObjectSetType](docs/v2/models/OntologyObjectSetType.md) - [OntologyObjectSetTypeDict](docs/v2/models/OntologyObjectSetTypeDict.md) - [OntologyObjectType](docs/v2/models/OntologyObjectType.md) - [OntologyObjectTypeDict](docs/v2/models/OntologyObjectTypeDict.md) - [OntologyObjectV2](docs/v2/models/OntologyObjectV2.md) - [OntologyRid](docs/v2/models/OntologyRid.md) -- [OntologySetType](docs/v2/models/OntologySetType.md) -- [OntologySetTypeDict](docs/v2/models/OntologySetTypeDict.md) -- [OntologyStructField](docs/v2/models/OntologyStructField.md) -- [OntologyStructFieldDict](docs/v2/models/OntologyStructFieldDict.md) -- [OntologyStructType](docs/v2/models/OntologyStructType.md) -- [OntologyStructTypeDict](docs/v2/models/OntologyStructTypeDict.md) - [OntologyV2](docs/v2/models/OntologyV2.md) - [OntologyV2Dict](docs/v2/models/OntologyV2Dict.md) - [OrderBy](docs/v2/models/OrderBy.md) - [OrderByDirection](docs/v2/models/OrderByDirection.md) -- [OrganizationRid](docs/v2/models/OrganizationRid.md) -- [OrQuery](docs/v2/models/OrQuery.md) -- [OrQueryDict](docs/v2/models/OrQueryDict.md) - [OrQueryV2](docs/v2/models/OrQueryV2.md) - [OrQueryV2Dict](docs/v2/models/OrQueryV2Dict.md) -- [OrTrigger](docs/v2/models/OrTrigger.md) -- [OrTriggerDict](docs/v2/models/OrTriggerDict.md) -- [PageSize](docs/v2/models/PageSize.md) -- [PageToken](docs/v2/models/PageToken.md) -- [Parameter](docs/v2/models/Parameter.md) -- [ParameterDict](docs/v2/models/ParameterDict.md) - [ParameterEvaluatedConstraint](docs/v2/models/ParameterEvaluatedConstraint.md) - [ParameterEvaluatedConstraintDict](docs/v2/models/ParameterEvaluatedConstraintDict.md) - [ParameterEvaluationResult](docs/v2/models/ParameterEvaluationResult.md) @@ -1060,42 +839,15 @@ Namespace | Resource | Operation | HTTP request | - [ParameterId](docs/v2/models/ParameterId.md) - [ParameterOption](docs/v2/models/ParameterOption.md) - [ParameterOptionDict](docs/v2/models/ParameterOptionDict.md) -- [PhraseQuery](docs/v2/models/PhraseQuery.md) -- [PhraseQueryDict](docs/v2/models/PhraseQueryDict.md) -- [Polygon](docs/v2/models/Polygon.md) -- [PolygonDict](docs/v2/models/PolygonDict.md) - [PolygonValue](docs/v2/models/PolygonValue.md) - [PolygonValueDict](docs/v2/models/PolygonValueDict.md) -- [Position](docs/v2/models/Position.md) -- [PrefixQuery](docs/v2/models/PrefixQuery.md) -- [PrefixQueryDict](docs/v2/models/PrefixQueryDict.md) -- [PreviewMode](docs/v2/models/PreviewMode.md) -- [PrimaryKeyValue](docs/v2/models/PrimaryKeyValue.md) -- [PrincipalFilterType](docs/v2/models/PrincipalFilterType.md) -- [PrincipalId](docs/v2/models/PrincipalId.md) -- [PrincipalType](docs/v2/models/PrincipalType.md) -- [Project](docs/v2/models/Project.md) -- [ProjectDict](docs/v2/models/ProjectDict.md) -- [ProjectRid](docs/v2/models/ProjectRid.md) -- [ProjectScope](docs/v2/models/ProjectScope.md) -- [ProjectScopeDict](docs/v2/models/ProjectScopeDict.md) -- [Property](docs/v2/models/Property.md) - [PropertyApiName](docs/v2/models/PropertyApiName.md) -- [PropertyDict](docs/v2/models/PropertyDict.md) -- [PropertyFilter](docs/v2/models/PropertyFilter.md) -- [PropertyId](docs/v2/models/PropertyId.md) - [PropertyV2](docs/v2/models/PropertyV2.md) - [PropertyV2Dict](docs/v2/models/PropertyV2Dict.md) - [PropertyValue](docs/v2/models/PropertyValue.md) - [PropertyValueEscapedString](docs/v2/models/PropertyValueEscapedString.md) -- [QosError](docs/v2/models/QosError.md) -- [QosErrorDict](docs/v2/models/QosErrorDict.md) -- [QueryAggregation](docs/v2/models/QueryAggregation.md) -- [QueryAggregationDict](docs/v2/models/QueryAggregationDict.md) - [QueryAggregationKeyType](docs/v2/models/QueryAggregationKeyType.md) - [QueryAggregationKeyTypeDict](docs/v2/models/QueryAggregationKeyTypeDict.md) -- [QueryAggregationRange](docs/v2/models/QueryAggregationRange.md) -- [QueryAggregationRangeDict](docs/v2/models/QueryAggregationRangeDict.md) - [QueryAggregationRangeSubType](docs/v2/models/QueryAggregationRangeSubType.md) - [QueryAggregationRangeSubTypeDict](docs/v2/models/QueryAggregationRangeSubTypeDict.md) - [QueryAggregationRangeType](docs/v2/models/QueryAggregationRangeType.md) @@ -1107,217 +859,60 @@ Namespace | Resource | Operation | HTTP request | - [QueryArrayTypeDict](docs/v2/models/QueryArrayTypeDict.md) - [QueryDataType](docs/v2/models/QueryDataType.md) - [QueryDataTypeDict](docs/v2/models/QueryDataTypeDict.md) -- [QueryOutputV2](docs/v2/models/QueryOutputV2.md) -- [QueryOutputV2Dict](docs/v2/models/QueryOutputV2Dict.md) - [QueryParameterV2](docs/v2/models/QueryParameterV2.md) - [QueryParameterV2Dict](docs/v2/models/QueryParameterV2Dict.md) -- [QueryRuntimeErrorParameter](docs/v2/models/QueryRuntimeErrorParameter.md) - [QuerySetType](docs/v2/models/QuerySetType.md) - [QuerySetTypeDict](docs/v2/models/QuerySetTypeDict.md) - [QueryStructField](docs/v2/models/QueryStructField.md) - [QueryStructFieldDict](docs/v2/models/QueryStructFieldDict.md) - [QueryStructType](docs/v2/models/QueryStructType.md) - [QueryStructTypeDict](docs/v2/models/QueryStructTypeDict.md) -- [QueryThreeDimensionalAggregation](docs/v2/models/QueryThreeDimensionalAggregation.md) -- [QueryThreeDimensionalAggregationDict](docs/v2/models/QueryThreeDimensionalAggregationDict.md) -- [QueryTwoDimensionalAggregation](docs/v2/models/QueryTwoDimensionalAggregation.md) -- [QueryTwoDimensionalAggregationDict](docs/v2/models/QueryTwoDimensionalAggregationDict.md) -- [QueryType](docs/v2/models/QueryType.md) -- [QueryTypeDict](docs/v2/models/QueryTypeDict.md) - [QueryTypeV2](docs/v2/models/QueryTypeV2.md) - [QueryTypeV2Dict](docs/v2/models/QueryTypeV2Dict.md) - [QueryUnionType](docs/v2/models/QueryUnionType.md) - [QueryUnionTypeDict](docs/v2/models/QueryUnionTypeDict.md) - [RangeConstraint](docs/v2/models/RangeConstraint.md) - [RangeConstraintDict](docs/v2/models/RangeConstraintDict.md) -- [Realm](docs/v2/models/Realm.md) -- [Reason](docs/v2/models/Reason.md) -- [ReasonDict](docs/v2/models/ReasonDict.md) -- [ReasonType](docs/v2/models/ReasonType.md) -- [ReferenceUpdate](docs/v2/models/ReferenceUpdate.md) -- [ReferenceUpdateDict](docs/v2/models/ReferenceUpdateDict.md) -- [ReferenceValue](docs/v2/models/ReferenceValue.md) -- [ReferenceValueDict](docs/v2/models/ReferenceValueDict.md) -- [RefreshObjectSet](docs/v2/models/RefreshObjectSet.md) -- [RefreshObjectSetDict](docs/v2/models/RefreshObjectSetDict.md) -- [RelativeTime](docs/v2/models/RelativeTime.md) - [RelativeTimeDict](docs/v2/models/RelativeTimeDict.md) -- [RelativeTimeRange](docs/v2/models/RelativeTimeRange.md) - [RelativeTimeRangeDict](docs/v2/models/RelativeTimeRangeDict.md) - [RelativeTimeRelation](docs/v2/models/RelativeTimeRelation.md) - [RelativeTimeSeriesTimeUnit](docs/v2/models/RelativeTimeSeriesTimeUnit.md) -- [ReleaseStatus](docs/v2/models/ReleaseStatus.md) -- [RemoveGroupMembersRequest](docs/v2/models/RemoveGroupMembersRequest.md) -- [RemoveGroupMembersRequestDict](docs/v2/models/RemoveGroupMembersRequestDict.md) -- [RequestId](docs/v2/models/RequestId.md) -- [Resource](docs/v2/models/Resource.md) -- [ResourceDict](docs/v2/models/ResourceDict.md) -- [ResourceDisplayName](docs/v2/models/ResourceDisplayName.md) -- [ResourcePath](docs/v2/models/ResourcePath.md) -- [ResourceRid](docs/v2/models/ResourceRid.md) -- [ResourceType](docs/v2/models/ResourceType.md) -- [RetryBackoffDuration](docs/v2/models/RetryBackoffDuration.md) -- [RetryBackoffDurationDict](docs/v2/models/RetryBackoffDurationDict.md) -- [RetryCount](docs/v2/models/RetryCount.md) - [ReturnEditsMode](docs/v2/models/ReturnEditsMode.md) -- [Schedule](docs/v2/models/Schedule.md) -- [ScheduleDict](docs/v2/models/ScheduleDict.md) -- [SchedulePaused](docs/v2/models/SchedulePaused.md) -- [ScheduleRid](docs/v2/models/ScheduleRid.md) -- [ScheduleRun](docs/v2/models/ScheduleRun.md) -- [ScheduleRunDict](docs/v2/models/ScheduleRunDict.md) -- [ScheduleRunError](docs/v2/models/ScheduleRunError.md) -- [ScheduleRunErrorDict](docs/v2/models/ScheduleRunErrorDict.md) -- [ScheduleRunErrorName](docs/v2/models/ScheduleRunErrorName.md) -- [ScheduleRunIgnored](docs/v2/models/ScheduleRunIgnored.md) -- [ScheduleRunIgnoredDict](docs/v2/models/ScheduleRunIgnoredDict.md) -- [ScheduleRunResult](docs/v2/models/ScheduleRunResult.md) -- [ScheduleRunResultDict](docs/v2/models/ScheduleRunResultDict.md) -- [ScheduleRunRid](docs/v2/models/ScheduleRunRid.md) -- [ScheduleRunSubmitted](docs/v2/models/ScheduleRunSubmitted.md) -- [ScheduleRunSubmittedDict](docs/v2/models/ScheduleRunSubmittedDict.md) -- [ScheduleSucceededTrigger](docs/v2/models/ScheduleSucceededTrigger.md) -- [ScheduleSucceededTriggerDict](docs/v2/models/ScheduleSucceededTriggerDict.md) -- [ScheduleVersion](docs/v2/models/ScheduleVersion.md) -- [ScheduleVersionDict](docs/v2/models/ScheduleVersionDict.md) -- [ScheduleVersionRid](docs/v2/models/ScheduleVersionRid.md) -- [ScopeMode](docs/v2/models/ScopeMode.md) -- [ScopeModeDict](docs/v2/models/ScopeModeDict.md) - [SdkPackageName](docs/v2/models/SdkPackageName.md) -- [SearchGroupsRequest](docs/v2/models/SearchGroupsRequest.md) -- [SearchGroupsRequestDict](docs/v2/models/SearchGroupsRequestDict.md) -- [SearchGroupsResponse](docs/v2/models/SearchGroupsResponse.md) -- [SearchGroupsResponseDict](docs/v2/models/SearchGroupsResponseDict.md) -- [SearchJsonQuery](docs/v2/models/SearchJsonQuery.md) -- [SearchJsonQueryDict](docs/v2/models/SearchJsonQueryDict.md) - [SearchJsonQueryV2](docs/v2/models/SearchJsonQueryV2.md) - [SearchJsonQueryV2Dict](docs/v2/models/SearchJsonQueryV2Dict.md) -- [SearchObjectsForInterfaceRequest](docs/v2/models/SearchObjectsForInterfaceRequest.md) -- [SearchObjectsForInterfaceRequestDict](docs/v2/models/SearchObjectsForInterfaceRequestDict.md) -- [SearchObjectsRequest](docs/v2/models/SearchObjectsRequest.md) -- [SearchObjectsRequestDict](docs/v2/models/SearchObjectsRequestDict.md) -- [SearchObjectsRequestV2](docs/v2/models/SearchObjectsRequestV2.md) -- [SearchObjectsRequestV2Dict](docs/v2/models/SearchObjectsRequestV2Dict.md) -- [SearchObjectsResponse](docs/v2/models/SearchObjectsResponse.md) -- [SearchObjectsResponseDict](docs/v2/models/SearchObjectsResponseDict.md) - [SearchObjectsResponseV2](docs/v2/models/SearchObjectsResponseV2.md) - [SearchObjectsResponseV2Dict](docs/v2/models/SearchObjectsResponseV2Dict.md) -- [SearchOrderBy](docs/v2/models/SearchOrderBy.md) -- [SearchOrderByDict](docs/v2/models/SearchOrderByDict.md) -- [SearchOrderByV2](docs/v2/models/SearchOrderByV2.md) - [SearchOrderByV2Dict](docs/v2/models/SearchOrderByV2Dict.md) -- [SearchOrdering](docs/v2/models/SearchOrdering.md) -- [SearchOrderingDict](docs/v2/models/SearchOrderingDict.md) -- [SearchOrderingV2](docs/v2/models/SearchOrderingV2.md) - [SearchOrderingV2Dict](docs/v2/models/SearchOrderingV2Dict.md) -- [SearchUsersRequest](docs/v2/models/SearchUsersRequest.md) -- [SearchUsersRequestDict](docs/v2/models/SearchUsersRequestDict.md) -- [SearchUsersResponse](docs/v2/models/SearchUsersResponse.md) -- [SearchUsersResponseDict](docs/v2/models/SearchUsersResponseDict.md) - [SelectedPropertyApiName](docs/v2/models/SelectedPropertyApiName.md) - [SharedPropertyType](docs/v2/models/SharedPropertyType.md) - [SharedPropertyTypeApiName](docs/v2/models/SharedPropertyTypeApiName.md) - [SharedPropertyTypeDict](docs/v2/models/SharedPropertyTypeDict.md) - [SharedPropertyTypeRid](docs/v2/models/SharedPropertyTypeRid.md) -- [ShortType](docs/v2/models/ShortType.md) -- [ShortTypeDict](docs/v2/models/ShortTypeDict.md) -- [SizeBytes](docs/v2/models/SizeBytes.md) -- [Space](docs/v2/models/Space.md) -- [SpaceDict](docs/v2/models/SpaceDict.md) -- [SpaceRid](docs/v2/models/SpaceRid.md) - [StartsWithQuery](docs/v2/models/StartsWithQuery.md) - [StartsWithQueryDict](docs/v2/models/StartsWithQueryDict.md) -- [StreamMessage](docs/v2/models/StreamMessage.md) -- [StreamMessageDict](docs/v2/models/StreamMessageDict.md) -- [StreamTimeSeriesPointsRequest](docs/v2/models/StreamTimeSeriesPointsRequest.md) -- [StreamTimeSeriesPointsRequestDict](docs/v2/models/StreamTimeSeriesPointsRequestDict.md) -- [StreamTimeSeriesPointsResponse](docs/v2/models/StreamTimeSeriesPointsResponse.md) -- [StreamTimeSeriesPointsResponseDict](docs/v2/models/StreamTimeSeriesPointsResponseDict.md) - [StringLengthConstraint](docs/v2/models/StringLengthConstraint.md) - [StringLengthConstraintDict](docs/v2/models/StringLengthConstraintDict.md) - [StringRegexMatchConstraint](docs/v2/models/StringRegexMatchConstraint.md) - [StringRegexMatchConstraintDict](docs/v2/models/StringRegexMatchConstraintDict.md) -- [StringType](docs/v2/models/StringType.md) -- [StringTypeDict](docs/v2/models/StringTypeDict.md) -- [StructFieldName](docs/v2/models/StructFieldName.md) -- [Subdomain](docs/v2/models/Subdomain.md) - [SubmissionCriteriaEvaluation](docs/v2/models/SubmissionCriteriaEvaluation.md) - [SubmissionCriteriaEvaluationDict](docs/v2/models/SubmissionCriteriaEvaluationDict.md) -- [SubscriptionClosed](docs/v2/models/SubscriptionClosed.md) -- [SubscriptionClosedDict](docs/v2/models/SubscriptionClosedDict.md) -- [SubscriptionClosureCause](docs/v2/models/SubscriptionClosureCause.md) -- [SubscriptionClosureCauseDict](docs/v2/models/SubscriptionClosureCauseDict.md) -- [SubscriptionError](docs/v2/models/SubscriptionError.md) -- [SubscriptionErrorDict](docs/v2/models/SubscriptionErrorDict.md) -- [SubscriptionId](docs/v2/models/SubscriptionId.md) -- [SubscriptionSuccess](docs/v2/models/SubscriptionSuccess.md) -- [SubscriptionSuccessDict](docs/v2/models/SubscriptionSuccessDict.md) -- [SumAggregation](docs/v2/models/SumAggregation.md) -- [SumAggregationDict](docs/v2/models/SumAggregationDict.md) -- [SumAggregationV2](docs/v2/models/SumAggregationV2.md) - [SumAggregationV2Dict](docs/v2/models/SumAggregationV2Dict.md) - [SyncApplyActionResponseV2](docs/v2/models/SyncApplyActionResponseV2.md) - [SyncApplyActionResponseV2Dict](docs/v2/models/SyncApplyActionResponseV2Dict.md) -- [TableExportFormat](docs/v2/models/TableExportFormat.md) -- [ThirdPartyApplication](docs/v2/models/ThirdPartyApplication.md) -- [ThirdPartyApplicationDict](docs/v2/models/ThirdPartyApplicationDict.md) -- [ThirdPartyApplicationRid](docs/v2/models/ThirdPartyApplicationRid.md) - [ThreeDimensionalAggregation](docs/v2/models/ThreeDimensionalAggregation.md) - [ThreeDimensionalAggregationDict](docs/v2/models/ThreeDimensionalAggregationDict.md) -- [TimeRange](docs/v2/models/TimeRange.md) - [TimeRangeDict](docs/v2/models/TimeRangeDict.md) -- [TimeSeriesItemType](docs/v2/models/TimeSeriesItemType.md) -- [TimeSeriesItemTypeDict](docs/v2/models/TimeSeriesItemTypeDict.md) - [TimeSeriesPoint](docs/v2/models/TimeSeriesPoint.md) - [TimeSeriesPointDict](docs/v2/models/TimeSeriesPointDict.md) -- [TimeseriesType](docs/v2/models/TimeseriesType.md) -- [TimeseriesTypeDict](docs/v2/models/TimeseriesTypeDict.md) -- [TimestampType](docs/v2/models/TimestampType.md) -- [TimestampTypeDict](docs/v2/models/TimestampTypeDict.md) -- [TimeTrigger](docs/v2/models/TimeTrigger.md) -- [TimeTriggerDict](docs/v2/models/TimeTriggerDict.md) -- [TimeUnit](docs/v2/models/TimeUnit.md) -- [TotalCount](docs/v2/models/TotalCount.md) -- [Transaction](docs/v2/models/Transaction.md) -- [TransactionCreatedTime](docs/v2/models/TransactionCreatedTime.md) -- [TransactionDict](docs/v2/models/TransactionDict.md) -- [TransactionRid](docs/v2/models/TransactionRid.md) -- [TransactionStatus](docs/v2/models/TransactionStatus.md) -- [TransactionType](docs/v2/models/TransactionType.md) -- [TrashedStatus](docs/v2/models/TrashedStatus.md) -- [Trigger](docs/v2/models/Trigger.md) -- [TriggerDict](docs/v2/models/TriggerDict.md) - [TwoDimensionalAggregation](docs/v2/models/TwoDimensionalAggregation.md) - [TwoDimensionalAggregationDict](docs/v2/models/TwoDimensionalAggregationDict.md) - [UnevaluableConstraint](docs/v2/models/UnevaluableConstraint.md) - [UnevaluableConstraintDict](docs/v2/models/UnevaluableConstraintDict.md) -- [UnsupportedType](docs/v2/models/UnsupportedType.md) -- [UnsupportedTypeDict](docs/v2/models/UnsupportedTypeDict.md) -- [UpdatedBy](docs/v2/models/UpdatedBy.md) -- [UpdatedTime](docs/v2/models/UpdatedTime.md) -- [UpstreamTarget](docs/v2/models/UpstreamTarget.md) -- [UpstreamTargetDict](docs/v2/models/UpstreamTargetDict.md) -- [User](docs/v2/models/User.md) -- [UserDict](docs/v2/models/UserDict.md) -- [UserId](docs/v2/models/UserId.md) -- [UserScope](docs/v2/models/UserScope.md) -- [UserScopeDict](docs/v2/models/UserScopeDict.md) -- [UserSearchFilter](docs/v2/models/UserSearchFilter.md) -- [UserSearchFilterDict](docs/v2/models/UserSearchFilterDict.md) -- [UserUsername](docs/v2/models/UserUsername.md) -- [ValidateActionRequest](docs/v2/models/ValidateActionRequest.md) -- [ValidateActionRequestDict](docs/v2/models/ValidateActionRequestDict.md) -- [ValidateActionResponse](docs/v2/models/ValidateActionResponse.md) -- [ValidateActionResponseDict](docs/v2/models/ValidateActionResponseDict.md) - [ValidateActionResponseV2](docs/v2/models/ValidateActionResponseV2.md) - [ValidateActionResponseV2Dict](docs/v2/models/ValidateActionResponseV2Dict.md) - [ValidationResult](docs/v2/models/ValidationResult.md) -- [ValueType](docs/v2/models/ValueType.md) -- [Version](docs/v2/models/Version.md) -- [VersionDict](docs/v2/models/VersionDict.md) -- [VersionVersion](docs/v2/models/VersionVersion.md) -- [Website](docs/v2/models/Website.md) -- [WebsiteDict](docs/v2/models/WebsiteDict.md) - [WithinBoundingBoxPoint](docs/v2/models/WithinBoundingBoxPoint.md) - [WithinBoundingBoxPointDict](docs/v2/models/WithinBoundingBoxPointDict.md) - [WithinBoundingBoxQuery](docs/v2/models/WithinBoundingBoxQuery.md) @@ -1326,479 +921,240 @@ Namespace | Resource | Operation | HTTP request | - [WithinDistanceOfQueryDict](docs/v2/models/WithinDistanceOfQueryDict.md) - [WithinPolygonQuery](docs/v2/models/WithinPolygonQuery.md) - [WithinPolygonQueryDict](docs/v2/models/WithinPolygonQueryDict.md) +- [AbortOnFailure](docs/v2/models/AbortOnFailure.md) +- [Action](docs/v2/models/Action.md) +- [ActionDict](docs/v2/models/ActionDict.md) +- [AndTrigger](docs/v2/models/AndTrigger.md) +- [AndTriggerDict](docs/v2/models/AndTriggerDict.md) +- [Build](docs/v2/models/Build.md) +- [BuildDict](docs/v2/models/BuildDict.md) +- [BuildRid](docs/v2/models/BuildRid.md) +- [BuildStatus](docs/v2/models/BuildStatus.md) +- [BuildTarget](docs/v2/models/BuildTarget.md) +- [BuildTargetDict](docs/v2/models/BuildTargetDict.md) +- [ConnectingTarget](docs/v2/models/ConnectingTarget.md) +- [ConnectingTargetDict](docs/v2/models/ConnectingTargetDict.md) +- [CronExpression](docs/v2/models/CronExpression.md) +- [DatasetUpdatedTrigger](docs/v2/models/DatasetUpdatedTrigger.md) +- [DatasetUpdatedTriggerDict](docs/v2/models/DatasetUpdatedTriggerDict.md) +- [FallbackBranches](docs/v2/models/FallbackBranches.md) +- [ForceBuild](docs/v2/models/ForceBuild.md) +- [JobSucceededTrigger](docs/v2/models/JobSucceededTrigger.md) +- [JobSucceededTriggerDict](docs/v2/models/JobSucceededTriggerDict.md) +- [ManualTarget](docs/v2/models/ManualTarget.md) +- [ManualTargetDict](docs/v2/models/ManualTargetDict.md) +- [MediaSetUpdatedTrigger](docs/v2/models/MediaSetUpdatedTrigger.md) +- [MediaSetUpdatedTriggerDict](docs/v2/models/MediaSetUpdatedTriggerDict.md) +- [NewLogicTrigger](docs/v2/models/NewLogicTrigger.md) +- [NewLogicTriggerDict](docs/v2/models/NewLogicTriggerDict.md) +- [NotificationsEnabled](docs/v2/models/NotificationsEnabled.md) +- [OrTrigger](docs/v2/models/OrTrigger.md) +- [OrTriggerDict](docs/v2/models/OrTriggerDict.md) +- [ProjectScope](docs/v2/models/ProjectScope.md) +- [ProjectScopeDict](docs/v2/models/ProjectScopeDict.md) +- [RetryBackoffDuration](docs/v2/models/RetryBackoffDuration.md) +- [RetryBackoffDurationDict](docs/v2/models/RetryBackoffDurationDict.md) +- [RetryCount](docs/v2/models/RetryCount.md) +- [Schedule](docs/v2/models/Schedule.md) +- [ScheduleDict](docs/v2/models/ScheduleDict.md) +- [SchedulePaused](docs/v2/models/SchedulePaused.md) +- [ScheduleRid](docs/v2/models/ScheduleRid.md) +- [ScheduleRun](docs/v2/models/ScheduleRun.md) +- [ScheduleRunDict](docs/v2/models/ScheduleRunDict.md) +- [ScheduleRunError](docs/v2/models/ScheduleRunError.md) +- [ScheduleRunErrorDict](docs/v2/models/ScheduleRunErrorDict.md) +- [ScheduleRunErrorName](docs/v2/models/ScheduleRunErrorName.md) +- [ScheduleRunIgnored](docs/v2/models/ScheduleRunIgnored.md) +- [ScheduleRunIgnoredDict](docs/v2/models/ScheduleRunIgnoredDict.md) +- [ScheduleRunResult](docs/v2/models/ScheduleRunResult.md) +- [ScheduleRunResultDict](docs/v2/models/ScheduleRunResultDict.md) +- [ScheduleRunRid](docs/v2/models/ScheduleRunRid.md) +- [ScheduleRunSubmitted](docs/v2/models/ScheduleRunSubmitted.md) +- [ScheduleRunSubmittedDict](docs/v2/models/ScheduleRunSubmittedDict.md) +- [ScheduleSucceededTrigger](docs/v2/models/ScheduleSucceededTrigger.md) +- [ScheduleSucceededTriggerDict](docs/v2/models/ScheduleSucceededTriggerDict.md) +- [ScheduleVersionRid](docs/v2/models/ScheduleVersionRid.md) +- [ScopeMode](docs/v2/models/ScopeMode.md) +- [ScopeModeDict](docs/v2/models/ScopeModeDict.md) +- [TimeTrigger](docs/v2/models/TimeTrigger.md) +- [TimeTriggerDict](docs/v2/models/TimeTriggerDict.md) +- [Trigger](docs/v2/models/Trigger.md) +- [TriggerDict](docs/v2/models/TriggerDict.md) +- [UpstreamTarget](docs/v2/models/UpstreamTarget.md) +- [UpstreamTargetDict](docs/v2/models/UpstreamTargetDict.md) +- [UserScope](docs/v2/models/UserScope.md) +- [UserScopeDict](docs/v2/models/UserScopeDict.md) - [ZoneId](docs/v2/models/ZoneId.md) +- [ListVersionsResponse](docs/v2/models/ListVersionsResponse.md) +- [ListVersionsResponseDict](docs/v2/models/ListVersionsResponseDict.md) +- [Subdomain](docs/v2/models/Subdomain.md) +- [ThirdPartyApplication](docs/v2/models/ThirdPartyApplication.md) +- [ThirdPartyApplicationDict](docs/v2/models/ThirdPartyApplicationDict.md) +- [ThirdPartyApplicationRid](docs/v2/models/ThirdPartyApplicationRid.md) +- [Version](docs/v2/models/Version.md) +- [VersionDict](docs/v2/models/VersionDict.md) +- [VersionVersion](docs/v2/models/VersionVersion.md) +- [Website](docs/v2/models/Website.md) +- [WebsiteDict](docs/v2/models/WebsiteDict.md) ## Documentation for V1 models -- [AbsoluteTimeRange](docs/v1/models/AbsoluteTimeRange.md) -- [AbsoluteTimeRangeDict](docs/v1/models/AbsoluteTimeRangeDict.md) -- [ActionMode](docs/v1/models/ActionMode.md) -- [ActionParameterArrayType](docs/v1/models/ActionParameterArrayType.md) -- [ActionParameterArrayTypeDict](docs/v1/models/ActionParameterArrayTypeDict.md) -- [ActionParameterType](docs/v1/models/ActionParameterType.md) -- [ActionParameterTypeDict](docs/v1/models/ActionParameterTypeDict.md) -- [ActionParameterV2](docs/v1/models/ActionParameterV2.md) -- [ActionParameterV2Dict](docs/v1/models/ActionParameterV2Dict.md) -- [ActionResults](docs/v1/models/ActionResults.md) -- [ActionResultsDict](docs/v1/models/ActionResultsDict.md) -- [ActionRid](docs/v1/models/ActionRid.md) +- [AnyType](docs/v1/models/AnyType.md) +- [AnyTypeDict](docs/v1/models/AnyTypeDict.md) +- [BinaryType](docs/v1/models/BinaryType.md) +- [BinaryTypeDict](docs/v1/models/BinaryTypeDict.md) +- [BooleanType](docs/v1/models/BooleanType.md) +- [BooleanTypeDict](docs/v1/models/BooleanTypeDict.md) +- [ByteType](docs/v1/models/ByteType.md) +- [ByteTypeDict](docs/v1/models/ByteTypeDict.md) +- [DateType](docs/v1/models/DateType.md) +- [DateTypeDict](docs/v1/models/DateTypeDict.md) +- [DecimalType](docs/v1/models/DecimalType.md) +- [DecimalTypeDict](docs/v1/models/DecimalTypeDict.md) +- [DisplayName](docs/v1/models/DisplayName.md) +- [DoubleType](docs/v1/models/DoubleType.md) +- [DoubleTypeDict](docs/v1/models/DoubleTypeDict.md) +- [Duration](docs/v1/models/Duration.md) +- [FilePath](docs/v1/models/FilePath.md) +- [FloatType](docs/v1/models/FloatType.md) +- [FloatTypeDict](docs/v1/models/FloatTypeDict.md) +- [FolderRid](docs/v1/models/FolderRid.md) +- [IntegerType](docs/v1/models/IntegerType.md) +- [IntegerTypeDict](docs/v1/models/IntegerTypeDict.md) +- [LongType](docs/v1/models/LongType.md) +- [LongTypeDict](docs/v1/models/LongTypeDict.md) +- [MarkingType](docs/v1/models/MarkingType.md) +- [MarkingTypeDict](docs/v1/models/MarkingTypeDict.md) +- [PageSize](docs/v1/models/PageSize.md) +- [PageToken](docs/v1/models/PageToken.md) +- [PreviewMode](docs/v1/models/PreviewMode.md) +- [ReleaseStatus](docs/v1/models/ReleaseStatus.md) +- [ShortType](docs/v1/models/ShortType.md) +- [ShortTypeDict](docs/v1/models/ShortTypeDict.md) +- [StringType](docs/v1/models/StringType.md) +- [StringTypeDict](docs/v1/models/StringTypeDict.md) +- [StructFieldName](docs/v1/models/StructFieldName.md) +- [TimestampType](docs/v1/models/TimestampType.md) +- [TimestampTypeDict](docs/v1/models/TimestampTypeDict.md) +- [TotalCount](docs/v1/models/TotalCount.md) +- [UnsupportedType](docs/v1/models/UnsupportedType.md) +- [UnsupportedTypeDict](docs/v1/models/UnsupportedTypeDict.md) +- [Branch](docs/v1/models/Branch.md) +- [BranchDict](docs/v1/models/BranchDict.md) +- [BranchId](docs/v1/models/BranchId.md) +- [Dataset](docs/v1/models/Dataset.md) +- [DatasetDict](docs/v1/models/DatasetDict.md) +- [DatasetName](docs/v1/models/DatasetName.md) +- [DatasetRid](docs/v1/models/DatasetRid.md) +- [File](docs/v1/models/File.md) +- [FileDict](docs/v1/models/FileDict.md) +- [ListBranchesResponse](docs/v1/models/ListBranchesResponse.md) +- [ListBranchesResponseDict](docs/v1/models/ListBranchesResponseDict.md) +- [ListFilesResponse](docs/v1/models/ListFilesResponse.md) +- [ListFilesResponseDict](docs/v1/models/ListFilesResponseDict.md) +- [TableExportFormat](docs/v1/models/TableExportFormat.md) +- [Transaction](docs/v1/models/Transaction.md) +- [TransactionDict](docs/v1/models/TransactionDict.md) +- [TransactionRid](docs/v1/models/TransactionRid.md) +- [TransactionStatus](docs/v1/models/TransactionStatus.md) +- [TransactionType](docs/v1/models/TransactionType.md) - [ActionType](docs/v1/models/ActionType.md) - [ActionTypeApiName](docs/v1/models/ActionTypeApiName.md) - [ActionTypeDict](docs/v1/models/ActionTypeDict.md) - [ActionTypeRid](docs/v1/models/ActionTypeRid.md) -- [ActionTypeV2](docs/v1/models/ActionTypeV2.md) -- [ActionTypeV2Dict](docs/v1/models/ActionTypeV2Dict.md) -- [AddLink](docs/v1/models/AddLink.md) -- [AddLinkDict](docs/v1/models/AddLinkDict.md) -- [AddObject](docs/v1/models/AddObject.md) -- [AddObjectDict](docs/v1/models/AddObjectDict.md) -- [AggregateObjectSetRequestV2](docs/v1/models/AggregateObjectSetRequestV2.md) -- [AggregateObjectSetRequestV2Dict](docs/v1/models/AggregateObjectSetRequestV2Dict.md) -- [AggregateObjectsRequest](docs/v1/models/AggregateObjectsRequest.md) -- [AggregateObjectsRequestDict](docs/v1/models/AggregateObjectsRequestDict.md) -- [AggregateObjectsRequestV2](docs/v1/models/AggregateObjectsRequestV2.md) -- [AggregateObjectsRequestV2Dict](docs/v1/models/AggregateObjectsRequestV2Dict.md) - [AggregateObjectsResponse](docs/v1/models/AggregateObjectsResponse.md) - [AggregateObjectsResponseDict](docs/v1/models/AggregateObjectsResponseDict.md) - [AggregateObjectsResponseItem](docs/v1/models/AggregateObjectsResponseItem.md) - [AggregateObjectsResponseItemDict](docs/v1/models/AggregateObjectsResponseItemDict.md) -- [AggregateObjectsResponseItemV2](docs/v1/models/AggregateObjectsResponseItemV2.md) -- [AggregateObjectsResponseItemV2Dict](docs/v1/models/AggregateObjectsResponseItemV2Dict.md) -- [AggregateObjectsResponseV2](docs/v1/models/AggregateObjectsResponseV2.md) -- [AggregateObjectsResponseV2Dict](docs/v1/models/AggregateObjectsResponseV2Dict.md) -- [Aggregation](docs/v1/models/Aggregation.md) -- [AggregationAccuracy](docs/v1/models/AggregationAccuracy.md) -- [AggregationAccuracyRequest](docs/v1/models/AggregationAccuracyRequest.md) - [AggregationDict](docs/v1/models/AggregationDict.md) -- [AggregationDurationGrouping](docs/v1/models/AggregationDurationGrouping.md) - [AggregationDurationGroupingDict](docs/v1/models/AggregationDurationGroupingDict.md) -- [AggregationDurationGroupingV2](docs/v1/models/AggregationDurationGroupingV2.md) -- [AggregationDurationGroupingV2Dict](docs/v1/models/AggregationDurationGroupingV2Dict.md) -- [AggregationExactGrouping](docs/v1/models/AggregationExactGrouping.md) - [AggregationExactGroupingDict](docs/v1/models/AggregationExactGroupingDict.md) -- [AggregationExactGroupingV2](docs/v1/models/AggregationExactGroupingV2.md) -- [AggregationExactGroupingV2Dict](docs/v1/models/AggregationExactGroupingV2Dict.md) -- [AggregationFixedWidthGrouping](docs/v1/models/AggregationFixedWidthGrouping.md) - [AggregationFixedWidthGroupingDict](docs/v1/models/AggregationFixedWidthGroupingDict.md) -- [AggregationFixedWidthGroupingV2](docs/v1/models/AggregationFixedWidthGroupingV2.md) -- [AggregationFixedWidthGroupingV2Dict](docs/v1/models/AggregationFixedWidthGroupingV2Dict.md) -- [AggregationGroupBy](docs/v1/models/AggregationGroupBy.md) - [AggregationGroupByDict](docs/v1/models/AggregationGroupByDict.md) -- [AggregationGroupByV2](docs/v1/models/AggregationGroupByV2.md) -- [AggregationGroupByV2Dict](docs/v1/models/AggregationGroupByV2Dict.md) - [AggregationGroupKey](docs/v1/models/AggregationGroupKey.md) -- [AggregationGroupKeyV2](docs/v1/models/AggregationGroupKeyV2.md) - [AggregationGroupValue](docs/v1/models/AggregationGroupValue.md) -- [AggregationGroupValueV2](docs/v1/models/AggregationGroupValueV2.md) - [AggregationMetricName](docs/v1/models/AggregationMetricName.md) - [AggregationMetricResult](docs/v1/models/AggregationMetricResult.md) - [AggregationMetricResultDict](docs/v1/models/AggregationMetricResultDict.md) -- [AggregationMetricResultV2](docs/v1/models/AggregationMetricResultV2.md) -- [AggregationMetricResultV2Dict](docs/v1/models/AggregationMetricResultV2Dict.md) -- [AggregationObjectTypeGrouping](docs/v1/models/AggregationObjectTypeGrouping.md) -- [AggregationObjectTypeGroupingDict](docs/v1/models/AggregationObjectTypeGroupingDict.md) -- [AggregationOrderBy](docs/v1/models/AggregationOrderBy.md) -- [AggregationOrderByDict](docs/v1/models/AggregationOrderByDict.md) -- [AggregationRange](docs/v1/models/AggregationRange.md) - [AggregationRangeDict](docs/v1/models/AggregationRangeDict.md) -- [AggregationRangesGrouping](docs/v1/models/AggregationRangesGrouping.md) - [AggregationRangesGroupingDict](docs/v1/models/AggregationRangesGroupingDict.md) -- [AggregationRangesGroupingV2](docs/v1/models/AggregationRangesGroupingV2.md) -- [AggregationRangesGroupingV2Dict](docs/v1/models/AggregationRangesGroupingV2Dict.md) -- [AggregationRangeV2](docs/v1/models/AggregationRangeV2.md) -- [AggregationRangeV2Dict](docs/v1/models/AggregationRangeV2Dict.md) -- [AggregationV2](docs/v1/models/AggregationV2.md) -- [AggregationV2Dict](docs/v1/models/AggregationV2Dict.md) -- [AllTermsQuery](docs/v1/models/AllTermsQuery.md) - [AllTermsQueryDict](docs/v1/models/AllTermsQueryDict.md) -- [AndQuery](docs/v1/models/AndQuery.md) - [AndQueryDict](docs/v1/models/AndQueryDict.md) -- [AndQueryV2](docs/v1/models/AndQueryV2.md) -- [AndQueryV2Dict](docs/v1/models/AndQueryV2Dict.md) -- [AnyTermQuery](docs/v1/models/AnyTermQuery.md) - [AnyTermQueryDict](docs/v1/models/AnyTermQueryDict.md) -- [AnyType](docs/v1/models/AnyType.md) -- [AnyTypeDict](docs/v1/models/AnyTypeDict.md) -- [ApplyActionMode](docs/v1/models/ApplyActionMode.md) -- [ApplyActionRequest](docs/v1/models/ApplyActionRequest.md) - [ApplyActionRequestDict](docs/v1/models/ApplyActionRequestDict.md) -- [ApplyActionRequestOptions](docs/v1/models/ApplyActionRequestOptions.md) -- [ApplyActionRequestOptionsDict](docs/v1/models/ApplyActionRequestOptionsDict.md) -- [ApplyActionRequestV2](docs/v1/models/ApplyActionRequestV2.md) -- [ApplyActionRequestV2Dict](docs/v1/models/ApplyActionRequestV2Dict.md) - [ApplyActionResponse](docs/v1/models/ApplyActionResponse.md) - [ApplyActionResponseDict](docs/v1/models/ApplyActionResponseDict.md) -- [ApproximateDistinctAggregation](docs/v1/models/ApproximateDistinctAggregation.md) - [ApproximateDistinctAggregationDict](docs/v1/models/ApproximateDistinctAggregationDict.md) -- [ApproximateDistinctAggregationV2](docs/v1/models/ApproximateDistinctAggregationV2.md) -- [ApproximateDistinctAggregationV2Dict](docs/v1/models/ApproximateDistinctAggregationV2Dict.md) -- [ApproximatePercentileAggregationV2](docs/v1/models/ApproximatePercentileAggregationV2.md) -- [ApproximatePercentileAggregationV2Dict](docs/v1/models/ApproximatePercentileAggregationV2Dict.md) -- [ArchiveFileFormat](docs/v1/models/ArchiveFileFormat.md) -- [Arg](docs/v1/models/Arg.md) -- [ArgDict](docs/v1/models/ArgDict.md) - [ArraySizeConstraint](docs/v1/models/ArraySizeConstraint.md) - [ArraySizeConstraintDict](docs/v1/models/ArraySizeConstraintDict.md) -- [ArtifactRepositoryRid](docs/v1/models/ArtifactRepositoryRid.md) -- [AsyncActionStatus](docs/v1/models/AsyncActionStatus.md) -- [AsyncApplyActionOperationResponseV2](docs/v1/models/AsyncApplyActionOperationResponseV2.md) -- [AsyncApplyActionOperationResponseV2Dict](docs/v1/models/AsyncApplyActionOperationResponseV2Dict.md) -- [AsyncApplyActionRequest](docs/v1/models/AsyncApplyActionRequest.md) -- [AsyncApplyActionRequestDict](docs/v1/models/AsyncApplyActionRequestDict.md) -- [AsyncApplyActionRequestV2](docs/v1/models/AsyncApplyActionRequestV2.md) -- [AsyncApplyActionRequestV2Dict](docs/v1/models/AsyncApplyActionRequestV2Dict.md) -- [AsyncApplyActionResponse](docs/v1/models/AsyncApplyActionResponse.md) -- [AsyncApplyActionResponseDict](docs/v1/models/AsyncApplyActionResponseDict.md) -- [AsyncApplyActionResponseV2](docs/v1/models/AsyncApplyActionResponseV2.md) -- [AsyncApplyActionResponseV2Dict](docs/v1/models/AsyncApplyActionResponseV2Dict.md) -- [Attachment](docs/v1/models/Attachment.md) -- [AttachmentDict](docs/v1/models/AttachmentDict.md) -- [AttachmentMetadataResponse](docs/v1/models/AttachmentMetadataResponse.md) -- [AttachmentMetadataResponseDict](docs/v1/models/AttachmentMetadataResponseDict.md) -- [AttachmentProperty](docs/v1/models/AttachmentProperty.md) -- [AttachmentPropertyDict](docs/v1/models/AttachmentPropertyDict.md) -- [AttachmentRid](docs/v1/models/AttachmentRid.md) -- [AttachmentType](docs/v1/models/AttachmentType.md) -- [AttachmentTypeDict](docs/v1/models/AttachmentTypeDict.md) -- [AttachmentV2](docs/v1/models/AttachmentV2.md) -- [AttachmentV2Dict](docs/v1/models/AttachmentV2Dict.md) -- [AvgAggregation](docs/v1/models/AvgAggregation.md) - [AvgAggregationDict](docs/v1/models/AvgAggregationDict.md) -- [AvgAggregationV2](docs/v1/models/AvgAggregationV2.md) -- [AvgAggregationV2Dict](docs/v1/models/AvgAggregationV2Dict.md) -- [BatchApplyActionRequest](docs/v1/models/BatchApplyActionRequest.md) -- [BatchApplyActionRequestDict](docs/v1/models/BatchApplyActionRequestDict.md) -- [BatchApplyActionRequestItem](docs/v1/models/BatchApplyActionRequestItem.md) -- [BatchApplyActionRequestItemDict](docs/v1/models/BatchApplyActionRequestItemDict.md) -- [BatchApplyActionRequestOptions](docs/v1/models/BatchApplyActionRequestOptions.md) -- [BatchApplyActionRequestOptionsDict](docs/v1/models/BatchApplyActionRequestOptionsDict.md) -- [BatchApplyActionRequestV2](docs/v1/models/BatchApplyActionRequestV2.md) -- [BatchApplyActionRequestV2Dict](docs/v1/models/BatchApplyActionRequestV2Dict.md) - [BatchApplyActionResponse](docs/v1/models/BatchApplyActionResponse.md) - [BatchApplyActionResponseDict](docs/v1/models/BatchApplyActionResponseDict.md) -- [BatchApplyActionResponseV2](docs/v1/models/BatchApplyActionResponseV2.md) -- [BatchApplyActionResponseV2Dict](docs/v1/models/BatchApplyActionResponseV2Dict.md) -- [BBox](docs/v1/models/BBox.md) -- [BinaryType](docs/v1/models/BinaryType.md) -- [BinaryTypeDict](docs/v1/models/BinaryTypeDict.md) -- [BlueprintIcon](docs/v1/models/BlueprintIcon.md) -- [BlueprintIconDict](docs/v1/models/BlueprintIconDict.md) -- [BooleanType](docs/v1/models/BooleanType.md) -- [BooleanTypeDict](docs/v1/models/BooleanTypeDict.md) -- [BoundingBoxValue](docs/v1/models/BoundingBoxValue.md) -- [BoundingBoxValueDict](docs/v1/models/BoundingBoxValueDict.md) -- [Branch](docs/v1/models/Branch.md) -- [BranchDict](docs/v1/models/BranchDict.md) -- [BranchId](docs/v1/models/BranchId.md) -- [ByteType](docs/v1/models/ByteType.md) -- [ByteTypeDict](docs/v1/models/ByteTypeDict.md) -- [CenterPoint](docs/v1/models/CenterPoint.md) -- [CenterPointDict](docs/v1/models/CenterPointDict.md) -- [CenterPointTypes](docs/v1/models/CenterPointTypes.md) -- [CenterPointTypesDict](docs/v1/models/CenterPointTypesDict.md) -- [ContainsAllTermsInOrderPrefixLastTerm](docs/v1/models/ContainsAllTermsInOrderPrefixLastTerm.md) -- [ContainsAllTermsInOrderPrefixLastTermDict](docs/v1/models/ContainsAllTermsInOrderPrefixLastTermDict.md) -- [ContainsAllTermsInOrderQuery](docs/v1/models/ContainsAllTermsInOrderQuery.md) -- [ContainsAllTermsInOrderQueryDict](docs/v1/models/ContainsAllTermsInOrderQueryDict.md) -- [ContainsAllTermsQuery](docs/v1/models/ContainsAllTermsQuery.md) -- [ContainsAllTermsQueryDict](docs/v1/models/ContainsAllTermsQueryDict.md) -- [ContainsAnyTermQuery](docs/v1/models/ContainsAnyTermQuery.md) -- [ContainsAnyTermQueryDict](docs/v1/models/ContainsAnyTermQueryDict.md) -- [ContainsQuery](docs/v1/models/ContainsQuery.md) - [ContainsQueryDict](docs/v1/models/ContainsQueryDict.md) -- [ContainsQueryV2](docs/v1/models/ContainsQueryV2.md) -- [ContainsQueryV2Dict](docs/v1/models/ContainsQueryV2Dict.md) -- [ContentLength](docs/v1/models/ContentLength.md) -- [ContentType](docs/v1/models/ContentType.md) -- [Coordinate](docs/v1/models/Coordinate.md) -- [CountAggregation](docs/v1/models/CountAggregation.md) - [CountAggregationDict](docs/v1/models/CountAggregationDict.md) -- [CountAggregationV2](docs/v1/models/CountAggregationV2.md) -- [CountAggregationV2Dict](docs/v1/models/CountAggregationV2Dict.md) -- [CountObjectsResponseV2](docs/v1/models/CountObjectsResponseV2.md) -- [CountObjectsResponseV2Dict](docs/v1/models/CountObjectsResponseV2Dict.md) -- [CreateBranchRequest](docs/v1/models/CreateBranchRequest.md) -- [CreateBranchRequestDict](docs/v1/models/CreateBranchRequestDict.md) -- [CreateDatasetRequest](docs/v1/models/CreateDatasetRequest.md) -- [CreateDatasetRequestDict](docs/v1/models/CreateDatasetRequestDict.md) -- [CreatedTime](docs/v1/models/CreatedTime.md) +- [CreateInterfaceObjectRule](docs/v1/models/CreateInterfaceObjectRule.md) +- [CreateInterfaceObjectRuleDict](docs/v1/models/CreateInterfaceObjectRuleDict.md) - [CreateLinkRule](docs/v1/models/CreateLinkRule.md) - [CreateLinkRuleDict](docs/v1/models/CreateLinkRuleDict.md) - [CreateObjectRule](docs/v1/models/CreateObjectRule.md) - [CreateObjectRuleDict](docs/v1/models/CreateObjectRuleDict.md) -- [CreateTemporaryObjectSetRequestV2](docs/v1/models/CreateTemporaryObjectSetRequestV2.md) -- [CreateTemporaryObjectSetRequestV2Dict](docs/v1/models/CreateTemporaryObjectSetRequestV2Dict.md) -- [CreateTemporaryObjectSetResponseV2](docs/v1/models/CreateTemporaryObjectSetResponseV2.md) -- [CreateTemporaryObjectSetResponseV2Dict](docs/v1/models/CreateTemporaryObjectSetResponseV2Dict.md) -- [CreateTransactionRequest](docs/v1/models/CreateTransactionRequest.md) -- [CreateTransactionRequestDict](docs/v1/models/CreateTransactionRequestDict.md) -- [CustomTypeId](docs/v1/models/CustomTypeId.md) -- [Dataset](docs/v1/models/Dataset.md) -- [DatasetDict](docs/v1/models/DatasetDict.md) -- [DatasetName](docs/v1/models/DatasetName.md) -- [DatasetRid](docs/v1/models/DatasetRid.md) - [DataValue](docs/v1/models/DataValue.md) -- [DateType](docs/v1/models/DateType.md) -- [DateTypeDict](docs/v1/models/DateTypeDict.md) -- [DecimalType](docs/v1/models/DecimalType.md) -- [DecimalTypeDict](docs/v1/models/DecimalTypeDict.md) - [DeleteLinkRule](docs/v1/models/DeleteLinkRule.md) - [DeleteLinkRuleDict](docs/v1/models/DeleteLinkRuleDict.md) - [DeleteObjectRule](docs/v1/models/DeleteObjectRule.md) - [DeleteObjectRuleDict](docs/v1/models/DeleteObjectRuleDict.md) -- [DisplayName](docs/v1/models/DisplayName.md) -- [Distance](docs/v1/models/Distance.md) -- [DistanceDict](docs/v1/models/DistanceDict.md) -- [DistanceUnit](docs/v1/models/DistanceUnit.md) -- [DoesNotIntersectBoundingBoxQuery](docs/v1/models/DoesNotIntersectBoundingBoxQuery.md) -- [DoesNotIntersectBoundingBoxQueryDict](docs/v1/models/DoesNotIntersectBoundingBoxQueryDict.md) -- [DoesNotIntersectPolygonQuery](docs/v1/models/DoesNotIntersectPolygonQuery.md) -- [DoesNotIntersectPolygonQueryDict](docs/v1/models/DoesNotIntersectPolygonQueryDict.md) -- [DoubleType](docs/v1/models/DoubleType.md) -- [DoubleTypeDict](docs/v1/models/DoubleTypeDict.md) -- [Duration](docs/v1/models/Duration.md) -- [EqualsQuery](docs/v1/models/EqualsQuery.md) - [EqualsQueryDict](docs/v1/models/EqualsQueryDict.md) -- [EqualsQueryV2](docs/v1/models/EqualsQueryV2.md) -- [EqualsQueryV2Dict](docs/v1/models/EqualsQueryV2Dict.md) -- [Error](docs/v1/models/Error.md) -- [ErrorDict](docs/v1/models/ErrorDict.md) -- [ErrorName](docs/v1/models/ErrorName.md) -- [ExactDistinctAggregationV2](docs/v1/models/ExactDistinctAggregationV2.md) -- [ExactDistinctAggregationV2Dict](docs/v1/models/ExactDistinctAggregationV2Dict.md) -- [ExecuteQueryRequest](docs/v1/models/ExecuteQueryRequest.md) -- [ExecuteQueryRequestDict](docs/v1/models/ExecuteQueryRequestDict.md) - [ExecuteQueryResponse](docs/v1/models/ExecuteQueryResponse.md) - [ExecuteQueryResponseDict](docs/v1/models/ExecuteQueryResponseDict.md) -- [Feature](docs/v1/models/Feature.md) -- [FeatureCollection](docs/v1/models/FeatureCollection.md) -- [FeatureCollectionDict](docs/v1/models/FeatureCollectionDict.md) -- [FeatureCollectionTypes](docs/v1/models/FeatureCollectionTypes.md) -- [FeatureCollectionTypesDict](docs/v1/models/FeatureCollectionTypesDict.md) -- [FeatureDict](docs/v1/models/FeatureDict.md) -- [FeaturePropertyKey](docs/v1/models/FeaturePropertyKey.md) - [FieldNameV1](docs/v1/models/FieldNameV1.md) -- [File](docs/v1/models/File.md) -- [FileDict](docs/v1/models/FileDict.md) -- [Filename](docs/v1/models/Filename.md) -- [FilePath](docs/v1/models/FilePath.md) -- [FilesystemResource](docs/v1/models/FilesystemResource.md) -- [FilesystemResourceDict](docs/v1/models/FilesystemResourceDict.md) -- [FilterValue](docs/v1/models/FilterValue.md) -- [FloatType](docs/v1/models/FloatType.md) -- [FloatTypeDict](docs/v1/models/FloatTypeDict.md) -- [FolderRid](docs/v1/models/FolderRid.md) - [FunctionRid](docs/v1/models/FunctionRid.md) - [FunctionVersion](docs/v1/models/FunctionVersion.md) - [Fuzzy](docs/v1/models/Fuzzy.md) -- [FuzzyV2](docs/v1/models/FuzzyV2.md) -- [GeoJsonObject](docs/v1/models/GeoJsonObject.md) -- [GeoJsonObjectDict](docs/v1/models/GeoJsonObjectDict.md) -- [Geometry](docs/v1/models/Geometry.md) -- [GeometryCollection](docs/v1/models/GeometryCollection.md) -- [GeometryCollectionDict](docs/v1/models/GeometryCollectionDict.md) -- [GeometryDict](docs/v1/models/GeometryDict.md) -- [GeoPoint](docs/v1/models/GeoPoint.md) -- [GeoPointDict](docs/v1/models/GeoPointDict.md) -- [GeoPointType](docs/v1/models/GeoPointType.md) -- [GeoPointTypeDict](docs/v1/models/GeoPointTypeDict.md) -- [GeoShapeType](docs/v1/models/GeoShapeType.md) -- [GeoShapeTypeDict](docs/v1/models/GeoShapeTypeDict.md) -- [GeotimeSeriesValue](docs/v1/models/GeotimeSeriesValue.md) -- [GeotimeSeriesValueDict](docs/v1/models/GeotimeSeriesValueDict.md) - [GroupMemberConstraint](docs/v1/models/GroupMemberConstraint.md) - [GroupMemberConstraintDict](docs/v1/models/GroupMemberConstraintDict.md) -- [GteQuery](docs/v1/models/GteQuery.md) - [GteQueryDict](docs/v1/models/GteQueryDict.md) -- [GteQueryV2](docs/v1/models/GteQueryV2.md) -- [GteQueryV2Dict](docs/v1/models/GteQueryV2Dict.md) -- [GtQuery](docs/v1/models/GtQuery.md) - [GtQueryDict](docs/v1/models/GtQueryDict.md) -- [GtQueryV2](docs/v1/models/GtQueryV2.md) -- [GtQueryV2Dict](docs/v1/models/GtQueryV2Dict.md) -- [Icon](docs/v1/models/Icon.md) -- [IconDict](docs/v1/models/IconDict.md) -- [IntegerType](docs/v1/models/IntegerType.md) -- [IntegerTypeDict](docs/v1/models/IntegerTypeDict.md) -- [InterfaceLinkType](docs/v1/models/InterfaceLinkType.md) -- [InterfaceLinkTypeApiName](docs/v1/models/InterfaceLinkTypeApiName.md) -- [InterfaceLinkTypeCardinality](docs/v1/models/InterfaceLinkTypeCardinality.md) -- [InterfaceLinkTypeDict](docs/v1/models/InterfaceLinkTypeDict.md) -- [InterfaceLinkTypeLinkedEntityApiName](docs/v1/models/InterfaceLinkTypeLinkedEntityApiName.md) -- [InterfaceLinkTypeLinkedEntityApiNameDict](docs/v1/models/InterfaceLinkTypeLinkedEntityApiNameDict.md) -- [InterfaceLinkTypeRid](docs/v1/models/InterfaceLinkTypeRid.md) -- [InterfaceType](docs/v1/models/InterfaceType.md) -- [InterfaceTypeApiName](docs/v1/models/InterfaceTypeApiName.md) -- [InterfaceTypeDict](docs/v1/models/InterfaceTypeDict.md) -- [InterfaceTypeRid](docs/v1/models/InterfaceTypeRid.md) -- [IntersectsBoundingBoxQuery](docs/v1/models/IntersectsBoundingBoxQuery.md) -- [IntersectsBoundingBoxQueryDict](docs/v1/models/IntersectsBoundingBoxQueryDict.md) -- [IntersectsPolygonQuery](docs/v1/models/IntersectsPolygonQuery.md) -- [IntersectsPolygonQueryDict](docs/v1/models/IntersectsPolygonQueryDict.md) -- [IsNullQuery](docs/v1/models/IsNullQuery.md) - [IsNullQueryDict](docs/v1/models/IsNullQueryDict.md) -- [IsNullQueryV2](docs/v1/models/IsNullQueryV2.md) -- [IsNullQueryV2Dict](docs/v1/models/IsNullQueryV2Dict.md) -- [LinearRing](docs/v1/models/LinearRing.md) -- [LineString](docs/v1/models/LineString.md) -- [LineStringCoordinates](docs/v1/models/LineStringCoordinates.md) -- [LineStringDict](docs/v1/models/LineStringDict.md) -- [LinkedInterfaceTypeApiName](docs/v1/models/LinkedInterfaceTypeApiName.md) -- [LinkedInterfaceTypeApiNameDict](docs/v1/models/LinkedInterfaceTypeApiNameDict.md) -- [LinkedObjectTypeApiName](docs/v1/models/LinkedObjectTypeApiName.md) -- [LinkedObjectTypeApiNameDict](docs/v1/models/LinkedObjectTypeApiNameDict.md) -- [LinkSideObject](docs/v1/models/LinkSideObject.md) -- [LinkSideObjectDict](docs/v1/models/LinkSideObjectDict.md) - [LinkTypeApiName](docs/v1/models/LinkTypeApiName.md) -- [LinkTypeRid](docs/v1/models/LinkTypeRid.md) - [LinkTypeSide](docs/v1/models/LinkTypeSide.md) - [LinkTypeSideCardinality](docs/v1/models/LinkTypeSideCardinality.md) - [LinkTypeSideDict](docs/v1/models/LinkTypeSideDict.md) -- [LinkTypeSideV2](docs/v1/models/LinkTypeSideV2.md) -- [LinkTypeSideV2Dict](docs/v1/models/LinkTypeSideV2Dict.md) - [ListActionTypesResponse](docs/v1/models/ListActionTypesResponse.md) - [ListActionTypesResponseDict](docs/v1/models/ListActionTypesResponseDict.md) -- [ListActionTypesResponseV2](docs/v1/models/ListActionTypesResponseV2.md) -- [ListActionTypesResponseV2Dict](docs/v1/models/ListActionTypesResponseV2Dict.md) -- [ListAttachmentsResponseV2](docs/v1/models/ListAttachmentsResponseV2.md) -- [ListAttachmentsResponseV2Dict](docs/v1/models/ListAttachmentsResponseV2Dict.md) -- [ListBranchesResponse](docs/v1/models/ListBranchesResponse.md) -- [ListBranchesResponseDict](docs/v1/models/ListBranchesResponseDict.md) -- [ListFilesResponse](docs/v1/models/ListFilesResponse.md) -- [ListFilesResponseDict](docs/v1/models/ListFilesResponseDict.md) -- [ListInterfaceTypesResponse](docs/v1/models/ListInterfaceTypesResponse.md) -- [ListInterfaceTypesResponseDict](docs/v1/models/ListInterfaceTypesResponseDict.md) - [ListLinkedObjectsResponse](docs/v1/models/ListLinkedObjectsResponse.md) - [ListLinkedObjectsResponseDict](docs/v1/models/ListLinkedObjectsResponseDict.md) -- [ListLinkedObjectsResponseV2](docs/v1/models/ListLinkedObjectsResponseV2.md) -- [ListLinkedObjectsResponseV2Dict](docs/v1/models/ListLinkedObjectsResponseV2Dict.md) - [ListObjectsResponse](docs/v1/models/ListObjectsResponse.md) - [ListObjectsResponseDict](docs/v1/models/ListObjectsResponseDict.md) -- [ListObjectsResponseV2](docs/v1/models/ListObjectsResponseV2.md) -- [ListObjectsResponseV2Dict](docs/v1/models/ListObjectsResponseV2Dict.md) - [ListObjectTypesResponse](docs/v1/models/ListObjectTypesResponse.md) - [ListObjectTypesResponseDict](docs/v1/models/ListObjectTypesResponseDict.md) -- [ListObjectTypesV2Response](docs/v1/models/ListObjectTypesV2Response.md) -- [ListObjectTypesV2ResponseDict](docs/v1/models/ListObjectTypesV2ResponseDict.md) - [ListOntologiesResponse](docs/v1/models/ListOntologiesResponse.md) - [ListOntologiesResponseDict](docs/v1/models/ListOntologiesResponseDict.md) -- [ListOntologiesV2Response](docs/v1/models/ListOntologiesV2Response.md) -- [ListOntologiesV2ResponseDict](docs/v1/models/ListOntologiesV2ResponseDict.md) - [ListOutgoingLinkTypesResponse](docs/v1/models/ListOutgoingLinkTypesResponse.md) - [ListOutgoingLinkTypesResponseDict](docs/v1/models/ListOutgoingLinkTypesResponseDict.md) -- [ListOutgoingLinkTypesResponseV2](docs/v1/models/ListOutgoingLinkTypesResponseV2.md) -- [ListOutgoingLinkTypesResponseV2Dict](docs/v1/models/ListOutgoingLinkTypesResponseV2Dict.md) - [ListQueryTypesResponse](docs/v1/models/ListQueryTypesResponse.md) - [ListQueryTypesResponseDict](docs/v1/models/ListQueryTypesResponseDict.md) -- [ListQueryTypesResponseV2](docs/v1/models/ListQueryTypesResponseV2.md) -- [ListQueryTypesResponseV2Dict](docs/v1/models/ListQueryTypesResponseV2Dict.md) -- [LoadObjectSetRequestV2](docs/v1/models/LoadObjectSetRequestV2.md) -- [LoadObjectSetRequestV2Dict](docs/v1/models/LoadObjectSetRequestV2Dict.md) -- [LoadObjectSetResponseV2](docs/v1/models/LoadObjectSetResponseV2.md) -- [LoadObjectSetResponseV2Dict](docs/v1/models/LoadObjectSetResponseV2Dict.md) -- [LocalFilePath](docs/v1/models/LocalFilePath.md) -- [LocalFilePathDict](docs/v1/models/LocalFilePathDict.md) - [LogicRule](docs/v1/models/LogicRule.md) - [LogicRuleDict](docs/v1/models/LogicRuleDict.md) -- [LongType](docs/v1/models/LongType.md) -- [LongTypeDict](docs/v1/models/LongTypeDict.md) -- [LteQuery](docs/v1/models/LteQuery.md) - [LteQueryDict](docs/v1/models/LteQueryDict.md) -- [LteQueryV2](docs/v1/models/LteQueryV2.md) -- [LteQueryV2Dict](docs/v1/models/LteQueryV2Dict.md) -- [LtQuery](docs/v1/models/LtQuery.md) - [LtQueryDict](docs/v1/models/LtQueryDict.md) -- [LtQueryV2](docs/v1/models/LtQueryV2.md) -- [LtQueryV2Dict](docs/v1/models/LtQueryV2Dict.md) -- [MarkingType](docs/v1/models/MarkingType.md) -- [MarkingTypeDict](docs/v1/models/MarkingTypeDict.md) -- [MaxAggregation](docs/v1/models/MaxAggregation.md) - [MaxAggregationDict](docs/v1/models/MaxAggregationDict.md) -- [MaxAggregationV2](docs/v1/models/MaxAggregationV2.md) -- [MaxAggregationV2Dict](docs/v1/models/MaxAggregationV2Dict.md) -- [MediaType](docs/v1/models/MediaType.md) -- [MinAggregation](docs/v1/models/MinAggregation.md) - [MinAggregationDict](docs/v1/models/MinAggregationDict.md) -- [MinAggregationV2](docs/v1/models/MinAggregationV2.md) -- [MinAggregationV2Dict](docs/v1/models/MinAggregationV2Dict.md) -- [ModifyObject](docs/v1/models/ModifyObject.md) -- [ModifyObjectDict](docs/v1/models/ModifyObjectDict.md) +- [ModifyInterfaceObjectRule](docs/v1/models/ModifyInterfaceObjectRule.md) +- [ModifyInterfaceObjectRuleDict](docs/v1/models/ModifyInterfaceObjectRuleDict.md) - [ModifyObjectRule](docs/v1/models/ModifyObjectRule.md) - [ModifyObjectRuleDict](docs/v1/models/ModifyObjectRuleDict.md) -- [MultiLineString](docs/v1/models/MultiLineString.md) -- [MultiLineStringDict](docs/v1/models/MultiLineStringDict.md) -- [MultiPoint](docs/v1/models/MultiPoint.md) -- [MultiPointDict](docs/v1/models/MultiPointDict.md) -- [MultiPolygon](docs/v1/models/MultiPolygon.md) -- [MultiPolygonDict](docs/v1/models/MultiPolygonDict.md) -- [NestedQueryAggregation](docs/v1/models/NestedQueryAggregation.md) -- [NestedQueryAggregationDict](docs/v1/models/NestedQueryAggregationDict.md) -- [NotQuery](docs/v1/models/NotQuery.md) - [NotQueryDict](docs/v1/models/NotQueryDict.md) -- [NotQueryV2](docs/v1/models/NotQueryV2.md) -- [NotQueryV2Dict](docs/v1/models/NotQueryV2Dict.md) -- [NullType](docs/v1/models/NullType.md) -- [NullTypeDict](docs/v1/models/NullTypeDict.md) -- [ObjectEdit](docs/v1/models/ObjectEdit.md) -- [ObjectEditDict](docs/v1/models/ObjectEditDict.md) -- [ObjectEdits](docs/v1/models/ObjectEdits.md) -- [ObjectEditsDict](docs/v1/models/ObjectEditsDict.md) -- [ObjectPrimaryKey](docs/v1/models/ObjectPrimaryKey.md) -- [ObjectPropertyType](docs/v1/models/ObjectPropertyType.md) -- [ObjectPropertyTypeDict](docs/v1/models/ObjectPropertyTypeDict.md) - [ObjectPropertyValueConstraint](docs/v1/models/ObjectPropertyValueConstraint.md) - [ObjectPropertyValueConstraintDict](docs/v1/models/ObjectPropertyValueConstraintDict.md) - [ObjectQueryResultConstraint](docs/v1/models/ObjectQueryResultConstraint.md) - [ObjectQueryResultConstraintDict](docs/v1/models/ObjectQueryResultConstraintDict.md) - [ObjectRid](docs/v1/models/ObjectRid.md) -- [ObjectSet](docs/v1/models/ObjectSet.md) -- [ObjectSetBaseType](docs/v1/models/ObjectSetBaseType.md) -- [ObjectSetBaseTypeDict](docs/v1/models/ObjectSetBaseTypeDict.md) -- [ObjectSetDict](docs/v1/models/ObjectSetDict.md) -- [ObjectSetFilterType](docs/v1/models/ObjectSetFilterType.md) -- [ObjectSetFilterTypeDict](docs/v1/models/ObjectSetFilterTypeDict.md) -- [ObjectSetIntersectionType](docs/v1/models/ObjectSetIntersectionType.md) -- [ObjectSetIntersectionTypeDict](docs/v1/models/ObjectSetIntersectionTypeDict.md) -- [ObjectSetReferenceType](docs/v1/models/ObjectSetReferenceType.md) -- [ObjectSetReferenceTypeDict](docs/v1/models/ObjectSetReferenceTypeDict.md) -- [ObjectSetRid](docs/v1/models/ObjectSetRid.md) -- [ObjectSetSearchAroundType](docs/v1/models/ObjectSetSearchAroundType.md) -- [ObjectSetSearchAroundTypeDict](docs/v1/models/ObjectSetSearchAroundTypeDict.md) -- [ObjectSetStaticType](docs/v1/models/ObjectSetStaticType.md) -- [ObjectSetStaticTypeDict](docs/v1/models/ObjectSetStaticTypeDict.md) -- [ObjectSetStreamSubscribeRequest](docs/v1/models/ObjectSetStreamSubscribeRequest.md) -- [ObjectSetStreamSubscribeRequestDict](docs/v1/models/ObjectSetStreamSubscribeRequestDict.md) -- [ObjectSetStreamSubscribeRequests](docs/v1/models/ObjectSetStreamSubscribeRequests.md) -- [ObjectSetStreamSubscribeRequestsDict](docs/v1/models/ObjectSetStreamSubscribeRequestsDict.md) -- [ObjectSetSubscribeResponse](docs/v1/models/ObjectSetSubscribeResponse.md) -- [ObjectSetSubscribeResponseDict](docs/v1/models/ObjectSetSubscribeResponseDict.md) -- [ObjectSetSubscribeResponses](docs/v1/models/ObjectSetSubscribeResponses.md) -- [ObjectSetSubscribeResponsesDict](docs/v1/models/ObjectSetSubscribeResponsesDict.md) -- [ObjectSetSubtractType](docs/v1/models/ObjectSetSubtractType.md) -- [ObjectSetSubtractTypeDict](docs/v1/models/ObjectSetSubtractTypeDict.md) -- [ObjectSetUnionType](docs/v1/models/ObjectSetUnionType.md) -- [ObjectSetUnionTypeDict](docs/v1/models/ObjectSetUnionTypeDict.md) -- [ObjectSetUpdate](docs/v1/models/ObjectSetUpdate.md) -- [ObjectSetUpdateDict](docs/v1/models/ObjectSetUpdateDict.md) -- [ObjectSetUpdates](docs/v1/models/ObjectSetUpdates.md) -- [ObjectSetUpdatesDict](docs/v1/models/ObjectSetUpdatesDict.md) -- [ObjectState](docs/v1/models/ObjectState.md) - [ObjectType](docs/v1/models/ObjectType.md) - [ObjectTypeApiName](docs/v1/models/ObjectTypeApiName.md) - [ObjectTypeDict](docs/v1/models/ObjectTypeDict.md) -- [ObjectTypeEdits](docs/v1/models/ObjectTypeEdits.md) -- [ObjectTypeEditsDict](docs/v1/models/ObjectTypeEditsDict.md) -- [ObjectTypeFullMetadata](docs/v1/models/ObjectTypeFullMetadata.md) -- [ObjectTypeFullMetadataDict](docs/v1/models/ObjectTypeFullMetadataDict.md) -- [ObjectTypeInterfaceImplementation](docs/v1/models/ObjectTypeInterfaceImplementation.md) -- [ObjectTypeInterfaceImplementationDict](docs/v1/models/ObjectTypeInterfaceImplementationDict.md) - [ObjectTypeRid](docs/v1/models/ObjectTypeRid.md) -- [ObjectTypeV2](docs/v1/models/ObjectTypeV2.md) -- [ObjectTypeV2Dict](docs/v1/models/ObjectTypeV2Dict.md) - [ObjectTypeVisibility](docs/v1/models/ObjectTypeVisibility.md) -- [ObjectUpdate](docs/v1/models/ObjectUpdate.md) -- [ObjectUpdateDict](docs/v1/models/ObjectUpdateDict.md) - [OneOfConstraint](docs/v1/models/OneOfConstraint.md) - [OneOfConstraintDict](docs/v1/models/OneOfConstraintDict.md) - [Ontology](docs/v1/models/Ontology.md) @@ -1808,20 +1164,14 @@ Namespace | Resource | Operation | HTTP request | - [OntologyDataType](docs/v1/models/OntologyDataType.md) - [OntologyDataTypeDict](docs/v1/models/OntologyDataTypeDict.md) - [OntologyDict](docs/v1/models/OntologyDict.md) -- [OntologyFullMetadata](docs/v1/models/OntologyFullMetadata.md) -- [OntologyFullMetadataDict](docs/v1/models/OntologyFullMetadataDict.md) -- [OntologyIdentifier](docs/v1/models/OntologyIdentifier.md) - [OntologyMapType](docs/v1/models/OntologyMapType.md) - [OntologyMapTypeDict](docs/v1/models/OntologyMapTypeDict.md) - [OntologyObject](docs/v1/models/OntologyObject.md) -- [OntologyObjectArrayType](docs/v1/models/OntologyObjectArrayType.md) -- [OntologyObjectArrayTypeDict](docs/v1/models/OntologyObjectArrayTypeDict.md) - [OntologyObjectDict](docs/v1/models/OntologyObjectDict.md) - [OntologyObjectSetType](docs/v1/models/OntologyObjectSetType.md) - [OntologyObjectSetTypeDict](docs/v1/models/OntologyObjectSetTypeDict.md) - [OntologyObjectType](docs/v1/models/OntologyObjectType.md) - [OntologyObjectTypeDict](docs/v1/models/OntologyObjectTypeDict.md) -- [OntologyObjectV2](docs/v1/models/OntologyObjectV2.md) - [OntologyRid](docs/v1/models/OntologyRid.md) - [OntologySetType](docs/v1/models/OntologySetType.md) - [OntologySetTypeDict](docs/v1/models/OntologySetTypeDict.md) @@ -1829,16 +1179,8 @@ Namespace | Resource | Operation | HTTP request | - [OntologyStructFieldDict](docs/v1/models/OntologyStructFieldDict.md) - [OntologyStructType](docs/v1/models/OntologyStructType.md) - [OntologyStructTypeDict](docs/v1/models/OntologyStructTypeDict.md) -- [OntologyV2](docs/v1/models/OntologyV2.md) -- [OntologyV2Dict](docs/v1/models/OntologyV2Dict.md) - [OrderBy](docs/v1/models/OrderBy.md) -- [OrderByDirection](docs/v1/models/OrderByDirection.md) -- [OrQuery](docs/v1/models/OrQuery.md) - [OrQueryDict](docs/v1/models/OrQueryDict.md) -- [OrQueryV2](docs/v1/models/OrQueryV2.md) -- [OrQueryV2Dict](docs/v1/models/OrQueryV2Dict.md) -- [PageSize](docs/v1/models/PageSize.md) -- [PageToken](docs/v1/models/PageToken.md) - [Parameter](docs/v1/models/Parameter.md) - [ParameterDict](docs/v1/models/ParameterDict.md) - [ParameterEvaluatedConstraint](docs/v1/models/ParameterEvaluatedConstraint.md) @@ -1848,194 +1190,37 @@ Namespace | Resource | Operation | HTTP request | - [ParameterId](docs/v1/models/ParameterId.md) - [ParameterOption](docs/v1/models/ParameterOption.md) - [ParameterOptionDict](docs/v1/models/ParameterOptionDict.md) -- [PhraseQuery](docs/v1/models/PhraseQuery.md) - [PhraseQueryDict](docs/v1/models/PhraseQueryDict.md) -- [Polygon](docs/v1/models/Polygon.md) -- [PolygonDict](docs/v1/models/PolygonDict.md) -- [PolygonValue](docs/v1/models/PolygonValue.md) -- [PolygonValueDict](docs/v1/models/PolygonValueDict.md) -- [Position](docs/v1/models/Position.md) -- [PrefixQuery](docs/v1/models/PrefixQuery.md) - [PrefixQueryDict](docs/v1/models/PrefixQueryDict.md) -- [PreviewMode](docs/v1/models/PreviewMode.md) -- [PrimaryKeyValue](docs/v1/models/PrimaryKeyValue.md) - [Property](docs/v1/models/Property.md) - [PropertyApiName](docs/v1/models/PropertyApiName.md) - [PropertyDict](docs/v1/models/PropertyDict.md) -- [PropertyFilter](docs/v1/models/PropertyFilter.md) -- [PropertyId](docs/v1/models/PropertyId.md) -- [PropertyV2](docs/v1/models/PropertyV2.md) -- [PropertyV2Dict](docs/v1/models/PropertyV2Dict.md) - [PropertyValue](docs/v1/models/PropertyValue.md) - [PropertyValueEscapedString](docs/v1/models/PropertyValueEscapedString.md) -- [QosError](docs/v1/models/QosError.md) -- [QosErrorDict](docs/v1/models/QosErrorDict.md) -- [QueryAggregation](docs/v1/models/QueryAggregation.md) -- [QueryAggregationDict](docs/v1/models/QueryAggregationDict.md) -- [QueryAggregationKeyType](docs/v1/models/QueryAggregationKeyType.md) -- [QueryAggregationKeyTypeDict](docs/v1/models/QueryAggregationKeyTypeDict.md) -- [QueryAggregationRange](docs/v1/models/QueryAggregationRange.md) -- [QueryAggregationRangeDict](docs/v1/models/QueryAggregationRangeDict.md) -- [QueryAggregationRangeSubType](docs/v1/models/QueryAggregationRangeSubType.md) -- [QueryAggregationRangeSubTypeDict](docs/v1/models/QueryAggregationRangeSubTypeDict.md) -- [QueryAggregationRangeType](docs/v1/models/QueryAggregationRangeType.md) -- [QueryAggregationRangeTypeDict](docs/v1/models/QueryAggregationRangeTypeDict.md) -- [QueryAggregationValueType](docs/v1/models/QueryAggregationValueType.md) -- [QueryAggregationValueTypeDict](docs/v1/models/QueryAggregationValueTypeDict.md) - [QueryApiName](docs/v1/models/QueryApiName.md) -- [QueryArrayType](docs/v1/models/QueryArrayType.md) -- [QueryArrayTypeDict](docs/v1/models/QueryArrayTypeDict.md) -- [QueryDataType](docs/v1/models/QueryDataType.md) -- [QueryDataTypeDict](docs/v1/models/QueryDataTypeDict.md) -- [QueryOutputV2](docs/v1/models/QueryOutputV2.md) -- [QueryOutputV2Dict](docs/v1/models/QueryOutputV2Dict.md) -- [QueryParameterV2](docs/v1/models/QueryParameterV2.md) -- [QueryParameterV2Dict](docs/v1/models/QueryParameterV2Dict.md) -- [QueryRuntimeErrorParameter](docs/v1/models/QueryRuntimeErrorParameter.md) -- [QuerySetType](docs/v1/models/QuerySetType.md) -- [QuerySetTypeDict](docs/v1/models/QuerySetTypeDict.md) -- [QueryStructField](docs/v1/models/QueryStructField.md) -- [QueryStructFieldDict](docs/v1/models/QueryStructFieldDict.md) -- [QueryStructType](docs/v1/models/QueryStructType.md) -- [QueryStructTypeDict](docs/v1/models/QueryStructTypeDict.md) -- [QueryThreeDimensionalAggregation](docs/v1/models/QueryThreeDimensionalAggregation.md) -- [QueryThreeDimensionalAggregationDict](docs/v1/models/QueryThreeDimensionalAggregationDict.md) -- [QueryTwoDimensionalAggregation](docs/v1/models/QueryTwoDimensionalAggregation.md) -- [QueryTwoDimensionalAggregationDict](docs/v1/models/QueryTwoDimensionalAggregationDict.md) - [QueryType](docs/v1/models/QueryType.md) - [QueryTypeDict](docs/v1/models/QueryTypeDict.md) -- [QueryTypeV2](docs/v1/models/QueryTypeV2.md) -- [QueryTypeV2Dict](docs/v1/models/QueryTypeV2Dict.md) -- [QueryUnionType](docs/v1/models/QueryUnionType.md) -- [QueryUnionTypeDict](docs/v1/models/QueryUnionTypeDict.md) - [RangeConstraint](docs/v1/models/RangeConstraint.md) - [RangeConstraintDict](docs/v1/models/RangeConstraintDict.md) -- [Reason](docs/v1/models/Reason.md) -- [ReasonDict](docs/v1/models/ReasonDict.md) -- [ReasonType](docs/v1/models/ReasonType.md) -- [ReferenceUpdate](docs/v1/models/ReferenceUpdate.md) -- [ReferenceUpdateDict](docs/v1/models/ReferenceUpdateDict.md) -- [ReferenceValue](docs/v1/models/ReferenceValue.md) -- [ReferenceValueDict](docs/v1/models/ReferenceValueDict.md) -- [RefreshObjectSet](docs/v1/models/RefreshObjectSet.md) -- [RefreshObjectSetDict](docs/v1/models/RefreshObjectSetDict.md) -- [RelativeTime](docs/v1/models/RelativeTime.md) -- [RelativeTimeDict](docs/v1/models/RelativeTimeDict.md) -- [RelativeTimeRange](docs/v1/models/RelativeTimeRange.md) -- [RelativeTimeRangeDict](docs/v1/models/RelativeTimeRangeDict.md) -- [RelativeTimeRelation](docs/v1/models/RelativeTimeRelation.md) -- [RelativeTimeSeriesTimeUnit](docs/v1/models/RelativeTimeSeriesTimeUnit.md) -- [ReleaseStatus](docs/v1/models/ReleaseStatus.md) -- [RequestId](docs/v1/models/RequestId.md) -- [ResourcePath](docs/v1/models/ResourcePath.md) -- [ReturnEditsMode](docs/v1/models/ReturnEditsMode.md) -- [SdkPackageName](docs/v1/models/SdkPackageName.md) -- [SearchJsonQuery](docs/v1/models/SearchJsonQuery.md) - [SearchJsonQueryDict](docs/v1/models/SearchJsonQueryDict.md) -- [SearchJsonQueryV2](docs/v1/models/SearchJsonQueryV2.md) -- [SearchJsonQueryV2Dict](docs/v1/models/SearchJsonQueryV2Dict.md) -- [SearchObjectsForInterfaceRequest](docs/v1/models/SearchObjectsForInterfaceRequest.md) -- [SearchObjectsForInterfaceRequestDict](docs/v1/models/SearchObjectsForInterfaceRequestDict.md) -- [SearchObjectsRequest](docs/v1/models/SearchObjectsRequest.md) -- [SearchObjectsRequestDict](docs/v1/models/SearchObjectsRequestDict.md) -- [SearchObjectsRequestV2](docs/v1/models/SearchObjectsRequestV2.md) -- [SearchObjectsRequestV2Dict](docs/v1/models/SearchObjectsRequestV2Dict.md) - [SearchObjectsResponse](docs/v1/models/SearchObjectsResponse.md) - [SearchObjectsResponseDict](docs/v1/models/SearchObjectsResponseDict.md) -- [SearchObjectsResponseV2](docs/v1/models/SearchObjectsResponseV2.md) -- [SearchObjectsResponseV2Dict](docs/v1/models/SearchObjectsResponseV2Dict.md) -- [SearchOrderBy](docs/v1/models/SearchOrderBy.md) - [SearchOrderByDict](docs/v1/models/SearchOrderByDict.md) -- [SearchOrderByV2](docs/v1/models/SearchOrderByV2.md) -- [SearchOrderByV2Dict](docs/v1/models/SearchOrderByV2Dict.md) -- [SearchOrdering](docs/v1/models/SearchOrdering.md) - [SearchOrderingDict](docs/v1/models/SearchOrderingDict.md) -- [SearchOrderingV2](docs/v1/models/SearchOrderingV2.md) -- [SearchOrderingV2Dict](docs/v1/models/SearchOrderingV2Dict.md) - [SelectedPropertyApiName](docs/v1/models/SelectedPropertyApiName.md) -- [SharedPropertyType](docs/v1/models/SharedPropertyType.md) -- [SharedPropertyTypeApiName](docs/v1/models/SharedPropertyTypeApiName.md) -- [SharedPropertyTypeDict](docs/v1/models/SharedPropertyTypeDict.md) -- [SharedPropertyTypeRid](docs/v1/models/SharedPropertyTypeRid.md) -- [ShortType](docs/v1/models/ShortType.md) -- [ShortTypeDict](docs/v1/models/ShortTypeDict.md) -- [SizeBytes](docs/v1/models/SizeBytes.md) -- [StartsWithQuery](docs/v1/models/StartsWithQuery.md) -- [StartsWithQueryDict](docs/v1/models/StartsWithQueryDict.md) -- [StreamMessage](docs/v1/models/StreamMessage.md) -- [StreamMessageDict](docs/v1/models/StreamMessageDict.md) -- [StreamTimeSeriesPointsRequest](docs/v1/models/StreamTimeSeriesPointsRequest.md) -- [StreamTimeSeriesPointsRequestDict](docs/v1/models/StreamTimeSeriesPointsRequestDict.md) -- [StreamTimeSeriesPointsResponse](docs/v1/models/StreamTimeSeriesPointsResponse.md) -- [StreamTimeSeriesPointsResponseDict](docs/v1/models/StreamTimeSeriesPointsResponseDict.md) - [StringLengthConstraint](docs/v1/models/StringLengthConstraint.md) - [StringLengthConstraintDict](docs/v1/models/StringLengthConstraintDict.md) - [StringRegexMatchConstraint](docs/v1/models/StringRegexMatchConstraint.md) - [StringRegexMatchConstraintDict](docs/v1/models/StringRegexMatchConstraintDict.md) -- [StringType](docs/v1/models/StringType.md) -- [StringTypeDict](docs/v1/models/StringTypeDict.md) -- [StructFieldName](docs/v1/models/StructFieldName.md) - [SubmissionCriteriaEvaluation](docs/v1/models/SubmissionCriteriaEvaluation.md) - [SubmissionCriteriaEvaluationDict](docs/v1/models/SubmissionCriteriaEvaluationDict.md) -- [SubscriptionClosed](docs/v1/models/SubscriptionClosed.md) -- [SubscriptionClosedDict](docs/v1/models/SubscriptionClosedDict.md) -- [SubscriptionClosureCause](docs/v1/models/SubscriptionClosureCause.md) -- [SubscriptionClosureCauseDict](docs/v1/models/SubscriptionClosureCauseDict.md) -- [SubscriptionError](docs/v1/models/SubscriptionError.md) -- [SubscriptionErrorDict](docs/v1/models/SubscriptionErrorDict.md) -- [SubscriptionId](docs/v1/models/SubscriptionId.md) -- [SubscriptionSuccess](docs/v1/models/SubscriptionSuccess.md) -- [SubscriptionSuccessDict](docs/v1/models/SubscriptionSuccessDict.md) -- [SumAggregation](docs/v1/models/SumAggregation.md) - [SumAggregationDict](docs/v1/models/SumAggregationDict.md) -- [SumAggregationV2](docs/v1/models/SumAggregationV2.md) -- [SumAggregationV2Dict](docs/v1/models/SumAggregationV2Dict.md) -- [SyncApplyActionResponseV2](docs/v1/models/SyncApplyActionResponseV2.md) -- [SyncApplyActionResponseV2Dict](docs/v1/models/SyncApplyActionResponseV2Dict.md) -- [TableExportFormat](docs/v1/models/TableExportFormat.md) -- [ThreeDimensionalAggregation](docs/v1/models/ThreeDimensionalAggregation.md) -- [ThreeDimensionalAggregationDict](docs/v1/models/ThreeDimensionalAggregationDict.md) -- [TimeRange](docs/v1/models/TimeRange.md) -- [TimeRangeDict](docs/v1/models/TimeRangeDict.md) -- [TimeSeriesItemType](docs/v1/models/TimeSeriesItemType.md) -- [TimeSeriesItemTypeDict](docs/v1/models/TimeSeriesItemTypeDict.md) -- [TimeSeriesPoint](docs/v1/models/TimeSeriesPoint.md) -- [TimeSeriesPointDict](docs/v1/models/TimeSeriesPointDict.md) -- [TimeseriesType](docs/v1/models/TimeseriesType.md) -- [TimeseriesTypeDict](docs/v1/models/TimeseriesTypeDict.md) -- [TimestampType](docs/v1/models/TimestampType.md) -- [TimestampTypeDict](docs/v1/models/TimestampTypeDict.md) -- [TimeUnit](docs/v1/models/TimeUnit.md) -- [TotalCount](docs/v1/models/TotalCount.md) -- [Transaction](docs/v1/models/Transaction.md) -- [TransactionDict](docs/v1/models/TransactionDict.md) -- [TransactionRid](docs/v1/models/TransactionRid.md) -- [TransactionStatus](docs/v1/models/TransactionStatus.md) -- [TransactionType](docs/v1/models/TransactionType.md) -- [TwoDimensionalAggregation](docs/v1/models/TwoDimensionalAggregation.md) -- [TwoDimensionalAggregationDict](docs/v1/models/TwoDimensionalAggregationDict.md) - [UnevaluableConstraint](docs/v1/models/UnevaluableConstraint.md) - [UnevaluableConstraintDict](docs/v1/models/UnevaluableConstraintDict.md) -- [UnsupportedType](docs/v1/models/UnsupportedType.md) -- [UnsupportedTypeDict](docs/v1/models/UnsupportedTypeDict.md) -- [UpdatedTime](docs/v1/models/UpdatedTime.md) -- [UserId](docs/v1/models/UserId.md) -- [ValidateActionRequest](docs/v1/models/ValidateActionRequest.md) -- [ValidateActionRequestDict](docs/v1/models/ValidateActionRequestDict.md) - [ValidateActionResponse](docs/v1/models/ValidateActionResponse.md) - [ValidateActionResponseDict](docs/v1/models/ValidateActionResponseDict.md) -- [ValidateActionResponseV2](docs/v1/models/ValidateActionResponseV2.md) -- [ValidateActionResponseV2Dict](docs/v1/models/ValidateActionResponseV2Dict.md) - [ValidationResult](docs/v1/models/ValidationResult.md) - [ValueType](docs/v1/models/ValueType.md) -- [WithinBoundingBoxPoint](docs/v1/models/WithinBoundingBoxPoint.md) -- [WithinBoundingBoxPointDict](docs/v1/models/WithinBoundingBoxPointDict.md) -- [WithinBoundingBoxQuery](docs/v1/models/WithinBoundingBoxQuery.md) -- [WithinBoundingBoxQueryDict](docs/v1/models/WithinBoundingBoxQueryDict.md) -- [WithinDistanceOfQuery](docs/v1/models/WithinDistanceOfQuery.md) -- [WithinDistanceOfQueryDict](docs/v1/models/WithinDistanceOfQueryDict.md) -- [WithinPolygonQuery](docs/v1/models/WithinPolygonQuery.md) -- [WithinPolygonQueryDict](docs/v1/models/WithinPolygonQueryDict.md) ## Contributions diff --git a/changelog/@unreleased/pr-21.v2.yml b/changelog/@unreleased/pr-21.v2.yml new file mode 100644 index 00000000..dc62bab8 --- /dev/null +++ b/changelog/@unreleased/pr-21.v2.yml @@ -0,0 +1,9 @@ +type: feature +feature: + description: | + - Move data models from `foundry//models` to their respective namespace. For example, the V2 dataset models are located in `foundry/v2/datasets/models`. + - The request body is now passed in as method parameters. For example, rather than creating a branch like this `client.datasets.Dataset.Branch.create(dataset_rid, create_branch_request={"name": "develop"})` you would do this `client.datasets.Dataset.Branch.create(dataset_rid, name="develop")`. + - Renamed `FoundryV1Client` and `FoundryV2Client` back to `FoundryClient` + - Removed unused models + links: + - https://github.com/palantir/foundry-platform-python/pull/21 diff --git a/config.json b/config.json index 98a411ae..7f653ef8 100644 --- a/config.json +++ b/config.json @@ -42,7 +42,9 @@ ] ], "namespaces": { + "Core": true, "Datasets": true, + "Geo": true, "Ontologies": [ "listOntologies", "getOntology", @@ -65,29 +67,63 @@ "searchObjects", "aggregateObjects" ] - } + }, + "skipTests": [ + "createDataset", + "getActionType", + "listActionTypes", + "pageActionTypes", + "getObjectType", + "getOutgoingLinkType", + "listObjectTypes", + "listOutgoingLinkTypes", + "pageObjectTypes", + "pageOutgoingLinkTypes", + "aggregateObjects", + "getObject", + "getLinkedObject", + "listObjects", + "listLinkedObjects", + "pageObjects", + "pageLinkedObjects", + "deployWebsite", + "getQueryType", + "listQueryTypes", + "pageQueryTypes", + "getAttachmentV2", + "getTransaction", + "createTransaction", + "commitTransaction", + "getFileMetadata", + "listBranches", + "abortTransaction" + ] }, "v2": { "additionalRelationships": [ [ - "Ontologies", - "Ontology", - "ActionType" + "OntologiesV2", + "OntologyV2", + "ActionTypeV2" ], [ - "Ontologies", - "Ontology", - "ObjectType" + "OntologiesV2", + "OntologyV2", + "ObjectTypeV2" ], [ - "Ontologies", - "Ontology", + "OntologiesV2", + "OntologyV2", "QueryType" ] ], "namespaces": { - "Datasets": true, "Admin": true, + "Core": true, + "Datasets": true, + "Geo": true, + "Ontologies": [], + "Filesystem": [], "OntologiesV2": [ "getOntologyV2", "getOntologyFullMetadata", @@ -124,8 +160,7 @@ "loadObjectSetV2", "aggregateObjectSetV2", "uploadAttachmentV2", - "getAttachmentContentV2", - "getAttachmentV2" + "getAttachmentContentV2" ], "Orchestration": true, "ThirdPartyApplications": true @@ -140,7 +175,61 @@ "OntologyObjectV2": "OntologyObject", "LinkedObjectV2": "LinkedObject", "AttachmentPropertyV2": "AttachmentProperty" - } + }, + "skipTests": [ + "getObjectSetV2", + "getBuild", + "getWebsite", + "deployWebsite", + "undeployWebsite", + "getActionType", + "listActionTypes", + "pageActionTypes", + "getObjectType", + "getOutgoingLinkType", + "listObjectTypes", + "listOutgoingLinkTypes", + "pageObjectTypes", + "pageOutgoingLinkTypes", + "aggregateObjects", + "getObject", + "getLinkedObject", + "listObjects", + "listLinkedObjects", + "pageObjects", + "pageLinkedObjects", + "getGroupsBatch", + "searchGroups", + "getUsersBatch", + "searchUsers", + "getActionTypeV2", + "listActionTypesV2", + "pageActionTypesV2", + "getAttachmentV2", + "listPropertyAttachments", + "getAttachmentPropertyByRidV2", + "getLinkedObjectV2", + "listLinkedObjectsV2", + "pageLinkedObjectsV2", + "getObjectTypeV2", + "getOutgoingLinkTypeV2", + "listObjectTypesV2", + "listOutgoingLinkTypesV2", + "pageObjectTypesV2", + "pageOutgoingLinkTypesV2", + "getInterfaceType", + "listInterfaceTypes", + "pageInterfaceTypes", + "getObjectV2", + "listObjectsV2", + "pageObjectsV2", + "getQueryTypeV2", + "listQueryTypesV2", + "pageQueryTypesV2", + "applyActionV2", + "aggregateObjectsForInterface", + "aggregateObjectsV2" + ] } } } \ No newline at end of file diff --git a/docs/v1/Datasets/Branch.md b/docs/v1/Datasets/Branch.md new file mode 100644 index 00000000..2bf52ec4 --- /dev/null +++ b/docs/v1/Datasets/Branch.md @@ -0,0 +1,307 @@ +# Branch + +Method | HTTP request | +------------- | ------------- | +[**create**](#create) | **POST** /v1/datasets/{datasetRid}/branches | +[**delete**](#delete) | **DELETE** /v1/datasets/{datasetRid}/branches/{branchId} | +[**get**](#get) | **GET** /v1/datasets/{datasetRid}/branches/{branchId} | +[**list**](#list) | **GET** /v1/datasets/{datasetRid}/branches | +[**page**](#page) | **GET** /v1/datasets/{datasetRid}/branches | + +# **create** +Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**branch_id** | BranchId | | | +**transaction_rid** | Optional[TransactionRid] | | [optional] | + +### Return type +**Branch** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" +# BranchId | +branch_id = "my-branch" +# Optional[TransactionRid] | +transaction_rid = None + + +try: + api_response = foundry_client.datasets.Dataset.Branch.create( + dataset_rid, + branch_id=branch_id, + transaction_rid=transaction_rid, + ) + print("The create response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Branch.create: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Branch | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **delete** +Deletes the Branch with the given BranchId. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**branch_id** | BranchId | branchId | | + +### Return type +**None** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" +# BranchId | branchId +branch_id = "my-branch" + + +try: + api_response = foundry_client.datasets.Dataset.Branch.delete( + dataset_rid, + branch_id, + ) + print("The delete response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Branch.delete: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | Branch deleted. | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **get** +Get a Branch of a Dataset. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**branch_id** | BranchId | branchId | | + +### Return type +**Branch** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" +# BranchId | branchId +branch_id = "master" + + +try: + api_response = foundry_client.datasets.Dataset.Branch.get( + dataset_rid, + branch_id, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Branch.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Branch | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **list** +Lists the Branches of a Dataset. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**page_size** | Optional[PageSize] | pageSize | [optional] | + +### Return type +**ResourceIterator[Branch]** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" +# Optional[PageSize] | pageSize +page_size = None + + +try: + for branch in foundry_client.datasets.Dataset.Branch.list( + dataset_rid, + page_size=page_size, + ): + pprint(branch) +except PalantirRPCException as e: + print("HTTP error when calling Branch.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListBranchesResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **page** +Lists the Branches of a Dataset. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | + +### Return type +**ListBranchesResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None + + +try: + api_response = foundry_client.datasets.Dataset.Branch.page( + dataset_rid, + page_size=page_size, + page_token=page_token, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Branch.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListBranchesResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + diff --git a/docs/v1/Datasets/Dataset.md b/docs/v1/Datasets/Dataset.md new file mode 100644 index 00000000..d68c0517 --- /dev/null +++ b/docs/v1/Datasets/Dataset.md @@ -0,0 +1,446 @@ +# Dataset + +Method | HTTP request | +------------- | ------------- | +[**create**](#create) | **POST** /v1/datasets | +[**get**](#get) | **GET** /v1/datasets/{datasetRid} | +[**read**](#read) | **GET** /v1/datasets/{datasetRid}/readTable | + +# **create** +Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**name** | DatasetName | | | +**parent_folder_rid** | FolderRid | | | + +### Return type +**Dataset** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetName | +name = "My Dataset" +# FolderRid | +parent_folder_rid = "ri.foundry.main.folder.bfe58487-4c56-4c58-aba7-25defd6163c4" + + +try: + api_response = foundry_client.datasets.Dataset.create( + name=name, + parent_folder_rid=parent_folder_rid, + ) + print("The create response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Dataset.create: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Dataset | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +Deletes the Schema from a Dataset and Branch. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**branch_id** | Optional[BranchId] | branchId | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**transaction_rid** | Optional[TransactionRid] | transactionRid | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# Optional[BranchId] | branchId +branch_id = None +# Optional[PreviewMode] | preview +preview = True +# Optional[TransactionRid] | transactionRid +transaction_rid = None + + +try: + api_response = foundry_client.datasets.Dataset.delete_schema( + dataset_rid, + branch_id=branch_id, + preview=preview, + transaction_rid=transaction_rid, + ) + print("The delete_schema response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Dataset.delete_schema: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | Schema deleted. | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **get** +Gets the Dataset with the given DatasetRid. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | + +### Return type +**Dataset** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" + + +try: + api_response = foundry_client.datasets.Dataset.get( + dataset_rid, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Dataset.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Dataset | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +Retrieves the Schema for a Dataset and Branch, if it exists. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**branch_id** | Optional[BranchId] | branchId | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**transaction_rid** | Optional[TransactionRid] | transactionRid | [optional] | + +### Return type +**Any** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# Optional[BranchId] | branchId +branch_id = None +# Optional[PreviewMode] | preview +preview = True +# Optional[TransactionRid] | transactionRid +transaction_rid = None + + +try: + api_response = foundry_client.datasets.Dataset.get_schema( + dataset_rid, + branch_id=branch_id, + preview=preview, + transaction_rid=transaction_rid, + ) + print("The get_schema response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Dataset.get_schema: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Any | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **read** +Gets the content of a dataset as a table in the specified format. + +This endpoint currently does not support views (Virtual datasets composed of other datasets). + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**format** | TableExportFormat | format | | +**branch_id** | Optional[BranchId] | branchId | [optional] | +**columns** | Optional[List[StrictStr]] | columns | [optional] | +**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | +**row_limit** | Optional[StrictInt] | rowLimit | [optional] | +**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | + +### Return type +**bytes** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# TableExportFormat | format +format = "CSV" +# Optional[BranchId] | branchId +branch_id = None +# Optional[List[StrictStr]] | columns +columns = None +# Optional[TransactionRid] | endTransactionRid +end_transaction_rid = None +# Optional[StrictInt] | rowLimit +row_limit = None +# Optional[TransactionRid] | startTransactionRid +start_transaction_rid = None + + +try: + api_response = foundry_client.datasets.Dataset.read( + dataset_rid, + format=format, + branch_id=branch_id, + columns=columns, + end_transaction_rid=end_transaction_rid, + row_limit=row_limit, + start_transaction_rid=start_transaction_rid, + ) + print("The read response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Dataset.read: %s\n" % e) + +``` + +### Read a Foundry Dataset as a CSV + +```python +import foundry +from foundry.models import TableExportFormat +from foundry import PalantirRPCException + +foundry_client = foundry.FoundryV1Client(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") + +try: + api_response = foundry_client.datasets.Dataset.read( + dataset_rid="...", format="CSV", columns=[...] + ) + + with open("my_table.csv", "wb") as f: + f.write(api_response) +except PalantirRPCException as e: + print("PalantirRPCException when calling DatasetsApiServiceApi -> read: %s\n" % e) +``` + +### Read a Foundry Dataset into a Pandas DataFrame + +> [!IMPORTANT] +> For this example to work, you will need to have `pyarrow` installed in your Python environment. + +```python +import foundry +from foundry.models import TableExportFormat +from foundry import PalantirRPCException +import pyarrow as pa + +foundry_client = foundry.FoundryV1Client(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") + +try: + api_response = foundry_client.datasets.Dataset.read(dataset_rid="...", format="ARROW", columns=[...]) + df = pa.ipc.open_stream(api_response).read_all().to_pandas() + print(df) +except Exception as e: + print("Exception when calling DatasetsApiServiceApi -> read: %s\n" % e) +``` + +``` + id word length double boolean +0 0 A 1.0 11.878200 1 +1 1 a 1.0 11.578800 0 +2 2 aa 2.0 15.738500 1 +3 3 aal 3.0 6.643900 0 +4 4 aalii 5.0 2.017730 1 +... ... ... ... ... ... +235881 235881 zythem 6.0 19.427400 1 +235882 235882 Zythia 6.0 14.397100 1 +235883 235883 zythum 6.0 3.385820 0 +235884 235884 Zyzomys 7.0 6.208830 1 +235885 235885 Zyzzogeton 10.0 0.947821 0 + +[235886 rows x 5 columns] +``` + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | bytes | The content stream. | */* | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +Puts a Schema on an existing Dataset and Branch. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**body** | Any | Body of the request | | +**branch_id** | Optional[BranchId] | branchId | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# Any | Body of the request +body = None +# Optional[BranchId] | branchId +branch_id = None +# Optional[PreviewMode] | preview +preview = True + + +try: + api_response = foundry_client.datasets.Dataset.replace_schema( + dataset_rid, + body, + branch_id=branch_id, + preview=preview, + ) + print("The replace_schema response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Dataset.replace_schema: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + diff --git a/docs/v1/Datasets/File.md b/docs/v1/Datasets/File.md new file mode 100644 index 00000000..c12f603a --- /dev/null +++ b/docs/v1/Datasets/File.md @@ -0,0 +1,573 @@ +# File + +Method | HTTP request | +------------- | ------------- | +[**delete**](#delete) | **DELETE** /v1/datasets/{datasetRid}/files/{filePath} | +[**get**](#get) | **GET** /v1/datasets/{datasetRid}/files/{filePath} | +[**list**](#list) | **GET** /v1/datasets/{datasetRid}/files | +[**page**](#page) | **GET** /v1/datasets/{datasetRid}/files | +[**read**](#read) | **GET** /v1/datasets/{datasetRid}/files/{filePath}/content | +[**upload**](#upload) | **POST** /v1/datasets/{datasetRid}/files:upload | + +# **delete** +Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default +branch - `master` for most enrollments. The file will still be visible on historical views. + +#### Advanced Usage + +See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + +To **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction +will be created and committed on this branch. + +To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier +as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a +single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to +open a transaction. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**file_path** | FilePath | filePath | | +**branch_id** | Optional[BranchId] | branchId | [optional] | +**transaction_rid** | Optional[TransactionRid] | transactionRid | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" +# FilePath | filePath +file_path = "q3-data%2fmy-file.csv" +# Optional[BranchId] | branchId +branch_id = None +# Optional[TransactionRid] | transactionRid +transaction_rid = None + + +try: + api_response = foundry_client.datasets.Dataset.File.delete( + dataset_rid, + file_path, + branch_id=branch_id, + transaction_rid=transaction_rid, + ) + print("The delete response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling File.delete: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | File deleted. | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **get** +Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest +view of the default branch - `master` for most enrollments. + +#### Advanced Usage + +See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + +To **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will +retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest +ancestor transaction of the branch if there are no snapshot transactions. + +To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier +as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot +transaction, or the earliest ancestor transaction if there are no snapshot transactions. + +To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's +resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. +This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the +`endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path. + +To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the +`startTransactionRid` and `endTransactionRid`. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**file_path** | FilePath | filePath | | +**branch_id** | Optional[BranchId] | branchId | [optional] | +**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | +**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | + +### Return type +**File** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" +# FilePath | filePath +file_path = "q3-data%2fmy-file.csv" +# Optional[BranchId] | branchId +branch_id = None +# Optional[TransactionRid] | endTransactionRid +end_transaction_rid = None +# Optional[TransactionRid] | startTransactionRid +start_transaction_rid = None + + +try: + api_response = foundry_client.datasets.Dataset.File.get( + dataset_rid, + file_path, + branch_id=branch_id, + end_transaction_rid=end_transaction_rid, + start_transaction_rid=start_transaction_rid, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling File.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | File | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **list** +Lists Files contained in a Dataset. By default files are listed on the latest view of the default +branch - `master` for most enrollments. + +#### Advanced Usage + +See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + +To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most +recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the +branch if there are no snapshot transactions. + +To **list files on the resolved view of a transaction** specify the Transaction's resource identifier +as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot +transaction, or the earliest ancestor transaction if there are no snapshot transactions. + +To **list files on the resolved view of a range of transactions** specify the the start transaction's resource +identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This +will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. +Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when +the start and end transactions do not belong to the same root-to-leaf path. + +To **list files on a specific transaction** specify the Transaction's resource identifier as both the +`startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that +Transaction. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**branch_id** | Optional[BranchId] | branchId | [optional] | +**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | + +### Return type +**ResourceIterator[File]** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# Optional[BranchId] | branchId +branch_id = None +# Optional[TransactionRid] | endTransactionRid +end_transaction_rid = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[TransactionRid] | startTransactionRid +start_transaction_rid = None + + +try: + for file in foundry_client.datasets.Dataset.File.list( + dataset_rid, + branch_id=branch_id, + end_transaction_rid=end_transaction_rid, + page_size=page_size, + start_transaction_rid=start_transaction_rid, + ): + pprint(file) +except PalantirRPCException as e: + print("HTTP error when calling File.list: %s\n" % e) + +``` + +### Read the contents of a file from a dataset (by exploration / listing) + +```python +import foundry + +foundry_client = foundry.FoundryV1Client(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") + +result = foundry_client.datasets.Dataset.File.list(dataset_rid="...") + +if result.data: + file_path = result.data[0].path + + print(foundry_client.datasets.Dataset.File.read( + dataset_rid="...", file_path=file_path + )) +``` + +``` +b'Hello!' +``` + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListFilesResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **page** +Lists Files contained in a Dataset. By default files are listed on the latest view of the default +branch - `master` for most enrollments. + +#### Advanced Usage + +See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + +To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most +recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the +branch if there are no snapshot transactions. + +To **list files on the resolved view of a transaction** specify the Transaction's resource identifier +as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot +transaction, or the earliest ancestor transaction if there are no snapshot transactions. + +To **list files on the resolved view of a range of transactions** specify the the start transaction's resource +identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This +will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. +Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when +the start and end transactions do not belong to the same root-to-leaf path. + +To **list files on a specific transaction** specify the Transaction's resource identifier as both the +`startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that +Transaction. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**branch_id** | Optional[BranchId] | branchId | [optional] | +**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | + +### Return type +**ListFilesResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# Optional[BranchId] | branchId +branch_id = None +# Optional[TransactionRid] | endTransactionRid +end_transaction_rid = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[TransactionRid] | startTransactionRid +start_transaction_rid = None + + +try: + api_response = foundry_client.datasets.Dataset.File.page( + dataset_rid, + branch_id=branch_id, + end_transaction_rid=end_transaction_rid, + page_size=page_size, + page_token=page_token, + start_transaction_rid=start_transaction_rid, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling File.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListFilesResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **read** +Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest +view of the default branch - `master` for most enrollments. + +#### Advanced Usage + +See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + +To **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will +retrieve the content for the most recent version of the file since the latest snapshot transaction, or the +earliest ancestor transaction of the branch if there are no snapshot transactions. + +To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier +as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest +snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions. + +To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's +resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. +This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the +`endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior +is undefined when the start and end transactions do not belong to the same root-to-leaf path. + +To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the +`startTransactionRid` and `endTransactionRid`. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**file_path** | FilePath | filePath | | +**branch_id** | Optional[BranchId] | branchId | [optional] | +**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | +**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | + +### Return type +**bytes** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# FilePath | filePath +file_path = "q3-data%2fmy-file.csv" +# Optional[BranchId] | branchId +branch_id = None +# Optional[TransactionRid] | endTransactionRid +end_transaction_rid = None +# Optional[TransactionRid] | startTransactionRid +start_transaction_rid = None + + +try: + api_response = foundry_client.datasets.Dataset.File.read( + dataset_rid, + file_path, + branch_id=branch_id, + end_transaction_rid=end_transaction_rid, + start_transaction_rid=start_transaction_rid, + ) + print("The read response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling File.read: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | bytes | | */* | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **upload** +Uploads a File to an existing Dataset. +The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. + +By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments. +If the file already exists only the most recent version will be visible in the updated view. + +#### Advanced Usage + +See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + +To **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will +be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this +default specify `transactionType` in addition to `branchId`. +See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. + +To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as +`transactionRid`. This is useful for uploading multiple files in a single transaction. +See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**body** | bytes | Body of the request | | +**file_path** | FilePath | filePath | | +**branch_id** | Optional[BranchId] | branchId | [optional] | +**transaction_rid** | Optional[TransactionRid] | transactionRid | [optional] | +**transaction_type** | Optional[TransactionType] | transactionType | [optional] | + +### Return type +**File** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# bytes | Body of the request +body = None +# FilePath | filePath +file_path = "q3-data%2fmy-file.csv" +# Optional[BranchId] | branchId +branch_id = None +# Optional[TransactionRid] | transactionRid +transaction_rid = None +# Optional[TransactionType] | transactionType +transaction_type = None + + +try: + api_response = foundry_client.datasets.Dataset.File.upload( + dataset_rid, + body, + file_path=file_path, + branch_id=branch_id, + transaction_rid=transaction_rid, + transaction_type=transaction_type, + ) + print("The upload response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling File.upload: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | File | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + diff --git a/docs/v1/Datasets/Transaction.md b/docs/v1/Datasets/Transaction.md new file mode 100644 index 00000000..7d55ad5c --- /dev/null +++ b/docs/v1/Datasets/Transaction.md @@ -0,0 +1,269 @@ +# Transaction + +Method | HTTP request | +------------- | ------------- | +[**abort**](#abort) | **POST** /v1/datasets/{datasetRid}/transactions/{transactionRid}/abort | +[**commit**](#commit) | **POST** /v1/datasets/{datasetRid}/transactions/{transactionRid}/commit | +[**create**](#create) | **POST** /v1/datasets/{datasetRid}/transactions | +[**get**](#get) | **GET** /v1/datasets/{datasetRid}/transactions/{transactionRid} | + +# **abort** +Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is +not updated. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**transaction_rid** | TransactionRid | transactionRid | | + +### Return type +**Transaction** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" +# TransactionRid | transactionRid +transaction_rid = "ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496" + + +try: + api_response = foundry_client.datasets.Dataset.Transaction.abort( + dataset_rid, + transaction_rid, + ) + print("The abort response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Transaction.abort: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Transaction | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **commit** +Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is +updated to point to the Transaction. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**transaction_rid** | TransactionRid | transactionRid | | + +### Return type +**Transaction** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" +# TransactionRid | transactionRid +transaction_rid = "ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496" + + +try: + api_response = foundry_client.datasets.Dataset.Transaction.commit( + dataset_rid, + transaction_rid, + ) + print("The commit response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Transaction.commit: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Transaction | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **create** +Creates a Transaction on a Branch of a Dataset. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**branch_id** | Optional[BranchId] | branchId | [optional] | +**transaction_type** | Optional[TransactionType] | | [optional] | + +### Return type +**Transaction** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" +# Optional[BranchId] | branchId +branch_id = None +# Optional[TransactionType] | +transaction_type = "SNAPSHOT" + + +try: + api_response = foundry_client.datasets.Dataset.Transaction.create( + dataset_rid, + branch_id=branch_id, + transaction_type=transaction_type, + ) + print("The create response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Transaction.create: %s\n" % e) + +``` + +### Manipulate a Dataset within a Transaction + +```python +import foundry + +foundry_client = foundry.FoundryV1Client(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") + +transaction = foundry_client.datasets.Dataset.Transaction.create( + dataset_rid="...", + create_transaction_request={}, +) + +with open("my/path/to/file.txt", 'rb') as f: + foundry_client.datasets.Dataset.File.upload( + body=f.read(), + dataset_rid="....", + file_path="...", + transaction_rid=transaction.rid, + ) + +foundry_client.datasets.Dataset.Transaction.commit(dataset_rid="...", transaction_rid=transaction.rid) +``` + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Transaction | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **get** +Gets a Transaction of a Dataset. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**transaction_rid** | TransactionRid | transactionRid | | + +### Return type +**Transaction** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" +# TransactionRid | transactionRid +transaction_rid = "ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496" + + +try: + api_response = foundry_client.datasets.Dataset.Transaction.get( + dataset_rid, + transaction_rid, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Transaction.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Transaction | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + diff --git a/docs/v1/Ontologies/Action.md b/docs/v1/Ontologies/Action.md new file mode 100644 index 00000000..12675e5a --- /dev/null +++ b/docs/v1/Ontologies/Action.md @@ -0,0 +1,229 @@ +# Action + +Method | HTTP request | +------------- | ------------- | +[**apply**](#apply) | **POST** /v1/ontologies/{ontologyRid}/actions/{actionType}/apply | +[**apply_batch**](#apply_batch) | **POST** /v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch | +[**validate**](#validate) | **POST** /v1/ontologies/{ontologyRid}/actions/{actionType}/validate | + +# **apply** +Applies an action using the given parameters. Changes to the Ontology are eventually consistent and may take +some time to be visible. + +Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by +this endpoint. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read api:ontologies-write`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**action_type** | ActionTypeApiName | actionType | | +**parameters** | Dict[ParameterId, Optional[DataValue]] | | | + +### Return type +**ApplyActionResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ActionTypeApiName | actionType +action_type = "rename-employee" +# Dict[ParameterId, Optional[DataValue]] | +parameters = {"id": 80060, "newName": "Anna Smith-Doe"} + + +try: + api_response = foundry_client.ontologies.Action.apply( + ontology_rid, + action_type, + parameters=parameters, + ) + print("The apply response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Action.apply: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ApplyActionResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **apply_batch** +Applies multiple actions (of the same Action Type) using the given parameters. +Changes to the Ontology are eventually consistent and may take some time to be visible. + +Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not +call Functions may receive a higher limit. + +Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) and +[notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read api:ontologies-write`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**action_type** | ActionTypeApiName | actionType | | +**requests** | List[ApplyActionRequestDict] | | | + +### Return type +**BatchApplyActionResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ActionTypeApiName | actionType +action_type = "rename-employee" +# List[ApplyActionRequestDict] | +requests = [ + {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}}, + {"parameters": {"id": 80061, "newName": "Joe Bloggs"}}, +] + + +try: + api_response = foundry_client.ontologies.Action.apply_batch( + ontology_rid, + action_type, + requests=requests, + ) + print("The apply_batch response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Action.apply_batch: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | BatchApplyActionResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **validate** +Validates if an action can be run with the given set of parameters. +The response contains the evaluation of parameters and **submission criteria** +that determine if the request is `VALID` or `INVALID`. +For performance reasons, validations will not consider existing objects or other data in Foundry. +For example, the uniqueness of a primary key or the existence of a user ID will not be checked. +Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by +this endpoint. Unspecified parameters will be given a default value of `null`. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**action_type** | ActionTypeApiName | actionType | | +**parameters** | Dict[ParameterId, Optional[DataValue]] | | | + +### Return type +**ValidateActionResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ActionTypeApiName | actionType +action_type = "rename-employee" +# Dict[ParameterId, Optional[DataValue]] | +parameters = { + "id": "2", + "firstName": "Chuck", + "lastName": "Jones", + "age": 17, + "date": "2021-05-01", + "numbers": [1, 2, 3], + "hasObjectSet": True, + "objectSet": "ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623", + "reference": "Chuck", + "percentage": 41.3, + "differentObjectId": "2", +} + + +try: + api_response = foundry_client.ontologies.Action.validate( + ontology_rid, + action_type, + parameters=parameters, + ) + print("The validate response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Action.validate: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ValidateActionResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + diff --git a/docs/v1/Ontologies/ActionType.md b/docs/v1/Ontologies/ActionType.md new file mode 100644 index 00000000..57c179fb --- /dev/null +++ b/docs/v1/Ontologies/ActionType.md @@ -0,0 +1,191 @@ +# ActionType + +Method | HTTP request | +------------- | ------------- | +[**get**](#get) | **GET** /v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName} | +[**list**](#list) | **GET** /v1/ontologies/{ontologyRid}/actionTypes | +[**page**](#page) | **GET** /v1/ontologies/{ontologyRid}/actionTypes | + +# **get** +Gets a specific action type with the given API name. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**action_type_api_name** | ActionTypeApiName | actionTypeApiName | | + +### Return type +**ActionType** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ActionTypeApiName | actionTypeApiName +action_type_api_name = "promote-employee" + + +try: + api_response = foundry_client.ontologies.Ontology.ActionType.get( + ontology_rid, + action_type_api_name, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling ActionType.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ActionType | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **list** +Lists the action types for the given Ontology. + +Each page may be smaller than the requested page size. However, it is guaranteed that if there are more +results available, at least one result will be present in the response. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**page_size** | Optional[PageSize] | pageSize | [optional] | + +### Return type +**ResourceIterator[ActionType]** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# Optional[PageSize] | pageSize +page_size = None + + +try: + for action_type in foundry_client.ontologies.Ontology.ActionType.list( + ontology_rid, + page_size=page_size, + ): + pprint(action_type) +except PalantirRPCException as e: + print("HTTP error when calling ActionType.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListActionTypesResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **page** +Lists the action types for the given Ontology. + +Each page may be smaller than the requested page size. However, it is guaranteed that if there are more +results available, at least one result will be present in the response. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | + +### Return type +**ListActionTypesResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None + + +try: + api_response = foundry_client.ontologies.Ontology.ActionType.page( + ontology_rid, + page_size=page_size, + page_token=page_token, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling ActionType.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListActionTypesResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + diff --git a/docs/v1/Ontologies/ObjectType.md b/docs/v1/Ontologies/ObjectType.md new file mode 100644 index 00000000..95def25a --- /dev/null +++ b/docs/v1/Ontologies/ObjectType.md @@ -0,0 +1,388 @@ +# ObjectType + +Method | HTTP request | +------------- | ------------- | +[**get**](#get) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType} | +[**get_outgoing_link_type**](#get_outgoing_link_type) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} | +[**list**](#list) | **GET** /v1/ontologies/{ontologyRid}/objectTypes | +[**list_outgoing_link_types**](#list_outgoing_link_types) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes | +[**page**](#page) | **GET** /v1/ontologies/{ontologyRid}/objectTypes | +[**page_outgoing_link_types**](#page_outgoing_link_types) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes | + +# **get** +Gets a specific object type with the given API name. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**object_type** | ObjectTypeApiName | objectType | | + +### Return type +**ObjectType** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ObjectTypeApiName | objectType +object_type = "employee" + + +try: + api_response = foundry_client.ontologies.Ontology.ObjectType.get( + ontology_rid, + object_type, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling ObjectType.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ObjectType | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **get_outgoing_link_type** +Get an outgoing link for an object type. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**object_type** | ObjectTypeApiName | objectType | | +**link_type** | LinkTypeApiName | linkType | | + +### Return type +**LinkTypeSide** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ObjectTypeApiName | objectType +object_type = "Employee" +# LinkTypeApiName | linkType +link_type = "directReport" + + +try: + api_response = foundry_client.ontologies.Ontology.ObjectType.get_outgoing_link_type( + ontology_rid, + object_type, + link_type, + ) + print("The get_outgoing_link_type response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling ObjectType.get_outgoing_link_type: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | LinkTypeSide | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **list** +Lists the object types for the given Ontology. + +Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are +more results available, at least one result will be present in the +response. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**page_size** | Optional[PageSize] | pageSize | [optional] | + +### Return type +**ResourceIterator[ObjectType]** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# Optional[PageSize] | pageSize +page_size = None + + +try: + for object_type in foundry_client.ontologies.Ontology.ObjectType.list( + ontology_rid, + page_size=page_size, + ): + pprint(object_type) +except PalantirRPCException as e: + print("HTTP error when calling ObjectType.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListObjectTypesResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **list_outgoing_link_types** +List the outgoing links for an object type. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**object_type** | ObjectTypeApiName | objectType | | +**page_size** | Optional[PageSize] | pageSize | [optional] | + +### Return type +**ResourceIterator[LinkTypeSide]** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ObjectTypeApiName | objectType +object_type = "Flight" +# Optional[PageSize] | pageSize +page_size = None + + +try: + for object_type in foundry_client.ontologies.Ontology.ObjectType.list_outgoing_link_types( + ontology_rid, + object_type, + page_size=page_size, + ): + pprint(object_type) +except PalantirRPCException as e: + print("HTTP error when calling ObjectType.list_outgoing_link_types: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListOutgoingLinkTypesResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **page** +Lists the object types for the given Ontology. + +Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are +more results available, at least one result will be present in the +response. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | + +### Return type +**ListObjectTypesResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None + + +try: + api_response = foundry_client.ontologies.Ontology.ObjectType.page( + ontology_rid, + page_size=page_size, + page_token=page_token, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling ObjectType.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListObjectTypesResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **page_outgoing_link_types** +List the outgoing links for an object type. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**object_type** | ObjectTypeApiName | objectType | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | + +### Return type +**ListOutgoingLinkTypesResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ObjectTypeApiName | objectType +object_type = "Flight" +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None + + +try: + api_response = foundry_client.ontologies.Ontology.ObjectType.page_outgoing_link_types( + ontology_rid, + object_type, + page_size=page_size, + page_token=page_token, + ) + print("The page_outgoing_link_types response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling ObjectType.page_outgoing_link_types: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListOutgoingLinkTypesResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + diff --git a/docs/v1/Ontologies/Ontology.md b/docs/v1/Ontologies/Ontology.md new file mode 100644 index 00000000..c5a117db --- /dev/null +++ b/docs/v1/Ontologies/Ontology.md @@ -0,0 +1,109 @@ +# Ontology + +Method | HTTP request | +------------- | ------------- | +[**get**](#get) | **GET** /v1/ontologies/{ontologyRid} | +[**list**](#list) | **GET** /v1/ontologies | + +# **get** +Gets a specific ontology with the given Ontology RID. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | + +### Return type +**Ontology** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" + + +try: + api_response = foundry_client.ontologies.Ontology.get( + ontology_rid, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Ontology.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Ontology | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **list** +Lists the Ontologies visible to the current user. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | + +### Return type +**ListOntologiesResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + + +try: + api_response = foundry_client.ontologies.Ontology.list() + print("The list response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Ontology.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListOntologiesResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + diff --git a/docs/v1/Ontologies/OntologyObject.md b/docs/v1/Ontologies/OntologyObject.md new file mode 100644 index 00000000..e294d477 --- /dev/null +++ b/docs/v1/Ontologies/OntologyObject.md @@ -0,0 +1,692 @@ +# OntologyObject + +Method | HTTP request | +------------- | ------------- | +[**aggregate**](#aggregate) | **POST** /v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate | +[**get**](#get) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey} | +[**get_linked_object**](#get_linked_object) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} | +[**list**](#list) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType} | +[**list_linked_objects**](#list_linked_objects) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType} | +[**page**](#page) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType} | +[**page_linked_objects**](#page_linked_objects) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType} | +[**search**](#search) | **POST** /v1/ontologies/{ontologyRid}/objects/{objectType}/search | + +# **aggregate** +Perform functions on object fields in the specified ontology and object type. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**object_type** | ObjectTypeApiName | objectType | | +**aggregation** | List[AggregationDict] | | | +**group_by** | List[AggregationGroupByDict] | | | +**query** | Optional[SearchJsonQueryDict] | | [optional] | + +### Return type +**AggregateObjectsResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ObjectTypeApiName | objectType +object_type = "employee" +# List[AggregationDict] | +aggregation = [ + {"type": "min", "field": "properties.tenure", "name": "min_tenure"}, + {"type": "avg", "field": "properties.tenure", "name": "avg_tenure"}, +] +# List[AggregationGroupByDict] | +group_by = [ + { + "field": "properties.startDate", + "type": "range", + "ranges": [{"gte": "2020-01-01", "lt": "2020-06-01"}], + }, + {"field": "properties.city", "type": "exact"}, +] +# Optional[SearchJsonQueryDict] | +query = {"not": {"field": "properties.name", "eq": "john"}} + + +try: + api_response = foundry_client.ontologies.OntologyObject.aggregate( + ontology_rid, + object_type, + aggregation=aggregation, + group_by=group_by, + query=query, + ) + print("The aggregate response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObject.aggregate: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | AggregateObjectsResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **get** +Gets a specific object with the given primary key. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**object_type** | ObjectTypeApiName | objectType | | +**primary_key** | PropertyValueEscapedString | primaryKey | | +**properties** | Optional[List[SelectedPropertyApiName]] | properties | [optional] | + +### Return type +**OntologyObject** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ObjectTypeApiName | objectType +object_type = "employee" +# PropertyValueEscapedString | primaryKey +primary_key = 50030 +# Optional[List[SelectedPropertyApiName]] | properties +properties = None + + +try: + api_response = foundry_client.ontologies.OntologyObject.get( + ontology_rid, + object_type, + primary_key, + properties=properties, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObject.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | OntologyObject | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **get_linked_object** +Get a specific linked object that originates from another object. If there is no link between the two objects, +LinkedObjectNotFound is thrown. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**object_type** | ObjectTypeApiName | objectType | | +**primary_key** | PropertyValueEscapedString | primaryKey | | +**link_type** | LinkTypeApiName | linkType | | +**linked_object_primary_key** | PropertyValueEscapedString | linkedObjectPrimaryKey | | +**properties** | Optional[List[SelectedPropertyApiName]] | properties | [optional] | + +### Return type +**OntologyObject** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ObjectTypeApiName | objectType +object_type = "employee" +# PropertyValueEscapedString | primaryKey +primary_key = 50030 +# LinkTypeApiName | linkType +link_type = "directReport" +# PropertyValueEscapedString | linkedObjectPrimaryKey +linked_object_primary_key = 80060 +# Optional[List[SelectedPropertyApiName]] | properties +properties = None + + +try: + api_response = foundry_client.ontologies.OntologyObject.get_linked_object( + ontology_rid, + object_type, + primary_key, + link_type, + linked_object_primary_key, + properties=properties, + ) + print("The get_linked_object response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObject.get_linked_object: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | OntologyObject | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **list** +Lists the objects for the given Ontology and object type. + +This endpoint supports filtering objects. +See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. + +Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or +repeated objects in the response pages. + +For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects +are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + +Each page may be smaller or larger than the requested page size. However, it +is guaranteed that if there are more results available, at least one result will be present +in the response. + +Note that null value properties will not be returned. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**object_type** | ObjectTypeApiName | objectType | | +**order_by** | Optional[OrderBy] | orderBy | [optional] | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**properties** | Optional[List[SelectedPropertyApiName]] | properties | [optional] | + +### Return type +**ResourceIterator[OntologyObject]** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ObjectTypeApiName | objectType +object_type = "employee" +# Optional[OrderBy] | orderBy +order_by = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[List[SelectedPropertyApiName]] | properties +properties = None + + +try: + for ontology_object in foundry_client.ontologies.OntologyObject.list( + ontology_rid, + object_type, + order_by=order_by, + page_size=page_size, + properties=properties, + ): + pprint(ontology_object) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObject.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListObjectsResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **list_linked_objects** +Lists the linked objects for a specific object and the given link type. + +This endpoint supports filtering objects. +See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. + +Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or +repeated objects in the response pages. + +For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects +are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + +Each page may be smaller or larger than the requested page size. However, it +is guaranteed that if there are more results available, at least one result will be present +in the response. + +Note that null value properties will not be returned. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**object_type** | ObjectTypeApiName | objectType | | +**primary_key** | PropertyValueEscapedString | primaryKey | | +**link_type** | LinkTypeApiName | linkType | | +**order_by** | Optional[OrderBy] | orderBy | [optional] | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**properties** | Optional[List[SelectedPropertyApiName]] | properties | [optional] | + +### Return type +**ResourceIterator[OntologyObject]** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ObjectTypeApiName | objectType +object_type = "employee" +# PropertyValueEscapedString | primaryKey +primary_key = 50030 +# LinkTypeApiName | linkType +link_type = "directReport" +# Optional[OrderBy] | orderBy +order_by = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[List[SelectedPropertyApiName]] | properties +properties = None + + +try: + for ontology_object in foundry_client.ontologies.OntologyObject.list_linked_objects( + ontology_rid, + object_type, + primary_key, + link_type, + order_by=order_by, + page_size=page_size, + properties=properties, + ): + pprint(ontology_object) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObject.list_linked_objects: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListLinkedObjectsResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **page** +Lists the objects for the given Ontology and object type. + +This endpoint supports filtering objects. +See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. + +Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or +repeated objects in the response pages. + +For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects +are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + +Each page may be smaller or larger than the requested page size. However, it +is guaranteed that if there are more results available, at least one result will be present +in the response. + +Note that null value properties will not be returned. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**object_type** | ObjectTypeApiName | objectType | | +**order_by** | Optional[OrderBy] | orderBy | [optional] | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**properties** | Optional[List[SelectedPropertyApiName]] | properties | [optional] | + +### Return type +**ListObjectsResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ObjectTypeApiName | objectType +object_type = "employee" +# Optional[OrderBy] | orderBy +order_by = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[List[SelectedPropertyApiName]] | properties +properties = None + + +try: + api_response = foundry_client.ontologies.OntologyObject.page( + ontology_rid, + object_type, + order_by=order_by, + page_size=page_size, + page_token=page_token, + properties=properties, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObject.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListObjectsResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **page_linked_objects** +Lists the linked objects for a specific object and the given link type. + +This endpoint supports filtering objects. +See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. + +Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or +repeated objects in the response pages. + +For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects +are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + +Each page may be smaller or larger than the requested page size. However, it +is guaranteed that if there are more results available, at least one result will be present +in the response. + +Note that null value properties will not be returned. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**object_type** | ObjectTypeApiName | objectType | | +**primary_key** | PropertyValueEscapedString | primaryKey | | +**link_type** | LinkTypeApiName | linkType | | +**order_by** | Optional[OrderBy] | orderBy | [optional] | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**properties** | Optional[List[SelectedPropertyApiName]] | properties | [optional] | + +### Return type +**ListLinkedObjectsResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ObjectTypeApiName | objectType +object_type = "employee" +# PropertyValueEscapedString | primaryKey +primary_key = 50030 +# LinkTypeApiName | linkType +link_type = "directReport" +# Optional[OrderBy] | orderBy +order_by = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[List[SelectedPropertyApiName]] | properties +properties = None + + +try: + api_response = foundry_client.ontologies.OntologyObject.page_linked_objects( + ontology_rid, + object_type, + primary_key, + link_type, + order_by=order_by, + page_size=page_size, + page_token=page_token, + properties=properties, + ) + print("The page_linked_objects response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObject.page_linked_objects: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListLinkedObjectsResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **search** +Search for objects in the specified ontology and object type. The request body is used +to filter objects based on the specified query. The supported queries are: + +| Query type | Description | Supported Types | +|----------|-----------------------------------------------------------------------------------|---------------------------------| +| lt | The provided property is less than the provided value. | number, string, date, timestamp | +| gt | The provided property is greater than the provided value. | number, string, date, timestamp | +| lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp | +| gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp | +| eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp | +| isNull | The provided property is (or is not) null. | all | +| contains | The provided property contains the provided value. | array | +| not | The sub-query does not match. | N/A (applied on a query) | +| and | All the sub-queries match. | N/A (applied on queries) | +| or | At least one of the sub-queries match. | N/A (applied on queries) | +| prefix | The provided property starts with the provided value. | string | +| phrase | The provided property contains the provided value as a substring. | string | +| anyTerm | The provided property contains at least one of the terms separated by whitespace. | string | +| allTerms | The provided property contains all the terms separated by whitespace. | string | | + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**object_type** | ObjectTypeApiName | objectType | | +**fields** | List[PropertyApiName] | The API names of the object type properties to include in the response. | | +**query** | SearchJsonQueryDict | | | +**order_by** | Optional[SearchOrderByDict] | | [optional] | +**page_size** | Optional[PageSize] | | [optional] | +**page_token** | Optional[PageToken] | | [optional] | + +### Return type +**SearchObjectsResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# ObjectTypeApiName | objectType +object_type = "employee" +# List[PropertyApiName] | The API names of the object type properties to include in the response. +fields = None +# SearchJsonQueryDict | +query = {"not": {"field": "properties.age", "eq": 21}} +# Optional[SearchOrderByDict] | +order_by = None +# Optional[PageSize] | +page_size = None +# Optional[PageToken] | +page_token = None + + +try: + api_response = foundry_client.ontologies.OntologyObject.search( + ontology_rid, + object_type, + fields=fields, + query=query, + order_by=order_by, + page_size=page_size, + page_token=page_token, + ) + print("The search response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObject.search: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | SearchObjectsResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + diff --git a/docs/v1/Ontologies/Query.md b/docs/v1/Ontologies/Query.md new file mode 100644 index 00000000..57904b95 --- /dev/null +++ b/docs/v1/Ontologies/Query.md @@ -0,0 +1,68 @@ +# Query + +Method | HTTP request | +------------- | ------------- | +[**execute**](#execute) | **POST** /v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute | + +# **execute** +Executes a Query using the given parameters. Optional parameters do not need to be supplied. +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**query_api_name** | QueryApiName | queryApiName | | +**parameters** | Dict[ParameterId, Optional[DataValue]] | | | + +### Return type +**ExecuteQueryResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# QueryApiName | queryApiName +query_api_name = "getEmployeesInCity" +# Dict[ParameterId, Optional[DataValue]] | +parameters = {"city": "New York"} + + +try: + api_response = foundry_client.ontologies.Query.execute( + ontology_rid, + query_api_name, + parameters=parameters, + ) + print("The execute response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Query.execute: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ExecuteQueryResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + diff --git a/docs/v1/Ontologies/QueryType.md b/docs/v1/Ontologies/QueryType.md new file mode 100644 index 00000000..8b2c3a98 --- /dev/null +++ b/docs/v1/Ontologies/QueryType.md @@ -0,0 +1,191 @@ +# QueryType + +Method | HTTP request | +------------- | ------------- | +[**get**](#get) | **GET** /v1/ontologies/{ontologyRid}/queryTypes/{queryApiName} | +[**list**](#list) | **GET** /v1/ontologies/{ontologyRid}/queryTypes | +[**page**](#page) | **GET** /v1/ontologies/{ontologyRid}/queryTypes | + +# **get** +Gets a specific query type with the given API name. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**query_api_name** | QueryApiName | queryApiName | | + +### Return type +**QueryType** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# QueryApiName | queryApiName +query_api_name = "getEmployeesInCity" + + +try: + api_response = foundry_client.ontologies.Ontology.QueryType.get( + ontology_rid, + query_api_name, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling QueryType.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | QueryType | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **list** +Lists the query types for the given Ontology. + +Each page may be smaller than the requested page size. However, it is guaranteed that if there are more +results available, at least one result will be present in the response. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**page_size** | Optional[PageSize] | pageSize | [optional] | + +### Return type +**ResourceIterator[QueryType]** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# Optional[PageSize] | pageSize +page_size = None + + +try: + for query_type in foundry_client.ontologies.Ontology.QueryType.list( + ontology_rid, + page_size=page_size, + ): + pprint(query_type) +except PalantirRPCException as e: + print("HTTP error when calling QueryType.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListQueryTypesResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + +# **page** +Lists the query types for the given Ontology. + +Each page may be smaller than the requested page size. However, it is guaranteed that if there are more +results available, at least one result will be present in the response. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology_rid** | OntologyRid | ontologyRid | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | + +### Return type +**ListQueryTypesResponse** + +### Example + +```python +from foundry.v1 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyRid | ontologyRid +ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None + + +try: + api_response = foundry_client.ontologies.Ontology.QueryType.page( + ontology_rid, + page_size=page_size, + page_token=page_token, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling QueryType.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListQueryTypesResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to Model list]](../../../README.md#models-v1-link) [[Back to README]](../../../README.md) + diff --git a/docs/v1/core/models/AnyType.md b/docs/v1/core/models/AnyType.md new file mode 100644 index 00000000..c21dbd0a --- /dev/null +++ b/docs/v1/core/models/AnyType.md @@ -0,0 +1,11 @@ +# AnyType + +AnyType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["any"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/AnyTypeDict.md b/docs/v1/core/models/AnyTypeDict.md new file mode 100644 index 00000000..70cd22a2 --- /dev/null +++ b/docs/v1/core/models/AnyTypeDict.md @@ -0,0 +1,11 @@ +# AnyTypeDict + +AnyType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["any"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/BinaryType.md b/docs/v1/core/models/BinaryType.md new file mode 100644 index 00000000..3f2eeb8e --- /dev/null +++ b/docs/v1/core/models/BinaryType.md @@ -0,0 +1,11 @@ +# BinaryType + +BinaryType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["binary"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/BinaryTypeDict.md b/docs/v1/core/models/BinaryTypeDict.md new file mode 100644 index 00000000..f4c01746 --- /dev/null +++ b/docs/v1/core/models/BinaryTypeDict.md @@ -0,0 +1,11 @@ +# BinaryTypeDict + +BinaryType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["binary"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/BooleanType.md b/docs/v1/core/models/BooleanType.md new file mode 100644 index 00000000..9f7b2a5c --- /dev/null +++ b/docs/v1/core/models/BooleanType.md @@ -0,0 +1,11 @@ +# BooleanType + +BooleanType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["boolean"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/BooleanTypeDict.md b/docs/v1/core/models/BooleanTypeDict.md new file mode 100644 index 00000000..14a46067 --- /dev/null +++ b/docs/v1/core/models/BooleanTypeDict.md @@ -0,0 +1,11 @@ +# BooleanTypeDict + +BooleanType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["boolean"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/ByteType.md b/docs/v1/core/models/ByteType.md new file mode 100644 index 00000000..73fd151b --- /dev/null +++ b/docs/v1/core/models/ByteType.md @@ -0,0 +1,11 @@ +# ByteType + +ByteType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["byte"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/ByteTypeDict.md b/docs/v1/core/models/ByteTypeDict.md new file mode 100644 index 00000000..022617c5 --- /dev/null +++ b/docs/v1/core/models/ByteTypeDict.md @@ -0,0 +1,11 @@ +# ByteTypeDict + +ByteType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["byte"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/DateType.md b/docs/v1/core/models/DateType.md new file mode 100644 index 00000000..8af99d8e --- /dev/null +++ b/docs/v1/core/models/DateType.md @@ -0,0 +1,11 @@ +# DateType + +DateType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["date"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/DateTypeDict.md b/docs/v1/core/models/DateTypeDict.md new file mode 100644 index 00000000..6d29ccb3 --- /dev/null +++ b/docs/v1/core/models/DateTypeDict.md @@ -0,0 +1,11 @@ +# DateTypeDict + +DateType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["date"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/DecimalType.md b/docs/v1/core/models/DecimalType.md new file mode 100644 index 00000000..e25830e1 --- /dev/null +++ b/docs/v1/core/models/DecimalType.md @@ -0,0 +1,13 @@ +# DecimalType + +DecimalType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**precision** | Optional[StrictInt] | No | | +**scale** | Optional[StrictInt] | No | | +**type** | Literal["decimal"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/DecimalTypeDict.md b/docs/v1/core/models/DecimalTypeDict.md new file mode 100644 index 00000000..5ac033e2 --- /dev/null +++ b/docs/v1/core/models/DecimalTypeDict.md @@ -0,0 +1,13 @@ +# DecimalTypeDict + +DecimalType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**precision** | NotRequired[StrictInt] | No | | +**scale** | NotRequired[StrictInt] | No | | +**type** | Literal["decimal"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/DisplayName.md b/docs/v1/core/models/DisplayName.md new file mode 100644 index 00000000..f6deecbd --- /dev/null +++ b/docs/v1/core/models/DisplayName.md @@ -0,0 +1,11 @@ +# DisplayName + +The display name of the entity. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/DoubleType.md b/docs/v1/core/models/DoubleType.md new file mode 100644 index 00000000..4988a3bf --- /dev/null +++ b/docs/v1/core/models/DoubleType.md @@ -0,0 +1,11 @@ +# DoubleType + +DoubleType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["double"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/DoubleTypeDict.md b/docs/v1/core/models/DoubleTypeDict.md new file mode 100644 index 00000000..7b7575f6 --- /dev/null +++ b/docs/v1/core/models/DoubleTypeDict.md @@ -0,0 +1,11 @@ +# DoubleTypeDict + +DoubleType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["double"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/Duration.md b/docs/v1/core/models/Duration.md new file mode 100644 index 00000000..437d697f --- /dev/null +++ b/docs/v1/core/models/Duration.md @@ -0,0 +1,11 @@ +# Duration + +An ISO 8601 formatted duration. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/FilePath.md b/docs/v1/core/models/FilePath.md new file mode 100644 index 00000000..ded1c166 --- /dev/null +++ b/docs/v1/core/models/FilePath.md @@ -0,0 +1,12 @@ +# FilePath + +The path to a File within Foundry. Examples: `my-file.txt`, `path/to/my-file.jpg`, `dataframe.snappy.parquet`. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/FloatType.md b/docs/v1/core/models/FloatType.md new file mode 100644 index 00000000..c17f112f --- /dev/null +++ b/docs/v1/core/models/FloatType.md @@ -0,0 +1,11 @@ +# FloatType + +FloatType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["float"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/FloatTypeDict.md b/docs/v1/core/models/FloatTypeDict.md new file mode 100644 index 00000000..7ee76ce5 --- /dev/null +++ b/docs/v1/core/models/FloatTypeDict.md @@ -0,0 +1,11 @@ +# FloatTypeDict + +FloatType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["float"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/FolderRid.md b/docs/v1/core/models/FolderRid.md new file mode 100644 index 00000000..2246753a --- /dev/null +++ b/docs/v1/core/models/FolderRid.md @@ -0,0 +1,11 @@ +# FolderRid + +FolderRid + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/IntegerType.md b/docs/v1/core/models/IntegerType.md new file mode 100644 index 00000000..4da6e781 --- /dev/null +++ b/docs/v1/core/models/IntegerType.md @@ -0,0 +1,11 @@ +# IntegerType + +IntegerType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["integer"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/IntegerTypeDict.md b/docs/v1/core/models/IntegerTypeDict.md new file mode 100644 index 00000000..ddedd4d8 --- /dev/null +++ b/docs/v1/core/models/IntegerTypeDict.md @@ -0,0 +1,11 @@ +# IntegerTypeDict + +IntegerType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["integer"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/LongType.md b/docs/v1/core/models/LongType.md new file mode 100644 index 00000000..073c3c0c --- /dev/null +++ b/docs/v1/core/models/LongType.md @@ -0,0 +1,11 @@ +# LongType + +LongType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["long"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/LongTypeDict.md b/docs/v1/core/models/LongTypeDict.md new file mode 100644 index 00000000..297e1bd2 --- /dev/null +++ b/docs/v1/core/models/LongTypeDict.md @@ -0,0 +1,11 @@ +# LongTypeDict + +LongType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["long"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/MarkingType.md b/docs/v1/core/models/MarkingType.md new file mode 100644 index 00000000..8d803aec --- /dev/null +++ b/docs/v1/core/models/MarkingType.md @@ -0,0 +1,11 @@ +# MarkingType + +MarkingType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["marking"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/MarkingTypeDict.md b/docs/v1/core/models/MarkingTypeDict.md new file mode 100644 index 00000000..61a73bb2 --- /dev/null +++ b/docs/v1/core/models/MarkingTypeDict.md @@ -0,0 +1,11 @@ +# MarkingTypeDict + +MarkingType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["marking"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/PageSize.md b/docs/v1/core/models/PageSize.md new file mode 100644 index 00000000..17441435 --- /dev/null +++ b/docs/v1/core/models/PageSize.md @@ -0,0 +1,11 @@ +# PageSize + +The page size to use for the endpoint. + +## Type +```python +StrictInt +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/PageToken.md b/docs/v1/core/models/PageToken.md new file mode 100644 index 00000000..df525d74 --- /dev/null +++ b/docs/v1/core/models/PageToken.md @@ -0,0 +1,14 @@ +# PageToken + +The page token indicates where to start paging. This should be omitted from the first page's request. +To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response +and populate the next request's `pageToken` field with it. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/PreviewMode.md b/docs/v1/core/models/PreviewMode.md new file mode 100644 index 00000000..fe54cfae --- /dev/null +++ b/docs/v1/core/models/PreviewMode.md @@ -0,0 +1,11 @@ +# PreviewMode + +Enables the use of preview functionality. + +## Type +```python +StrictBool +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/ReleaseStatus.md b/docs/v1/core/models/ReleaseStatus.md new file mode 100644 index 00000000..55deb882 --- /dev/null +++ b/docs/v1/core/models/ReleaseStatus.md @@ -0,0 +1,12 @@ +# ReleaseStatus + +The release status of the entity. + +| **Value** | +| --------- | +| `"ACTIVE"` | +| `"EXPERIMENTAL"` | +| `"DEPRECATED"` | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/ShortType.md b/docs/v1/core/models/ShortType.md new file mode 100644 index 00000000..5279f3e3 --- /dev/null +++ b/docs/v1/core/models/ShortType.md @@ -0,0 +1,11 @@ +# ShortType + +ShortType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["short"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/ShortTypeDict.md b/docs/v1/core/models/ShortTypeDict.md new file mode 100644 index 00000000..7d96cc91 --- /dev/null +++ b/docs/v1/core/models/ShortTypeDict.md @@ -0,0 +1,11 @@ +# ShortTypeDict + +ShortType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["short"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/StringType.md b/docs/v1/core/models/StringType.md new file mode 100644 index 00000000..8ace3c89 --- /dev/null +++ b/docs/v1/core/models/StringType.md @@ -0,0 +1,11 @@ +# StringType + +StringType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["string"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/StringTypeDict.md b/docs/v1/core/models/StringTypeDict.md new file mode 100644 index 00000000..7b98f852 --- /dev/null +++ b/docs/v1/core/models/StringTypeDict.md @@ -0,0 +1,11 @@ +# StringTypeDict + +StringType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["string"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/StructFieldName.md b/docs/v1/core/models/StructFieldName.md new file mode 100644 index 00000000..e86c5214 --- /dev/null +++ b/docs/v1/core/models/StructFieldName.md @@ -0,0 +1,12 @@ +# StructFieldName + +The name of a field in a `Struct`. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/TimestampType.md b/docs/v1/core/models/TimestampType.md new file mode 100644 index 00000000..df7a5d84 --- /dev/null +++ b/docs/v1/core/models/TimestampType.md @@ -0,0 +1,11 @@ +# TimestampType + +TimestampType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["timestamp"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/TimestampTypeDict.md b/docs/v1/core/models/TimestampTypeDict.md new file mode 100644 index 00000000..617eace4 --- /dev/null +++ b/docs/v1/core/models/TimestampTypeDict.md @@ -0,0 +1,11 @@ +# TimestampTypeDict + +TimestampType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["timestamp"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/TotalCount.md b/docs/v1/core/models/TotalCount.md new file mode 100644 index 00000000..074ddb76 --- /dev/null +++ b/docs/v1/core/models/TotalCount.md @@ -0,0 +1,12 @@ +# TotalCount + +The total number of items across all pages. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/UnsupportedType.md b/docs/v1/core/models/UnsupportedType.md new file mode 100644 index 00000000..854a6814 --- /dev/null +++ b/docs/v1/core/models/UnsupportedType.md @@ -0,0 +1,12 @@ +# UnsupportedType + +UnsupportedType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**unsupported_type** | StrictStr | Yes | | +**type** | Literal["unsupported"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/core/models/UnsupportedTypeDict.md b/docs/v1/core/models/UnsupportedTypeDict.md new file mode 100644 index 00000000..cb6cef73 --- /dev/null +++ b/docs/v1/core/models/UnsupportedTypeDict.md @@ -0,0 +1,12 @@ +# UnsupportedTypeDict + +UnsupportedType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**unsupportedType** | StrictStr | Yes | | +**type** | Literal["unsupported"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/Branch.md b/docs/v1/datasets/models/Branch.md new file mode 100644 index 00000000..f8ee0ecb --- /dev/null +++ b/docs/v1/datasets/models/Branch.md @@ -0,0 +1,13 @@ +# Branch + +A Branch of a Dataset. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**branch_id** | BranchId | Yes | | +**transaction_rid** | Optional[TransactionRid] | No | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/BranchDict.md b/docs/v1/datasets/models/BranchDict.md new file mode 100644 index 00000000..0a7b49ef --- /dev/null +++ b/docs/v1/datasets/models/BranchDict.md @@ -0,0 +1,13 @@ +# BranchDict + +A Branch of a Dataset. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**branchId** | BranchId | Yes | | +**transactionRid** | NotRequired[TransactionRid] | No | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/BranchId.md b/docs/v1/datasets/models/BranchId.md new file mode 100644 index 00000000..337ba79c --- /dev/null +++ b/docs/v1/datasets/models/BranchId.md @@ -0,0 +1,12 @@ +# BranchId + +The identifier (name) of a Branch. Example: `master`. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/Dataset.md b/docs/v1/datasets/models/Dataset.md new file mode 100644 index 00000000..25ac2728 --- /dev/null +++ b/docs/v1/datasets/models/Dataset.md @@ -0,0 +1,13 @@ +# Dataset + +Dataset + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | DatasetRid | Yes | | +**name** | DatasetName | Yes | | +**parent_folder_rid** | FolderRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/DatasetDict.md b/docs/v1/datasets/models/DatasetDict.md new file mode 100644 index 00000000..c53421c2 --- /dev/null +++ b/docs/v1/datasets/models/DatasetDict.md @@ -0,0 +1,13 @@ +# DatasetDict + +Dataset + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | DatasetRid | Yes | | +**name** | DatasetName | Yes | | +**parentFolderRid** | FolderRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/DatasetName.md b/docs/v1/datasets/models/DatasetName.md new file mode 100644 index 00000000..1aa77cb2 --- /dev/null +++ b/docs/v1/datasets/models/DatasetName.md @@ -0,0 +1,11 @@ +# DatasetName + +DatasetName + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/DatasetRid.md b/docs/v1/datasets/models/DatasetRid.md new file mode 100644 index 00000000..684774e5 --- /dev/null +++ b/docs/v1/datasets/models/DatasetRid.md @@ -0,0 +1,12 @@ +# DatasetRid + +The Resource Identifier (RID) of a Dataset. Example: `ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da`. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/File.md b/docs/v1/datasets/models/File.md new file mode 100644 index 00000000..1345f43b --- /dev/null +++ b/docs/v1/datasets/models/File.md @@ -0,0 +1,14 @@ +# File + +File + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**path** | FilePath | Yes | | +**transaction_rid** | TransactionRid | Yes | | +**size_bytes** | Optional[StrictStr] | No | | +**updated_time** | datetime | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/FileDict.md b/docs/v1/datasets/models/FileDict.md new file mode 100644 index 00000000..b0e1a51d --- /dev/null +++ b/docs/v1/datasets/models/FileDict.md @@ -0,0 +1,14 @@ +# FileDict + +File + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**path** | FilePath | Yes | | +**transactionRid** | TransactionRid | Yes | | +**sizeBytes** | NotRequired[StrictStr] | No | | +**updatedTime** | datetime | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/ListBranchesResponse.md b/docs/v1/datasets/models/ListBranchesResponse.md new file mode 100644 index 00000000..d22e2780 --- /dev/null +++ b/docs/v1/datasets/models/ListBranchesResponse.md @@ -0,0 +1,12 @@ +# ListBranchesResponse + +ListBranchesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[Branch] | Yes | The list of branches in the current page. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/ListBranchesResponseDict.md b/docs/v1/datasets/models/ListBranchesResponseDict.md new file mode 100644 index 00000000..9e36d3d3 --- /dev/null +++ b/docs/v1/datasets/models/ListBranchesResponseDict.md @@ -0,0 +1,12 @@ +# ListBranchesResponseDict + +ListBranchesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[BranchDict] | Yes | The list of branches in the current page. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/ListFilesResponse.md b/docs/v1/datasets/models/ListFilesResponse.md new file mode 100644 index 00000000..587bb0ed --- /dev/null +++ b/docs/v1/datasets/models/ListFilesResponse.md @@ -0,0 +1,12 @@ +# ListFilesResponse + +A page of Files and an optional page token that can be used to retrieve the next page. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[File] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/ListFilesResponseDict.md b/docs/v1/datasets/models/ListFilesResponseDict.md new file mode 100644 index 00000000..45801410 --- /dev/null +++ b/docs/v1/datasets/models/ListFilesResponseDict.md @@ -0,0 +1,12 @@ +# ListFilesResponseDict + +A page of Files and an optional page token that can be used to retrieve the next page. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[FileDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/TableExportFormat.md b/docs/v1/datasets/models/TableExportFormat.md new file mode 100644 index 00000000..233740a3 --- /dev/null +++ b/docs/v1/datasets/models/TableExportFormat.md @@ -0,0 +1,12 @@ +# TableExportFormat + +Format for tabular dataset export. + + +| **Value** | +| --------- | +| `"ARROW"` | +| `"CSV"` | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/Transaction.md b/docs/v1/datasets/models/Transaction.md new file mode 100644 index 00000000..3f5568ae --- /dev/null +++ b/docs/v1/datasets/models/Transaction.md @@ -0,0 +1,16 @@ +# Transaction + +An operation that modifies the files within a dataset. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | TransactionRid | Yes | | +**transaction_type** | TransactionType | Yes | | +**status** | TransactionStatus | Yes | | +**created_time** | datetime | Yes | The timestamp when the transaction was created, in ISO 8601 timestamp format. | +**closed_time** | Optional[datetime] | No | The timestamp when the transaction was closed, in ISO 8601 timestamp format. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/TransactionDict.md b/docs/v1/datasets/models/TransactionDict.md new file mode 100644 index 00000000..5279105c --- /dev/null +++ b/docs/v1/datasets/models/TransactionDict.md @@ -0,0 +1,16 @@ +# TransactionDict + +An operation that modifies the files within a dataset. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | TransactionRid | Yes | | +**transactionType** | TransactionType | Yes | | +**status** | TransactionStatus | Yes | | +**createdTime** | datetime | Yes | The timestamp when the transaction was created, in ISO 8601 timestamp format. | +**closedTime** | NotRequired[datetime] | No | The timestamp when the transaction was closed, in ISO 8601 timestamp format. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/TransactionRid.md b/docs/v1/datasets/models/TransactionRid.md new file mode 100644 index 00000000..09b56748 --- /dev/null +++ b/docs/v1/datasets/models/TransactionRid.md @@ -0,0 +1,12 @@ +# TransactionRid + +The Resource Identifier (RID) of a Transaction. Example: `ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4`. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/TransactionStatus.md b/docs/v1/datasets/models/TransactionStatus.md new file mode 100644 index 00000000..46171254 --- /dev/null +++ b/docs/v1/datasets/models/TransactionStatus.md @@ -0,0 +1,13 @@ +# TransactionStatus + +The status of a Transaction. + + +| **Value** | +| --------- | +| `"ABORTED"` | +| `"COMMITTED"` | +| `"OPEN"` | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/datasets/models/TransactionType.md b/docs/v1/datasets/models/TransactionType.md new file mode 100644 index 00000000..d3484948 --- /dev/null +++ b/docs/v1/datasets/models/TransactionType.md @@ -0,0 +1,14 @@ +# TransactionType + +The type of a Transaction. + + +| **Value** | +| --------- | +| `"APPEND"` | +| `"UPDATE"` | +| `"SNAPSHOT"` | +| `"DELETE"` | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/models/AbsoluteTimeRange.md b/docs/v1/models/AbsoluteTimeRange.md deleted file mode 100644 index e8cb686f..00000000 --- a/docs/v1/models/AbsoluteTimeRange.md +++ /dev/null @@ -1,13 +0,0 @@ -# AbsoluteTimeRange - -ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**start_time** | Optional[datetime] | No | | -**end_time** | Optional[datetime] | No | | -**type** | Literal["absolute"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AbsoluteTimeRangeDict.md b/docs/v1/models/AbsoluteTimeRangeDict.md deleted file mode 100644 index 1a7428a8..00000000 --- a/docs/v1/models/AbsoluteTimeRangeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AbsoluteTimeRangeDict - -ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**startTime** | NotRequired[datetime] | No | | -**endTime** | NotRequired[datetime] | No | | -**type** | Literal["absolute"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionMode.md b/docs/v1/models/ActionMode.md deleted file mode 100644 index bc82d08a..00000000 --- a/docs/v1/models/ActionMode.md +++ /dev/null @@ -1,12 +0,0 @@ -# ActionMode - -ActionMode - -| **Value** | -| --------- | -| `"ASYNC"` | -| `"RUN"` | -| `"VALIDATE"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionParameterArrayType.md b/docs/v1/models/ActionParameterArrayType.md deleted file mode 100644 index c10f3f4d..00000000 --- a/docs/v1/models/ActionParameterArrayType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ActionParameterArrayType - -ActionParameterArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**sub_type** | ActionParameterType | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionParameterArrayTypeDict.md b/docs/v1/models/ActionParameterArrayTypeDict.md deleted file mode 100644 index 1c5dcc51..00000000 --- a/docs/v1/models/ActionParameterArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ActionParameterArrayTypeDict - -ActionParameterArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | ActionParameterTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionParameterType.md b/docs/v1/models/ActionParameterType.md deleted file mode 100644 index aef07653..00000000 --- a/docs/v1/models/ActionParameterType.md +++ /dev/null @@ -1,27 +0,0 @@ -# ActionParameterType - -A union of all the types supported by Ontology Action parameters. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ActionParameterArrayType](ActionParameterArrayType.md) | array -[AttachmentType](AttachmentType.md) | attachment -[BooleanType](BooleanType.md) | boolean -[DateType](DateType.md) | date -[DoubleType](DoubleType.md) | double -[IntegerType](IntegerType.md) | integer -[LongType](LongType.md) | long -[MarkingType](MarkingType.md) | marking -[OntologyObjectSetType](OntologyObjectSetType.md) | objectSet -[OntologyObjectType](OntologyObjectType.md) | object -[StringType](StringType.md) | string -[TimestampType](TimestampType.md) | timestamp - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionParameterTypeDict.md b/docs/v1/models/ActionParameterTypeDict.md deleted file mode 100644 index 7459b55d..00000000 --- a/docs/v1/models/ActionParameterTypeDict.md +++ /dev/null @@ -1,27 +0,0 @@ -# ActionParameterTypeDict - -A union of all the types supported by Ontology Action parameters. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ActionParameterArrayTypeDict](ActionParameterArrayTypeDict.md) | array -[AttachmentTypeDict](AttachmentTypeDict.md) | attachment -[BooleanTypeDict](BooleanTypeDict.md) | boolean -[DateTypeDict](DateTypeDict.md) | date -[DoubleTypeDict](DoubleTypeDict.md) | double -[IntegerTypeDict](IntegerTypeDict.md) | integer -[LongTypeDict](LongTypeDict.md) | long -[MarkingTypeDict](MarkingTypeDict.md) | marking -[OntologyObjectSetTypeDict](OntologyObjectSetTypeDict.md) | objectSet -[OntologyObjectTypeDict](OntologyObjectTypeDict.md) | object -[StringTypeDict](StringTypeDict.md) | string -[TimestampTypeDict](TimestampTypeDict.md) | timestamp - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionParameterV2.md b/docs/v1/models/ActionParameterV2.md deleted file mode 100644 index 39049193..00000000 --- a/docs/v1/models/ActionParameterV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# ActionParameterV2 - -Details about a parameter of an action. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | Optional[StrictStr] | No | | -**data_type** | ActionParameterType | Yes | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionParameterV2Dict.md b/docs/v1/models/ActionParameterV2Dict.md deleted file mode 100644 index 8c08cf6f..00000000 --- a/docs/v1/models/ActionParameterV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ActionParameterV2Dict - -Details about a parameter of an action. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[StrictStr] | No | | -**dataType** | ActionParameterTypeDict | Yes | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionResults.md b/docs/v1/models/ActionResults.md deleted file mode 100644 index 956b88bd..00000000 --- a/docs/v1/models/ActionResults.md +++ /dev/null @@ -1,16 +0,0 @@ -# ActionResults - -ActionResults - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectEdits](ObjectEdits.md) | edits -[ObjectTypeEdits](ObjectTypeEdits.md) | largeScaleEdits - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionResultsDict.md b/docs/v1/models/ActionResultsDict.md deleted file mode 100644 index b5638c97..00000000 --- a/docs/v1/models/ActionResultsDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ActionResultsDict - -ActionResults - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectEditsDict](ObjectEditsDict.md) | edits -[ObjectTypeEditsDict](ObjectTypeEditsDict.md) | largeScaleEdits - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionRid.md b/docs/v1/models/ActionRid.md deleted file mode 100644 index db4397b0..00000000 --- a/docs/v1/models/ActionRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ActionRid - -The unique resource identifier for an action. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionType.md b/docs/v1/models/ActionType.md deleted file mode 100644 index 7a85944d..00000000 --- a/docs/v1/models/ActionType.md +++ /dev/null @@ -1,17 +0,0 @@ -# ActionType - -Represents an action type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | ActionTypeApiName | Yes | | -**description** | Optional[StrictStr] | No | | -**display_name** | Optional[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**parameters** | Dict[ParameterId, Parameter] | Yes | | -**rid** | ActionTypeRid | Yes | | -**operations** | List[LogicRule] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionTypeApiName.md b/docs/v1/models/ActionTypeApiName.md deleted file mode 100644 index 03c887a3..00000000 --- a/docs/v1/models/ActionTypeApiName.md +++ /dev/null @@ -1,13 +0,0 @@ -# ActionTypeApiName - -The name of the action type in the API. To find the API name for your Action Type, use the `List action types` -endpoint or check the **Ontology Manager**. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionTypeDict.md b/docs/v1/models/ActionTypeDict.md deleted file mode 100644 index c10b4717..00000000 --- a/docs/v1/models/ActionTypeDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ActionTypeDict - -Represents an action type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ActionTypeApiName | Yes | | -**description** | NotRequired[StrictStr] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**parameters** | Dict[ParameterId, ParameterDict] | Yes | | -**rid** | ActionTypeRid | Yes | | -**operations** | List[LogicRuleDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionTypeRid.md b/docs/v1/models/ActionTypeRid.md deleted file mode 100644 index 4a2ac963..00000000 --- a/docs/v1/models/ActionTypeRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# ActionTypeRid - -The unique resource identifier of an action type, useful for interacting with other Foundry APIs. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionTypeV2.md b/docs/v1/models/ActionTypeV2.md deleted file mode 100644 index cc13e33b..00000000 --- a/docs/v1/models/ActionTypeV2.md +++ /dev/null @@ -1,17 +0,0 @@ -# ActionTypeV2 - -Represents an action type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | ActionTypeApiName | Yes | | -**description** | Optional[StrictStr] | No | | -**display_name** | Optional[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**parameters** | Dict[ParameterId, ActionParameterV2] | Yes | | -**rid** | ActionTypeRid | Yes | | -**operations** | List[LogicRule] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ActionTypeV2Dict.md b/docs/v1/models/ActionTypeV2Dict.md deleted file mode 100644 index 0ef777c8..00000000 --- a/docs/v1/models/ActionTypeV2Dict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ActionTypeV2Dict - -Represents an action type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ActionTypeApiName | Yes | | -**description** | NotRequired[StrictStr] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**parameters** | Dict[ParameterId, ActionParameterV2Dict] | Yes | | -**rid** | ActionTypeRid | Yes | | -**operations** | List[LogicRuleDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AddLink.md b/docs/v1/models/AddLink.md deleted file mode 100644 index 7b817872..00000000 --- a/docs/v1/models/AddLink.md +++ /dev/null @@ -1,15 +0,0 @@ -# AddLink - -AddLink - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**link_type_api_name_ato_b** | LinkTypeApiName | Yes | | -**link_type_api_name_bto_a** | LinkTypeApiName | Yes | | -**a_side_object** | LinkSideObject | Yes | | -**b_side_object** | LinkSideObject | Yes | | -**type** | Literal["addLink"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AddLinkDict.md b/docs/v1/models/AddLinkDict.md deleted file mode 100644 index a5739b3f..00000000 --- a/docs/v1/models/AddLinkDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# AddLinkDict - -AddLink - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | -**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | -**aSideObject** | LinkSideObjectDict | Yes | | -**bSideObject** | LinkSideObjectDict | Yes | | -**type** | Literal["addLink"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AddObject.md b/docs/v1/models/AddObject.md deleted file mode 100644 index 4f8a1ae0..00000000 --- a/docs/v1/models/AddObject.md +++ /dev/null @@ -1,13 +0,0 @@ -# AddObject - -AddObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primary_key** | PropertyValue | Yes | | -**object_type** | ObjectTypeApiName | Yes | | -**type** | Literal["addObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AddObjectDict.md b/docs/v1/models/AddObjectDict.md deleted file mode 100644 index 39516125..00000000 --- a/docs/v1/models/AddObjectDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AddObjectDict - -AddObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primaryKey** | PropertyValue | Yes | | -**objectType** | ObjectTypeApiName | Yes | | -**type** | Literal["addObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregateObjectSetRequestV2.md b/docs/v1/models/AggregateObjectSetRequestV2.md deleted file mode 100644 index 28740750..00000000 --- a/docs/v1/models/AggregateObjectSetRequestV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# AggregateObjectSetRequestV2 - -AggregateObjectSetRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**aggregation** | List[AggregationV2] | Yes | | -**object_set** | ObjectSet | Yes | | -**group_by** | List[AggregationGroupByV2] | Yes | | -**accuracy** | Optional[AggregationAccuracyRequest] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregateObjectSetRequestV2Dict.md b/docs/v1/models/AggregateObjectSetRequestV2Dict.md deleted file mode 100644 index 88079a80..00000000 --- a/docs/v1/models/AggregateObjectSetRequestV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AggregateObjectSetRequestV2Dict - -AggregateObjectSetRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**aggregation** | List[AggregationV2Dict] | Yes | | -**objectSet** | ObjectSetDict | Yes | | -**groupBy** | List[AggregationGroupByV2Dict] | Yes | | -**accuracy** | NotRequired[AggregationAccuracyRequest] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregateObjectsRequest.md b/docs/v1/models/AggregateObjectsRequest.md deleted file mode 100644 index 483cbd0a..00000000 --- a/docs/v1/models/AggregateObjectsRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregateObjectsRequest - -AggregateObjectsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**aggregation** | List[Aggregation] | Yes | | -**query** | Optional[SearchJsonQuery] | No | | -**group_by** | List[AggregationGroupBy] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregateObjectsRequestDict.md b/docs/v1/models/AggregateObjectsRequestDict.md deleted file mode 100644 index 8459396a..00000000 --- a/docs/v1/models/AggregateObjectsRequestDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregateObjectsRequestDict - -AggregateObjectsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**aggregation** | List[AggregationDict] | Yes | | -**query** | NotRequired[SearchJsonQueryDict] | No | | -**groupBy** | List[AggregationGroupByDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregateObjectsRequestV2.md b/docs/v1/models/AggregateObjectsRequestV2.md deleted file mode 100644 index f714059f..00000000 --- a/docs/v1/models/AggregateObjectsRequestV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# AggregateObjectsRequestV2 - -AggregateObjectsRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**aggregation** | List[AggregationV2] | Yes | | -**where** | Optional[SearchJsonQueryV2] | No | | -**group_by** | List[AggregationGroupByV2] | Yes | | -**accuracy** | Optional[AggregationAccuracyRequest] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregateObjectsRequestV2Dict.md b/docs/v1/models/AggregateObjectsRequestV2Dict.md deleted file mode 100644 index 4104fb91..00000000 --- a/docs/v1/models/AggregateObjectsRequestV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AggregateObjectsRequestV2Dict - -AggregateObjectsRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**aggregation** | List[AggregationV2Dict] | Yes | | -**where** | NotRequired[SearchJsonQueryV2Dict] | No | | -**groupBy** | List[AggregationGroupByV2Dict] | Yes | | -**accuracy** | NotRequired[AggregationAccuracyRequest] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregateObjectsResponse.md b/docs/v1/models/AggregateObjectsResponse.md deleted file mode 100644 index 7ad5cc9c..00000000 --- a/docs/v1/models/AggregateObjectsResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregateObjectsResponse - -AggregateObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**excluded_items** | Optional[StrictInt] | No | | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[AggregateObjectsResponseItem] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregateObjectsResponseDict.md b/docs/v1/models/AggregateObjectsResponseDict.md deleted file mode 100644 index 70f8c690..00000000 --- a/docs/v1/models/AggregateObjectsResponseDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregateObjectsResponseDict - -AggregateObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**excludedItems** | NotRequired[StrictInt] | No | | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[AggregateObjectsResponseItemDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregateObjectsResponseItem.md b/docs/v1/models/AggregateObjectsResponseItem.md deleted file mode 100644 index 37ed0141..00000000 --- a/docs/v1/models/AggregateObjectsResponseItem.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregateObjectsResponseItem - -AggregateObjectsResponseItem - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**group** | Dict[AggregationGroupKey, AggregationGroupValue] | Yes | | -**metrics** | List[AggregationMetricResult] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregateObjectsResponseItemDict.md b/docs/v1/models/AggregateObjectsResponseItemDict.md deleted file mode 100644 index fd974b4e..00000000 --- a/docs/v1/models/AggregateObjectsResponseItemDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregateObjectsResponseItemDict - -AggregateObjectsResponseItem - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**group** | Dict[AggregationGroupKey, AggregationGroupValue] | Yes | | -**metrics** | List[AggregationMetricResultDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregateObjectsResponseItemV2.md b/docs/v1/models/AggregateObjectsResponseItemV2.md deleted file mode 100644 index 9095d649..00000000 --- a/docs/v1/models/AggregateObjectsResponseItemV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregateObjectsResponseItemV2 - -AggregateObjectsResponseItemV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**group** | Dict[AggregationGroupKeyV2, AggregationGroupValueV2] | Yes | | -**metrics** | List[AggregationMetricResultV2] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregateObjectsResponseItemV2Dict.md b/docs/v1/models/AggregateObjectsResponseItemV2Dict.md deleted file mode 100644 index 769e9c6c..00000000 --- a/docs/v1/models/AggregateObjectsResponseItemV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregateObjectsResponseItemV2Dict - -AggregateObjectsResponseItemV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**group** | Dict[AggregationGroupKeyV2, AggregationGroupValueV2] | Yes | | -**metrics** | List[AggregationMetricResultV2Dict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregateObjectsResponseV2.md b/docs/v1/models/AggregateObjectsResponseV2.md deleted file mode 100644 index f73862fb..00000000 --- a/docs/v1/models/AggregateObjectsResponseV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregateObjectsResponseV2 - -AggregateObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**excluded_items** | Optional[StrictInt] | No | | -**accuracy** | AggregationAccuracy | Yes | | -**data** | List[AggregateObjectsResponseItemV2] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregateObjectsResponseV2Dict.md b/docs/v1/models/AggregateObjectsResponseV2Dict.md deleted file mode 100644 index 4fca5338..00000000 --- a/docs/v1/models/AggregateObjectsResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregateObjectsResponseV2Dict - -AggregateObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**excludedItems** | NotRequired[StrictInt] | No | | -**accuracy** | AggregationAccuracy | Yes | | -**data** | List[AggregateObjectsResponseItemV2Dict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Aggregation.md b/docs/v1/models/Aggregation.md deleted file mode 100644 index 88327d48..00000000 --- a/docs/v1/models/Aggregation.md +++ /dev/null @@ -1,20 +0,0 @@ -# Aggregation - -Specifies an aggregation function. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[MaxAggregation](MaxAggregation.md) | max -[MinAggregation](MinAggregation.md) | min -[AvgAggregation](AvgAggregation.md) | avg -[SumAggregation](SumAggregation.md) | sum -[CountAggregation](CountAggregation.md) | count -[ApproximateDistinctAggregation](ApproximateDistinctAggregation.md) | approximateDistinct - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationAccuracy.md b/docs/v1/models/AggregationAccuracy.md deleted file mode 100644 index 95286559..00000000 --- a/docs/v1/models/AggregationAccuracy.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationAccuracy - -AggregationAccuracy - -| **Value** | -| --------- | -| `"ACCURATE"` | -| `"APPROXIMATE"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationAccuracyRequest.md b/docs/v1/models/AggregationAccuracyRequest.md deleted file mode 100644 index 55dad4b7..00000000 --- a/docs/v1/models/AggregationAccuracyRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationAccuracyRequest - -AggregationAccuracyRequest - -| **Value** | -| --------- | -| `"REQUIRE_ACCURATE"` | -| `"ALLOW_APPROXIMATE"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationDict.md b/docs/v1/models/AggregationDict.md deleted file mode 100644 index e5836c96..00000000 --- a/docs/v1/models/AggregationDict.md +++ /dev/null @@ -1,20 +0,0 @@ -# AggregationDict - -Specifies an aggregation function. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[MaxAggregationDict](MaxAggregationDict.md) | max -[MinAggregationDict](MinAggregationDict.md) | min -[AvgAggregationDict](AvgAggregationDict.md) | avg -[SumAggregationDict](SumAggregationDict.md) | sum -[CountAggregationDict](CountAggregationDict.md) | count -[ApproximateDistinctAggregationDict](ApproximateDistinctAggregationDict.md) | approximateDistinct - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationDurationGrouping.md b/docs/v1/models/AggregationDurationGrouping.md deleted file mode 100644 index d920be86..00000000 --- a/docs/v1/models/AggregationDurationGrouping.md +++ /dev/null @@ -1,15 +0,0 @@ -# AggregationDurationGrouping - -Divides objects into groups according to an interval. Note that this grouping applies only on date types. -The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**duration** | Duration | Yes | | -**type** | Literal["duration"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationDurationGroupingDict.md b/docs/v1/models/AggregationDurationGroupingDict.md deleted file mode 100644 index 52dd4d03..00000000 --- a/docs/v1/models/AggregationDurationGroupingDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# AggregationDurationGroupingDict - -Divides objects into groups according to an interval. Note that this grouping applies only on date types. -The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**duration** | Duration | Yes | | -**type** | Literal["duration"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationDurationGroupingV2.md b/docs/v1/models/AggregationDurationGroupingV2.md deleted file mode 100644 index c485b6e6..00000000 --- a/docs/v1/models/AggregationDurationGroupingV2.md +++ /dev/null @@ -1,16 +0,0 @@ -# AggregationDurationGroupingV2 - -Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. -When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictInt | Yes | | -**unit** | TimeUnit | Yes | | -**type** | Literal["duration"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationDurationGroupingV2Dict.md b/docs/v1/models/AggregationDurationGroupingV2Dict.md deleted file mode 100644 index 98609739..00000000 --- a/docs/v1/models/AggregationDurationGroupingV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# AggregationDurationGroupingV2Dict - -Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. -When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictInt | Yes | | -**unit** | TimeUnit | Yes | | -**type** | Literal["duration"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationExactGrouping.md b/docs/v1/models/AggregationExactGrouping.md deleted file mode 100644 index de32607e..00000000 --- a/docs/v1/models/AggregationExactGrouping.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationExactGrouping - -Divides objects into groups according to an exact value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**max_group_count** | Optional[StrictInt] | No | | -**type** | Literal["exact"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationExactGroupingDict.md b/docs/v1/models/AggregationExactGroupingDict.md deleted file mode 100644 index 25557d60..00000000 --- a/docs/v1/models/AggregationExactGroupingDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationExactGroupingDict - -Divides objects into groups according to an exact value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**maxGroupCount** | NotRequired[StrictInt] | No | | -**type** | Literal["exact"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationExactGroupingV2.md b/docs/v1/models/AggregationExactGroupingV2.md deleted file mode 100644 index aa625ac2..00000000 --- a/docs/v1/models/AggregationExactGroupingV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationExactGroupingV2 - -Divides objects into groups according to an exact value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**max_group_count** | Optional[StrictInt] | No | | -**type** | Literal["exact"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationExactGroupingV2Dict.md b/docs/v1/models/AggregationExactGroupingV2Dict.md deleted file mode 100644 index c9658074..00000000 --- a/docs/v1/models/AggregationExactGroupingV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationExactGroupingV2Dict - -Divides objects into groups according to an exact value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**maxGroupCount** | NotRequired[StrictInt] | No | | -**type** | Literal["exact"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationFixedWidthGrouping.md b/docs/v1/models/AggregationFixedWidthGrouping.md deleted file mode 100644 index c12cda75..00000000 --- a/docs/v1/models/AggregationFixedWidthGrouping.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationFixedWidthGrouping - -Divides objects into groups with the specified width. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**fixed_width** | StrictInt | Yes | | -**type** | Literal["fixedWidth"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationFixedWidthGroupingDict.md b/docs/v1/models/AggregationFixedWidthGroupingDict.md deleted file mode 100644 index d0524a4e..00000000 --- a/docs/v1/models/AggregationFixedWidthGroupingDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationFixedWidthGroupingDict - -Divides objects into groups with the specified width. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**fixedWidth** | StrictInt | Yes | | -**type** | Literal["fixedWidth"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationFixedWidthGroupingV2.md b/docs/v1/models/AggregationFixedWidthGroupingV2.md deleted file mode 100644 index 942df513..00000000 --- a/docs/v1/models/AggregationFixedWidthGroupingV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationFixedWidthGroupingV2 - -Divides objects into groups with the specified width. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**fixed_width** | StrictInt | Yes | | -**type** | Literal["fixedWidth"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationFixedWidthGroupingV2Dict.md b/docs/v1/models/AggregationFixedWidthGroupingV2Dict.md deleted file mode 100644 index ec70df61..00000000 --- a/docs/v1/models/AggregationFixedWidthGroupingV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationFixedWidthGroupingV2Dict - -Divides objects into groups with the specified width. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**fixedWidth** | StrictInt | Yes | | -**type** | Literal["fixedWidth"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationGroupBy.md b/docs/v1/models/AggregationGroupBy.md deleted file mode 100644 index 92a7453d..00000000 --- a/docs/v1/models/AggregationGroupBy.md +++ /dev/null @@ -1,18 +0,0 @@ -# AggregationGroupBy - -Specifies a grouping for aggregation results. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AggregationFixedWidthGrouping](AggregationFixedWidthGrouping.md) | fixedWidth -[AggregationRangesGrouping](AggregationRangesGrouping.md) | ranges -[AggregationExactGrouping](AggregationExactGrouping.md) | exact -[AggregationDurationGrouping](AggregationDurationGrouping.md) | duration - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationGroupByDict.md b/docs/v1/models/AggregationGroupByDict.md deleted file mode 100644 index 8f425d75..00000000 --- a/docs/v1/models/AggregationGroupByDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# AggregationGroupByDict - -Specifies a grouping for aggregation results. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AggregationFixedWidthGroupingDict](AggregationFixedWidthGroupingDict.md) | fixedWidth -[AggregationRangesGroupingDict](AggregationRangesGroupingDict.md) | ranges -[AggregationExactGroupingDict](AggregationExactGroupingDict.md) | exact -[AggregationDurationGroupingDict](AggregationDurationGroupingDict.md) | duration - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationGroupByV2.md b/docs/v1/models/AggregationGroupByV2.md deleted file mode 100644 index 6c21c909..00000000 --- a/docs/v1/models/AggregationGroupByV2.md +++ /dev/null @@ -1,18 +0,0 @@ -# AggregationGroupByV2 - -Specifies a grouping for aggregation results. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AggregationFixedWidthGroupingV2](AggregationFixedWidthGroupingV2.md) | fixedWidth -[AggregationRangesGroupingV2](AggregationRangesGroupingV2.md) | ranges -[AggregationExactGroupingV2](AggregationExactGroupingV2.md) | exact -[AggregationDurationGroupingV2](AggregationDurationGroupingV2.md) | duration - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationGroupByV2Dict.md b/docs/v1/models/AggregationGroupByV2Dict.md deleted file mode 100644 index db9b42ba..00000000 --- a/docs/v1/models/AggregationGroupByV2Dict.md +++ /dev/null @@ -1,18 +0,0 @@ -# AggregationGroupByV2Dict - -Specifies a grouping for aggregation results. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AggregationFixedWidthGroupingV2Dict](AggregationFixedWidthGroupingV2Dict.md) | fixedWidth -[AggregationRangesGroupingV2Dict](AggregationRangesGroupingV2Dict.md) | ranges -[AggregationExactGroupingV2Dict](AggregationExactGroupingV2Dict.md) | exact -[AggregationDurationGroupingV2Dict](AggregationDurationGroupingV2Dict.md) | duration - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationGroupKey.md b/docs/v1/models/AggregationGroupKey.md deleted file mode 100644 index 9cdee0c2..00000000 --- a/docs/v1/models/AggregationGroupKey.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationGroupKey - -AggregationGroupKey - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationGroupKeyV2.md b/docs/v1/models/AggregationGroupKeyV2.md deleted file mode 100644 index 5c8f1742..00000000 --- a/docs/v1/models/AggregationGroupKeyV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationGroupKeyV2 - -AggregationGroupKeyV2 - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationGroupValue.md b/docs/v1/models/AggregationGroupValue.md deleted file mode 100644 index e5da82fe..00000000 --- a/docs/v1/models/AggregationGroupValue.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationGroupValue - -AggregationGroupValue - -## Type -```python -Any -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationGroupValueV2.md b/docs/v1/models/AggregationGroupValueV2.md deleted file mode 100644 index fcd63d71..00000000 --- a/docs/v1/models/AggregationGroupValueV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationGroupValueV2 - -AggregationGroupValueV2 - -## Type -```python -Any -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationMetricName.md b/docs/v1/models/AggregationMetricName.md deleted file mode 100644 index cf287399..00000000 --- a/docs/v1/models/AggregationMetricName.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationMetricName - -A user-specified alias for an aggregation metric name. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationMetricResult.md b/docs/v1/models/AggregationMetricResult.md deleted file mode 100644 index 183e5d9a..00000000 --- a/docs/v1/models/AggregationMetricResult.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationMetricResult - -AggregationMetricResult - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StrictStr | Yes | | -**value** | Optional[StrictFloat] | No | TBD | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationMetricResultDict.md b/docs/v1/models/AggregationMetricResultDict.md deleted file mode 100644 index 527306e0..00000000 --- a/docs/v1/models/AggregationMetricResultDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationMetricResultDict - -AggregationMetricResult - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StrictStr | Yes | | -**value** | NotRequired[StrictFloat] | No | TBD | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationMetricResultV2.md b/docs/v1/models/AggregationMetricResultV2.md deleted file mode 100644 index c86c24b1..00000000 --- a/docs/v1/models/AggregationMetricResultV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationMetricResultV2 - -AggregationMetricResultV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StrictStr | Yes | | -**value** | Optional[Any] | No | The value of the metric. This will be a double in the case of a numeric metric, or a date string in the case of a date metric. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationMetricResultV2Dict.md b/docs/v1/models/AggregationMetricResultV2Dict.md deleted file mode 100644 index 094046b3..00000000 --- a/docs/v1/models/AggregationMetricResultV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationMetricResultV2Dict - -AggregationMetricResultV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StrictStr | Yes | | -**value** | NotRequired[Any] | No | The value of the metric. This will be a double in the case of a numeric metric, or a date string in the case of a date metric. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationObjectTypeGrouping.md b/docs/v1/models/AggregationObjectTypeGrouping.md deleted file mode 100644 index 663fc649..00000000 --- a/docs/v1/models/AggregationObjectTypeGrouping.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationObjectTypeGrouping - -Divides objects into groups based on their object type. This grouping is only useful when aggregating across -multiple object types, such as when aggregating over an interface type. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationObjectTypeGroupingDict.md b/docs/v1/models/AggregationObjectTypeGroupingDict.md deleted file mode 100644 index dc07f940..00000000 --- a/docs/v1/models/AggregationObjectTypeGroupingDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationObjectTypeGroupingDict - -Divides objects into groups based on their object type. This grouping is only useful when aggregating across -multiple object types, such as when aggregating over an interface type. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationOrderBy.md b/docs/v1/models/AggregationOrderBy.md deleted file mode 100644 index 9d8ab3c4..00000000 --- a/docs/v1/models/AggregationOrderBy.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationOrderBy - -AggregationOrderBy - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**metric_name** | StrictStr | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationOrderByDict.md b/docs/v1/models/AggregationOrderByDict.md deleted file mode 100644 index 57536736..00000000 --- a/docs/v1/models/AggregationOrderByDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationOrderByDict - -AggregationOrderBy - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**metricName** | StrictStr | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationRange.md b/docs/v1/models/AggregationRange.md deleted file mode 100644 index cb6827e0..00000000 --- a/docs/v1/models/AggregationRange.md +++ /dev/null @@ -1,14 +0,0 @@ -# AggregationRange - -Specifies a date range from an inclusive start date to an exclusive end date. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | Optional[Any] | No | Exclusive end date. | -**lte** | Optional[Any] | No | Inclusive end date. | -**gt** | Optional[Any] | No | Exclusive start date. | -**gte** | Optional[Any] | No | Inclusive start date. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationRangeDict.md b/docs/v1/models/AggregationRangeDict.md deleted file mode 100644 index 521ef8fb..00000000 --- a/docs/v1/models/AggregationRangeDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AggregationRangeDict - -Specifies a date range from an inclusive start date to an exclusive end date. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Exclusive end date. | -**lte** | NotRequired[Any] | No | Inclusive end date. | -**gt** | NotRequired[Any] | No | Exclusive start date. | -**gte** | NotRequired[Any] | No | Inclusive start date. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationRangeV2.md b/docs/v1/models/AggregationRangeV2.md deleted file mode 100644 index 72401736..00000000 --- a/docs/v1/models/AggregationRangeV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationRangeV2 - -Specifies a range from an inclusive start value to an exclusive end value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**start_value** | Any | Yes | Inclusive start. | -**end_value** | Any | Yes | Exclusive end. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationRangeV2Dict.md b/docs/v1/models/AggregationRangeV2Dict.md deleted file mode 100644 index 46bd1317..00000000 --- a/docs/v1/models/AggregationRangeV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationRangeV2Dict - -Specifies a range from an inclusive start value to an exclusive end value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**startValue** | Any | Yes | Inclusive start. | -**endValue** | Any | Yes | Exclusive end. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationRangesGrouping.md b/docs/v1/models/AggregationRangesGrouping.md deleted file mode 100644 index ef062c4a..00000000 --- a/docs/v1/models/AggregationRangesGrouping.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationRangesGrouping - -Divides objects into groups according to specified ranges. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**ranges** | List[AggregationRange] | Yes | | -**type** | Literal["ranges"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationRangesGroupingDict.md b/docs/v1/models/AggregationRangesGroupingDict.md deleted file mode 100644 index 6c2c48ca..00000000 --- a/docs/v1/models/AggregationRangesGroupingDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationRangesGroupingDict - -Divides objects into groups according to specified ranges. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**ranges** | List[AggregationRangeDict] | Yes | | -**type** | Literal["ranges"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationRangesGroupingV2.md b/docs/v1/models/AggregationRangesGroupingV2.md deleted file mode 100644 index 9318ea00..00000000 --- a/docs/v1/models/AggregationRangesGroupingV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationRangesGroupingV2 - -Divides objects into groups according to specified ranges. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**ranges** | List[AggregationRangeV2] | Yes | | -**type** | Literal["ranges"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationRangesGroupingV2Dict.md b/docs/v1/models/AggregationRangesGroupingV2Dict.md deleted file mode 100644 index 7507429e..00000000 --- a/docs/v1/models/AggregationRangesGroupingV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationRangesGroupingV2Dict - -Divides objects into groups according to specified ranges. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**ranges** | List[AggregationRangeV2Dict] | Yes | | -**type** | Literal["ranges"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationV2.md b/docs/v1/models/AggregationV2.md deleted file mode 100644 index 73a2b41b..00000000 --- a/docs/v1/models/AggregationV2.md +++ /dev/null @@ -1,22 +0,0 @@ -# AggregationV2 - -Specifies an aggregation function. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[MaxAggregationV2](MaxAggregationV2.md) | max -[MinAggregationV2](MinAggregationV2.md) | min -[AvgAggregationV2](AvgAggregationV2.md) | avg -[SumAggregationV2](SumAggregationV2.md) | sum -[CountAggregationV2](CountAggregationV2.md) | count -[ApproximateDistinctAggregationV2](ApproximateDistinctAggregationV2.md) | approximateDistinct -[ApproximatePercentileAggregationV2](ApproximatePercentileAggregationV2.md) | approximatePercentile -[ExactDistinctAggregationV2](ExactDistinctAggregationV2.md) | exactDistinct - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AggregationV2Dict.md b/docs/v1/models/AggregationV2Dict.md deleted file mode 100644 index 0dea73cd..00000000 --- a/docs/v1/models/AggregationV2Dict.md +++ /dev/null @@ -1,22 +0,0 @@ -# AggregationV2Dict - -Specifies an aggregation function. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[MaxAggregationV2Dict](MaxAggregationV2Dict.md) | max -[MinAggregationV2Dict](MinAggregationV2Dict.md) | min -[AvgAggregationV2Dict](AvgAggregationV2Dict.md) | avg -[SumAggregationV2Dict](SumAggregationV2Dict.md) | sum -[CountAggregationV2Dict](CountAggregationV2Dict.md) | count -[ApproximateDistinctAggregationV2Dict](ApproximateDistinctAggregationV2Dict.md) | approximateDistinct -[ApproximatePercentileAggregationV2Dict](ApproximatePercentileAggregationV2Dict.md) | approximatePercentile -[ExactDistinctAggregationV2Dict](ExactDistinctAggregationV2Dict.md) | exactDistinct - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AllTermsQuery.md b/docs/v1/models/AllTermsQuery.md deleted file mode 100644 index 4867f069..00000000 --- a/docs/v1/models/AllTermsQuery.md +++ /dev/null @@ -1,16 +0,0 @@ -# AllTermsQuery - -Returns objects where the specified field contains all of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | Optional[Fuzzy] | No | | -**type** | Literal["allTerms"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AllTermsQueryDict.md b/docs/v1/models/AllTermsQueryDict.md deleted file mode 100644 index db3399d5..00000000 --- a/docs/v1/models/AllTermsQueryDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# AllTermsQueryDict - -Returns objects where the specified field contains all of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | NotRequired[Fuzzy] | No | | -**type** | Literal["allTerms"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AndQuery.md b/docs/v1/models/AndQuery.md deleted file mode 100644 index 463e9d68..00000000 --- a/docs/v1/models/AndQuery.md +++ /dev/null @@ -1,12 +0,0 @@ -# AndQuery - -Returns objects where every query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQuery] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AndQueryDict.md b/docs/v1/models/AndQueryDict.md deleted file mode 100644 index 6aa5a0b1..00000000 --- a/docs/v1/models/AndQueryDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AndQueryDict - -Returns objects where every query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryDict] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AndQueryV2.md b/docs/v1/models/AndQueryV2.md deleted file mode 100644 index 9002a27c..00000000 --- a/docs/v1/models/AndQueryV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# AndQueryV2 - -Returns objects where every query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryV2] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AndQueryV2Dict.md b/docs/v1/models/AndQueryV2Dict.md deleted file mode 100644 index 51826b4a..00000000 --- a/docs/v1/models/AndQueryV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AndQueryV2Dict - -Returns objects where every query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryV2Dict] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AnyTermQuery.md b/docs/v1/models/AnyTermQuery.md deleted file mode 100644 index c5c3ab84..00000000 --- a/docs/v1/models/AnyTermQuery.md +++ /dev/null @@ -1,16 +0,0 @@ -# AnyTermQuery - -Returns objects where the specified field contains any of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | Optional[Fuzzy] | No | | -**type** | Literal["anyTerm"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AnyTermQueryDict.md b/docs/v1/models/AnyTermQueryDict.md deleted file mode 100644 index f59836b4..00000000 --- a/docs/v1/models/AnyTermQueryDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# AnyTermQueryDict - -Returns objects where the specified field contains any of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | NotRequired[Fuzzy] | No | | -**type** | Literal["anyTerm"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AnyType.md b/docs/v1/models/AnyType.md deleted file mode 100644 index 145ec0ca..00000000 --- a/docs/v1/models/AnyType.md +++ /dev/null @@ -1,11 +0,0 @@ -# AnyType - -AnyType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["any"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AnyTypeDict.md b/docs/v1/models/AnyTypeDict.md deleted file mode 100644 index 17711061..00000000 --- a/docs/v1/models/AnyTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AnyTypeDict - -AnyType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["any"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApplyActionMode.md b/docs/v1/models/ApplyActionMode.md deleted file mode 100644 index 7fb52646..00000000 --- a/docs/v1/models/ApplyActionMode.md +++ /dev/null @@ -1,11 +0,0 @@ -# ApplyActionMode - -ApplyActionMode - -| **Value** | -| --------- | -| `"VALIDATE_ONLY"` | -| `"VALIDATE_AND_EXECUTE"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApplyActionRequest.md b/docs/v1/models/ApplyActionRequest.md deleted file mode 100644 index 78ff6241..00000000 --- a/docs/v1/models/ApplyActionRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# ApplyActionRequest - -ApplyActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApplyActionRequestDict.md b/docs/v1/models/ApplyActionRequestDict.md deleted file mode 100644 index 7c01a6e2..00000000 --- a/docs/v1/models/ApplyActionRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ApplyActionRequestDict - -ApplyActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApplyActionRequestOptions.md b/docs/v1/models/ApplyActionRequestOptions.md deleted file mode 100644 index b0e6ad4c..00000000 --- a/docs/v1/models/ApplyActionRequestOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# ApplyActionRequestOptions - -ApplyActionRequestOptions - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**mode** | Optional[ApplyActionMode] | No | | -**return_edits** | Optional[ReturnEditsMode] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApplyActionRequestOptionsDict.md b/docs/v1/models/ApplyActionRequestOptionsDict.md deleted file mode 100644 index bdb25968..00000000 --- a/docs/v1/models/ApplyActionRequestOptionsDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ApplyActionRequestOptionsDict - -ApplyActionRequestOptions - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**mode** | NotRequired[ApplyActionMode] | No | | -**returnEdits** | NotRequired[ReturnEditsMode] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApplyActionRequestV2.md b/docs/v1/models/ApplyActionRequestV2.md deleted file mode 100644 index 6f687c4d..00000000 --- a/docs/v1/models/ApplyActionRequestV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# ApplyActionRequestV2 - -ApplyActionRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**options** | Optional[ApplyActionRequestOptions] | No | | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApplyActionRequestV2Dict.md b/docs/v1/models/ApplyActionRequestV2Dict.md deleted file mode 100644 index 2a6c7ac0..00000000 --- a/docs/v1/models/ApplyActionRequestV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ApplyActionRequestV2Dict - -ApplyActionRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**options** | NotRequired[ApplyActionRequestOptionsDict] | No | | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApplyActionResponse.md b/docs/v1/models/ApplyActionResponse.md deleted file mode 100644 index ce4139e5..00000000 --- a/docs/v1/models/ApplyActionResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# ApplyActionResponse - -ApplyActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApplyActionResponseDict.md b/docs/v1/models/ApplyActionResponseDict.md deleted file mode 100644 index 4a338c76..00000000 --- a/docs/v1/models/ApplyActionResponseDict.md +++ /dev/null @@ -1,10 +0,0 @@ -# ApplyActionResponseDict - -ApplyActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApproximateDistinctAggregation.md b/docs/v1/models/ApproximateDistinctAggregation.md deleted file mode 100644 index e66ed469..00000000 --- a/docs/v1/models/ApproximateDistinctAggregation.md +++ /dev/null @@ -1,13 +0,0 @@ -# ApproximateDistinctAggregation - -Computes an approximate number of distinct values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**type** | Literal["approximateDistinct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApproximateDistinctAggregationDict.md b/docs/v1/models/ApproximateDistinctAggregationDict.md deleted file mode 100644 index 62309b13..00000000 --- a/docs/v1/models/ApproximateDistinctAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ApproximateDistinctAggregationDict - -Computes an approximate number of distinct values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["approximateDistinct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApproximateDistinctAggregationV2.md b/docs/v1/models/ApproximateDistinctAggregationV2.md deleted file mode 100644 index b4912897..00000000 --- a/docs/v1/models/ApproximateDistinctAggregationV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# ApproximateDistinctAggregationV2 - -Computes an approximate number of distinct values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["approximateDistinct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApproximateDistinctAggregationV2Dict.md b/docs/v1/models/ApproximateDistinctAggregationV2Dict.md deleted file mode 100644 index 75a36924..00000000 --- a/docs/v1/models/ApproximateDistinctAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ApproximateDistinctAggregationV2Dict - -Computes an approximate number of distinct values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["approximateDistinct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApproximatePercentileAggregationV2.md b/docs/v1/models/ApproximatePercentileAggregationV2.md deleted file mode 100644 index 8e35f8af..00000000 --- a/docs/v1/models/ApproximatePercentileAggregationV2.md +++ /dev/null @@ -1,15 +0,0 @@ -# ApproximatePercentileAggregationV2 - -Computes the approximate percentile value for the provided field. Requires Object Storage V2. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**approximate_percentile** | StrictFloat | Yes | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["approximatePercentile"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ApproximatePercentileAggregationV2Dict.md b/docs/v1/models/ApproximatePercentileAggregationV2Dict.md deleted file mode 100644 index 54165254..00000000 --- a/docs/v1/models/ApproximatePercentileAggregationV2Dict.md +++ /dev/null @@ -1,15 +0,0 @@ -# ApproximatePercentileAggregationV2Dict - -Computes the approximate percentile value for the provided field. Requires Object Storage V2. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**approximatePercentile** | StrictFloat | Yes | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["approximatePercentile"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ArchiveFileFormat.md b/docs/v1/models/ArchiveFileFormat.md deleted file mode 100644 index f60fd990..00000000 --- a/docs/v1/models/ArchiveFileFormat.md +++ /dev/null @@ -1,11 +0,0 @@ -# ArchiveFileFormat - -The format of an archive file. - - -| **Value** | -| --------- | -| `"ZIP"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Arg.md b/docs/v1/models/Arg.md deleted file mode 100644 index 21cdcb9c..00000000 --- a/docs/v1/models/Arg.md +++ /dev/null @@ -1,12 +0,0 @@ -# Arg - -Arg - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StrictStr | Yes | | -**value** | StrictStr | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ArgDict.md b/docs/v1/models/ArgDict.md deleted file mode 100644 index b0c362ae..00000000 --- a/docs/v1/models/ArgDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ArgDict - -Arg - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StrictStr | Yes | | -**value** | StrictStr | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ArraySizeConstraint.md b/docs/v1/models/ArraySizeConstraint.md deleted file mode 100644 index bb30665c..00000000 --- a/docs/v1/models/ArraySizeConstraint.md +++ /dev/null @@ -1,16 +0,0 @@ -# ArraySizeConstraint - -The parameter expects an array of values and the size of the array must fall within the defined range. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | Optional[Any] | No | Less than | -**lte** | Optional[Any] | No | Less than or equal | -**gt** | Optional[Any] | No | Greater than | -**gte** | Optional[Any] | No | Greater than or equal | -**type** | Literal["arraySize"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ArraySizeConstraintDict.md b/docs/v1/models/ArraySizeConstraintDict.md deleted file mode 100644 index 7567409f..00000000 --- a/docs/v1/models/ArraySizeConstraintDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ArraySizeConstraintDict - -The parameter expects an array of values and the size of the array must fall within the defined range. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Less than | -**lte** | NotRequired[Any] | No | Less than or equal | -**gt** | NotRequired[Any] | No | Greater than | -**gte** | NotRequired[Any] | No | Greater than or equal | -**type** | Literal["arraySize"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ArtifactRepositoryRid.md b/docs/v1/models/ArtifactRepositoryRid.md deleted file mode 100644 index 53a4a5f8..00000000 --- a/docs/v1/models/ArtifactRepositoryRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ArtifactRepositoryRid - -ArtifactRepositoryRid - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AsyncActionStatus.md b/docs/v1/models/AsyncActionStatus.md deleted file mode 100644 index fd67af36..00000000 --- a/docs/v1/models/AsyncActionStatus.md +++ /dev/null @@ -1,16 +0,0 @@ -# AsyncActionStatus - -AsyncActionStatus - -| **Value** | -| --------- | -| `"RUNNING_SUBMISSION_CHECKS"` | -| `"EXECUTING_WRITE_BACK_WEBHOOK"` | -| `"COMPUTING_ONTOLOGY_EDITS"` | -| `"COMPUTING_FUNCTION"` | -| `"WRITING_ONTOLOGY_EDITS"` | -| `"EXECUTING_SIDE_EFFECT_WEBHOOK"` | -| `"SENDING_NOTIFICATIONS"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AsyncApplyActionOperationResponseV2.md b/docs/v1/models/AsyncApplyActionOperationResponseV2.md deleted file mode 100644 index e77f05d5..00000000 --- a/docs/v1/models/AsyncApplyActionOperationResponseV2.md +++ /dev/null @@ -1,10 +0,0 @@ -# AsyncApplyActionOperationResponseV2 - -AsyncApplyActionOperationResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AsyncApplyActionOperationResponseV2Dict.md b/docs/v1/models/AsyncApplyActionOperationResponseV2Dict.md deleted file mode 100644 index 45c769ad..00000000 --- a/docs/v1/models/AsyncApplyActionOperationResponseV2Dict.md +++ /dev/null @@ -1,10 +0,0 @@ -# AsyncApplyActionOperationResponseV2Dict - -AsyncApplyActionOperationResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AsyncApplyActionRequest.md b/docs/v1/models/AsyncApplyActionRequest.md deleted file mode 100644 index f64536c2..00000000 --- a/docs/v1/models/AsyncApplyActionRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# AsyncApplyActionRequest - -AsyncApplyActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AsyncApplyActionRequestDict.md b/docs/v1/models/AsyncApplyActionRequestDict.md deleted file mode 100644 index 5bde7567..00000000 --- a/docs/v1/models/AsyncApplyActionRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AsyncApplyActionRequestDict - -AsyncApplyActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AsyncApplyActionRequestV2.md b/docs/v1/models/AsyncApplyActionRequestV2.md deleted file mode 100644 index 6c7d1ab7..00000000 --- a/docs/v1/models/AsyncApplyActionRequestV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# AsyncApplyActionRequestV2 - -AsyncApplyActionRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AsyncApplyActionRequestV2Dict.md b/docs/v1/models/AsyncApplyActionRequestV2Dict.md deleted file mode 100644 index 966a76b3..00000000 --- a/docs/v1/models/AsyncApplyActionRequestV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AsyncApplyActionRequestV2Dict - -AsyncApplyActionRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AsyncApplyActionResponse.md b/docs/v1/models/AsyncApplyActionResponse.md deleted file mode 100644 index 683a5287..00000000 --- a/docs/v1/models/AsyncApplyActionResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# AsyncApplyActionResponse - -AsyncApplyActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AsyncApplyActionResponseDict.md b/docs/v1/models/AsyncApplyActionResponseDict.md deleted file mode 100644 index 01b3bfec..00000000 --- a/docs/v1/models/AsyncApplyActionResponseDict.md +++ /dev/null @@ -1,10 +0,0 @@ -# AsyncApplyActionResponseDict - -AsyncApplyActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AsyncApplyActionResponseV2.md b/docs/v1/models/AsyncApplyActionResponseV2.md deleted file mode 100644 index 43ffda63..00000000 --- a/docs/v1/models/AsyncApplyActionResponseV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# AsyncApplyActionResponseV2 - -AsyncApplyActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**operation_id** | RID | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AsyncApplyActionResponseV2Dict.md b/docs/v1/models/AsyncApplyActionResponseV2Dict.md deleted file mode 100644 index 7f25ad2a..00000000 --- a/docs/v1/models/AsyncApplyActionResponseV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AsyncApplyActionResponseV2Dict - -AsyncApplyActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**operationId** | RID | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Attachment.md b/docs/v1/models/Attachment.md deleted file mode 100644 index 316128f6..00000000 --- a/docs/v1/models/Attachment.md +++ /dev/null @@ -1,14 +0,0 @@ -# Attachment - -The representation of an attachment. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AttachmentRid | Yes | | -**filename** | Filename | Yes | | -**size_bytes** | SizeBytes | Yes | | -**media_type** | MediaType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AttachmentDict.md b/docs/v1/models/AttachmentDict.md deleted file mode 100644 index 2f2574c9..00000000 --- a/docs/v1/models/AttachmentDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AttachmentDict - -The representation of an attachment. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AttachmentRid | Yes | | -**filename** | Filename | Yes | | -**sizeBytes** | SizeBytes | Yes | | -**mediaType** | MediaType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AttachmentMetadataResponse.md b/docs/v1/models/AttachmentMetadataResponse.md deleted file mode 100644 index 7cdccc50..00000000 --- a/docs/v1/models/AttachmentMetadataResponse.md +++ /dev/null @@ -1,16 +0,0 @@ -# AttachmentMetadataResponse - -The attachment metadata response - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AttachmentV2](AttachmentV2.md) | single -[ListAttachmentsResponseV2](ListAttachmentsResponseV2.md) | multiple - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AttachmentMetadataResponseDict.md b/docs/v1/models/AttachmentMetadataResponseDict.md deleted file mode 100644 index 05600ac3..00000000 --- a/docs/v1/models/AttachmentMetadataResponseDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# AttachmentMetadataResponseDict - -The attachment metadata response - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AttachmentV2Dict](AttachmentV2Dict.md) | single -[ListAttachmentsResponseV2Dict](ListAttachmentsResponseV2Dict.md) | multiple - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AttachmentProperty.md b/docs/v1/models/AttachmentProperty.md deleted file mode 100644 index ae5aad1e..00000000 --- a/docs/v1/models/AttachmentProperty.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttachmentProperty - -The representation of an attachment as a data type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AttachmentRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AttachmentPropertyDict.md b/docs/v1/models/AttachmentPropertyDict.md deleted file mode 100644 index 33230ded..00000000 --- a/docs/v1/models/AttachmentPropertyDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttachmentPropertyDict - -The representation of an attachment as a data type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AttachmentRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AttachmentRid.md b/docs/v1/models/AttachmentRid.md deleted file mode 100644 index d2e18d1f..00000000 --- a/docs/v1/models/AttachmentRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttachmentRid - -The unique resource identifier of an attachment. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AttachmentType.md b/docs/v1/models/AttachmentType.md deleted file mode 100644 index fdb9bc32..00000000 --- a/docs/v1/models/AttachmentType.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttachmentType - -AttachmentType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["attachment"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AttachmentTypeDict.md b/docs/v1/models/AttachmentTypeDict.md deleted file mode 100644 index 6ec5363b..00000000 --- a/docs/v1/models/AttachmentTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttachmentTypeDict - -AttachmentType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["attachment"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AttachmentV2.md b/docs/v1/models/AttachmentV2.md deleted file mode 100644 index 8efd26db..00000000 --- a/docs/v1/models/AttachmentV2.md +++ /dev/null @@ -1,15 +0,0 @@ -# AttachmentV2 - -The representation of an attachment. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AttachmentRid | Yes | | -**filename** | Filename | Yes | | -**size_bytes** | SizeBytes | Yes | | -**media_type** | MediaType | Yes | | -**type** | Literal["single"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AttachmentV2Dict.md b/docs/v1/models/AttachmentV2Dict.md deleted file mode 100644 index 844de04f..00000000 --- a/docs/v1/models/AttachmentV2Dict.md +++ /dev/null @@ -1,15 +0,0 @@ -# AttachmentV2Dict - -The representation of an attachment. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AttachmentRid | Yes | | -**filename** | Filename | Yes | | -**sizeBytes** | SizeBytes | Yes | | -**mediaType** | MediaType | Yes | | -**type** | Literal["single"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AvgAggregation.md b/docs/v1/models/AvgAggregation.md deleted file mode 100644 index 7dde043a..00000000 --- a/docs/v1/models/AvgAggregation.md +++ /dev/null @@ -1,13 +0,0 @@ -# AvgAggregation - -Computes the average value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**type** | Literal["avg"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AvgAggregationDict.md b/docs/v1/models/AvgAggregationDict.md deleted file mode 100644 index 54f9a7bb..00000000 --- a/docs/v1/models/AvgAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AvgAggregationDict - -Computes the average value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["avg"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AvgAggregationV2.md b/docs/v1/models/AvgAggregationV2.md deleted file mode 100644 index a82a1891..00000000 --- a/docs/v1/models/AvgAggregationV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# AvgAggregationV2 - -Computes the average value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["avg"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/AvgAggregationV2Dict.md b/docs/v1/models/AvgAggregationV2Dict.md deleted file mode 100644 index 854abb6a..00000000 --- a/docs/v1/models/AvgAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AvgAggregationV2Dict - -Computes the average value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["avg"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BBox.md b/docs/v1/models/BBox.md deleted file mode 100644 index 8346f097..00000000 --- a/docs/v1/models/BBox.md +++ /dev/null @@ -1,18 +0,0 @@ -# BBox - -A GeoJSON object MAY have a member named "bbox" to include -information on the coordinate range for its Geometries, Features, or -FeatureCollections. The value of the bbox member MUST be an array of -length 2*n where n is the number of dimensions represented in the -contained geometries, with all axes of the most southwesterly point -followed by all axes of the more northeasterly point. The axes order -of a bbox follows the axes order of geometries. - - -## Type -```python -List[Coordinate] -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BatchApplyActionRequest.md b/docs/v1/models/BatchApplyActionRequest.md deleted file mode 100644 index c90d2f08..00000000 --- a/docs/v1/models/BatchApplyActionRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionRequest - -BatchApplyActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**requests** | List[ApplyActionRequest] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BatchApplyActionRequestDict.md b/docs/v1/models/BatchApplyActionRequestDict.md deleted file mode 100644 index a54bd6b7..00000000 --- a/docs/v1/models/BatchApplyActionRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionRequestDict - -BatchApplyActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**requests** | List[ApplyActionRequestDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BatchApplyActionRequestItem.md b/docs/v1/models/BatchApplyActionRequestItem.md deleted file mode 100644 index 5604f7a8..00000000 --- a/docs/v1/models/BatchApplyActionRequestItem.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionRequestItem - -BatchApplyActionRequestItem - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BatchApplyActionRequestItemDict.md b/docs/v1/models/BatchApplyActionRequestItemDict.md deleted file mode 100644 index 03b1184c..00000000 --- a/docs/v1/models/BatchApplyActionRequestItemDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionRequestItemDict - -BatchApplyActionRequestItem - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BatchApplyActionRequestOptions.md b/docs/v1/models/BatchApplyActionRequestOptions.md deleted file mode 100644 index f64d5f9d..00000000 --- a/docs/v1/models/BatchApplyActionRequestOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionRequestOptions - -BatchApplyActionRequestOptions - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**return_edits** | Optional[ReturnEditsMode] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BatchApplyActionRequestOptionsDict.md b/docs/v1/models/BatchApplyActionRequestOptionsDict.md deleted file mode 100644 index 22ef7c66..00000000 --- a/docs/v1/models/BatchApplyActionRequestOptionsDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionRequestOptionsDict - -BatchApplyActionRequestOptions - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**returnEdits** | NotRequired[ReturnEditsMode] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BatchApplyActionRequestV2.md b/docs/v1/models/BatchApplyActionRequestV2.md deleted file mode 100644 index 2bc9b46c..00000000 --- a/docs/v1/models/BatchApplyActionRequestV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# BatchApplyActionRequestV2 - -BatchApplyActionRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**options** | Optional[BatchApplyActionRequestOptions] | No | | -**requests** | List[BatchApplyActionRequestItem] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BatchApplyActionRequestV2Dict.md b/docs/v1/models/BatchApplyActionRequestV2Dict.md deleted file mode 100644 index f93310b3..00000000 --- a/docs/v1/models/BatchApplyActionRequestV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# BatchApplyActionRequestV2Dict - -BatchApplyActionRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**options** | NotRequired[BatchApplyActionRequestOptionsDict] | No | | -**requests** | List[BatchApplyActionRequestItemDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BatchApplyActionResponse.md b/docs/v1/models/BatchApplyActionResponse.md deleted file mode 100644 index da1ad7d3..00000000 --- a/docs/v1/models/BatchApplyActionResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# BatchApplyActionResponse - -BatchApplyActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BatchApplyActionResponseDict.md b/docs/v1/models/BatchApplyActionResponseDict.md deleted file mode 100644 index a5fb2877..00000000 --- a/docs/v1/models/BatchApplyActionResponseDict.md +++ /dev/null @@ -1,10 +0,0 @@ -# BatchApplyActionResponseDict - -BatchApplyActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BatchApplyActionResponseV2.md b/docs/v1/models/BatchApplyActionResponseV2.md deleted file mode 100644 index 62c6426b..00000000 --- a/docs/v1/models/BatchApplyActionResponseV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionResponseV2 - -BatchApplyActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**edits** | Optional[ActionResults] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BatchApplyActionResponseV2Dict.md b/docs/v1/models/BatchApplyActionResponseV2Dict.md deleted file mode 100644 index ae13b918..00000000 --- a/docs/v1/models/BatchApplyActionResponseV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionResponseV2Dict - -BatchApplyActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**edits** | NotRequired[ActionResultsDict] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BinaryType.md b/docs/v1/models/BinaryType.md deleted file mode 100644 index 356368d2..00000000 --- a/docs/v1/models/BinaryType.md +++ /dev/null @@ -1,11 +0,0 @@ -# BinaryType - -BinaryType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["binary"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BinaryTypeDict.md b/docs/v1/models/BinaryTypeDict.md deleted file mode 100644 index 1f10da9b..00000000 --- a/docs/v1/models/BinaryTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BinaryTypeDict - -BinaryType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["binary"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BlueprintIcon.md b/docs/v1/models/BlueprintIcon.md deleted file mode 100644 index 9d519494..00000000 --- a/docs/v1/models/BlueprintIcon.md +++ /dev/null @@ -1,13 +0,0 @@ -# BlueprintIcon - -BlueprintIcon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**color** | StrictStr | Yes | A hexadecimal color code. | -**name** | StrictStr | Yes | The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. Used to specify the Blueprint icon to represent the object type in a React app. | -**type** | Literal["blueprint"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BlueprintIconDict.md b/docs/v1/models/BlueprintIconDict.md deleted file mode 100644 index fb9f9ecd..00000000 --- a/docs/v1/models/BlueprintIconDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# BlueprintIconDict - -BlueprintIcon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**color** | StrictStr | Yes | A hexadecimal color code. | -**name** | StrictStr | Yes | The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. Used to specify the Blueprint icon to represent the object type in a React app. | -**type** | Literal["blueprint"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BooleanType.md b/docs/v1/models/BooleanType.md deleted file mode 100644 index 3467cca6..00000000 --- a/docs/v1/models/BooleanType.md +++ /dev/null @@ -1,11 +0,0 @@ -# BooleanType - -BooleanType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["boolean"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BooleanTypeDict.md b/docs/v1/models/BooleanTypeDict.md deleted file mode 100644 index 28f8ac7e..00000000 --- a/docs/v1/models/BooleanTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BooleanTypeDict - -BooleanType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["boolean"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BoundingBoxValue.md b/docs/v1/models/BoundingBoxValue.md deleted file mode 100644 index 77706588..00000000 --- a/docs/v1/models/BoundingBoxValue.md +++ /dev/null @@ -1,13 +0,0 @@ -# BoundingBoxValue - -The top left and bottom right coordinate points that make up the bounding box. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**top_left** | WithinBoundingBoxPoint | Yes | | -**bottom_right** | WithinBoundingBoxPoint | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BoundingBoxValueDict.md b/docs/v1/models/BoundingBoxValueDict.md deleted file mode 100644 index f7800909..00000000 --- a/docs/v1/models/BoundingBoxValueDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# BoundingBoxValueDict - -The top left and bottom right coordinate points that make up the bounding box. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**topLeft** | WithinBoundingBoxPointDict | Yes | | -**bottomRight** | WithinBoundingBoxPointDict | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Branch.md b/docs/v1/models/Branch.md deleted file mode 100644 index 178625c4..00000000 --- a/docs/v1/models/Branch.md +++ /dev/null @@ -1,13 +0,0 @@ -# Branch - -A Branch of a Dataset. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**branch_id** | BranchId | Yes | | -**transaction_rid** | Optional[TransactionRid] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BranchDict.md b/docs/v1/models/BranchDict.md deleted file mode 100644 index 4138d55c..00000000 --- a/docs/v1/models/BranchDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# BranchDict - -A Branch of a Dataset. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**branchId** | BranchId | Yes | | -**transactionRid** | NotRequired[TransactionRid] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/BranchId.md b/docs/v1/models/BranchId.md deleted file mode 100644 index be15882a..00000000 --- a/docs/v1/models/BranchId.md +++ /dev/null @@ -1,12 +0,0 @@ -# BranchId - -The identifier (name) of a Branch. Example: `master`. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ByteType.md b/docs/v1/models/ByteType.md deleted file mode 100644 index 71f60412..00000000 --- a/docs/v1/models/ByteType.md +++ /dev/null @@ -1,11 +0,0 @@ -# ByteType - -ByteType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["byte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ByteTypeDict.md b/docs/v1/models/ByteTypeDict.md deleted file mode 100644 index 4fd5048e..00000000 --- a/docs/v1/models/ByteTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ByteTypeDict - -ByteType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["byte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CenterPoint.md b/docs/v1/models/CenterPoint.md deleted file mode 100644 index df6e9acc..00000000 --- a/docs/v1/models/CenterPoint.md +++ /dev/null @@ -1,13 +0,0 @@ -# CenterPoint - -The coordinate point to use as the center of the distance query. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**center** | CenterPointTypes | Yes | | -**distance** | Distance | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CenterPointDict.md b/docs/v1/models/CenterPointDict.md deleted file mode 100644 index 5cff1b71..00000000 --- a/docs/v1/models/CenterPointDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# CenterPointDict - -The coordinate point to use as the center of the distance query. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**center** | CenterPointTypesDict | Yes | | -**distance** | DistanceDict | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CenterPointTypes.md b/docs/v1/models/CenterPointTypes.md deleted file mode 100644 index 1b959543..00000000 --- a/docs/v1/models/CenterPointTypes.md +++ /dev/null @@ -1,11 +0,0 @@ -# CenterPointTypes - -CenterPointTypes - -## Type -```python -GeoPoint -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CenterPointTypesDict.md b/docs/v1/models/CenterPointTypesDict.md deleted file mode 100644 index 1004b21d..00000000 --- a/docs/v1/models/CenterPointTypesDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CenterPointTypesDict - -CenterPointTypes - -## Type -```python -GeoPointDict -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ContainsAllTermsInOrderPrefixLastTerm.md b/docs/v1/models/ContainsAllTermsInOrderPrefixLastTerm.md deleted file mode 100644 index cb6226ec..00000000 --- a/docs/v1/models/ContainsAllTermsInOrderPrefixLastTerm.md +++ /dev/null @@ -1,16 +0,0 @@ -# ContainsAllTermsInOrderPrefixLastTerm - -Returns objects where the specified field contains all of the terms in the order provided, -but they do have to be adjacent to each other. -The last term can be a partial prefix match. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["containsAllTermsInOrderPrefixLastTerm"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ContainsAllTermsInOrderPrefixLastTermDict.md b/docs/v1/models/ContainsAllTermsInOrderPrefixLastTermDict.md deleted file mode 100644 index c28c9cfc..00000000 --- a/docs/v1/models/ContainsAllTermsInOrderPrefixLastTermDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ContainsAllTermsInOrderPrefixLastTermDict - -Returns objects where the specified field contains all of the terms in the order provided, -but they do have to be adjacent to each other. -The last term can be a partial prefix match. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["containsAllTermsInOrderPrefixLastTerm"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ContainsAllTermsInOrderQuery.md b/docs/v1/models/ContainsAllTermsInOrderQuery.md deleted file mode 100644 index dc59d67f..00000000 --- a/docs/v1/models/ContainsAllTermsInOrderQuery.md +++ /dev/null @@ -1,15 +0,0 @@ -# ContainsAllTermsInOrderQuery - -Returns objects where the specified field contains all of the terms in the order provided, -but they do have to be adjacent to each other. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["containsAllTermsInOrder"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ContainsAllTermsInOrderQueryDict.md b/docs/v1/models/ContainsAllTermsInOrderQueryDict.md deleted file mode 100644 index 09915b35..00000000 --- a/docs/v1/models/ContainsAllTermsInOrderQueryDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# ContainsAllTermsInOrderQueryDict - -Returns objects where the specified field contains all of the terms in the order provided, -but they do have to be adjacent to each other. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["containsAllTermsInOrder"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ContainsAllTermsQuery.md b/docs/v1/models/ContainsAllTermsQuery.md deleted file mode 100644 index defc2cb6..00000000 --- a/docs/v1/models/ContainsAllTermsQuery.md +++ /dev/null @@ -1,16 +0,0 @@ -# ContainsAllTermsQuery - -Returns objects where the specified field contains all of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | Optional[FuzzyV2] | No | | -**type** | Literal["containsAllTerms"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ContainsAllTermsQueryDict.md b/docs/v1/models/ContainsAllTermsQueryDict.md deleted file mode 100644 index af266ff6..00000000 --- a/docs/v1/models/ContainsAllTermsQueryDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ContainsAllTermsQueryDict - -Returns objects where the specified field contains all of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | NotRequired[FuzzyV2] | No | | -**type** | Literal["containsAllTerms"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ContainsAnyTermQuery.md b/docs/v1/models/ContainsAnyTermQuery.md deleted file mode 100644 index cf0b7b7d..00000000 --- a/docs/v1/models/ContainsAnyTermQuery.md +++ /dev/null @@ -1,16 +0,0 @@ -# ContainsAnyTermQuery - -Returns objects where the specified field contains any of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | Optional[FuzzyV2] | No | | -**type** | Literal["containsAnyTerm"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ContainsAnyTermQueryDict.md b/docs/v1/models/ContainsAnyTermQueryDict.md deleted file mode 100644 index 42a53ea8..00000000 --- a/docs/v1/models/ContainsAnyTermQueryDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ContainsAnyTermQueryDict - -Returns objects where the specified field contains any of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | NotRequired[FuzzyV2] | No | | -**type** | Literal["containsAnyTerm"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ContainsQuery.md b/docs/v1/models/ContainsQuery.md deleted file mode 100644 index 4c865f3e..00000000 --- a/docs/v1/models/ContainsQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# ContainsQuery - -Returns objects where the specified array contains a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["contains"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ContainsQueryDict.md b/docs/v1/models/ContainsQueryDict.md deleted file mode 100644 index bd6b1ca4..00000000 --- a/docs/v1/models/ContainsQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ContainsQueryDict - -Returns objects where the specified array contains a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["contains"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ContainsQueryV2.md b/docs/v1/models/ContainsQueryV2.md deleted file mode 100644 index a173d6b2..00000000 --- a/docs/v1/models/ContainsQueryV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# ContainsQueryV2 - -Returns objects where the specified array contains a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["contains"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ContainsQueryV2Dict.md b/docs/v1/models/ContainsQueryV2Dict.md deleted file mode 100644 index 59d45f99..00000000 --- a/docs/v1/models/ContainsQueryV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ContainsQueryV2Dict - -Returns objects where the specified array contains a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["contains"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ContentLength.md b/docs/v1/models/ContentLength.md deleted file mode 100644 index 50a80211..00000000 --- a/docs/v1/models/ContentLength.md +++ /dev/null @@ -1,11 +0,0 @@ -# ContentLength - -ContentLength - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ContentType.md b/docs/v1/models/ContentType.md deleted file mode 100644 index 5429b04b..00000000 --- a/docs/v1/models/ContentType.md +++ /dev/null @@ -1,11 +0,0 @@ -# ContentType - -ContentType - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Coordinate.md b/docs/v1/models/Coordinate.md deleted file mode 100644 index c527a24a..00000000 --- a/docs/v1/models/Coordinate.md +++ /dev/null @@ -1,11 +0,0 @@ -# Coordinate - -Coordinate - -## Type -```python -StrictFloat -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CountAggregation.md b/docs/v1/models/CountAggregation.md deleted file mode 100644 index 350fb853..00000000 --- a/docs/v1/models/CountAggregation.md +++ /dev/null @@ -1,12 +0,0 @@ -# CountAggregation - -Computes the total count of objects. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | Optional[AggregationMetricName] | No | | -**type** | Literal["count"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CountAggregationDict.md b/docs/v1/models/CountAggregationDict.md deleted file mode 100644 index d8218201..00000000 --- a/docs/v1/models/CountAggregationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CountAggregationDict - -Computes the total count of objects. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["count"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CountAggregationV2.md b/docs/v1/models/CountAggregationV2.md deleted file mode 100644 index 91c881aa..00000000 --- a/docs/v1/models/CountAggregationV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# CountAggregationV2 - -Computes the total count of objects. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | Optional[AggregationMetricName] | No | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["count"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CountAggregationV2Dict.md b/docs/v1/models/CountAggregationV2Dict.md deleted file mode 100644 index 6a33bcc8..00000000 --- a/docs/v1/models/CountAggregationV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# CountAggregationV2Dict - -Computes the total count of objects. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["count"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CountObjectsResponseV2.md b/docs/v1/models/CountObjectsResponseV2.md deleted file mode 100644 index 8e871c36..00000000 --- a/docs/v1/models/CountObjectsResponseV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# CountObjectsResponseV2 - -CountObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**count** | Optional[StrictInt] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CountObjectsResponseV2Dict.md b/docs/v1/models/CountObjectsResponseV2Dict.md deleted file mode 100644 index 0922c9bd..00000000 --- a/docs/v1/models/CountObjectsResponseV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CountObjectsResponseV2Dict - -CountObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**count** | NotRequired[StrictInt] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreateBranchRequest.md b/docs/v1/models/CreateBranchRequest.md deleted file mode 100644 index 20966e5f..00000000 --- a/docs/v1/models/CreateBranchRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateBranchRequest - -CreateBranchRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**branch_id** | BranchId | Yes | | -**transaction_rid** | Optional[TransactionRid] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreateBranchRequestDict.md b/docs/v1/models/CreateBranchRequestDict.md deleted file mode 100644 index 0c56200c..00000000 --- a/docs/v1/models/CreateBranchRequestDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateBranchRequestDict - -CreateBranchRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**branchId** | BranchId | Yes | | -**transactionRid** | NotRequired[TransactionRid] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreateDatasetRequest.md b/docs/v1/models/CreateDatasetRequest.md deleted file mode 100644 index adfe0b90..00000000 --- a/docs/v1/models/CreateDatasetRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateDatasetRequest - -CreateDatasetRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | DatasetName | Yes | | -**parent_folder_rid** | FolderRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreateDatasetRequestDict.md b/docs/v1/models/CreateDatasetRequestDict.md deleted file mode 100644 index a674e450..00000000 --- a/docs/v1/models/CreateDatasetRequestDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateDatasetRequestDict - -CreateDatasetRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | DatasetName | Yes | | -**parentFolderRid** | FolderRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreateLinkRule.md b/docs/v1/models/CreateLinkRule.md deleted file mode 100644 index d31d4adf..00000000 --- a/docs/v1/models/CreateLinkRule.md +++ /dev/null @@ -1,15 +0,0 @@ -# CreateLinkRule - -CreateLinkRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**link_type_api_name_ato_b** | LinkTypeApiName | Yes | | -**link_type_api_name_bto_a** | LinkTypeApiName | Yes | | -**a_side_object_type_api_name** | ObjectTypeApiName | Yes | | -**b_side_object_type_api_name** | ObjectTypeApiName | Yes | | -**type** | Literal["createLink"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreateLinkRuleDict.md b/docs/v1/models/CreateLinkRuleDict.md deleted file mode 100644 index 6891ee25..00000000 --- a/docs/v1/models/CreateLinkRuleDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# CreateLinkRuleDict - -CreateLinkRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | -**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | -**aSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**bSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["createLink"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreateObjectRule.md b/docs/v1/models/CreateObjectRule.md deleted file mode 100644 index c6de918a..00000000 --- a/docs/v1/models/CreateObjectRule.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateObjectRule - -CreateObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_type_api_name** | ObjectTypeApiName | Yes | | -**type** | Literal["createObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreateObjectRuleDict.md b/docs/v1/models/CreateObjectRuleDict.md deleted file mode 100644 index cce5fd00..00000000 --- a/docs/v1/models/CreateObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateObjectRuleDict - -CreateObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["createObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreateTemporaryObjectSetRequestV2.md b/docs/v1/models/CreateTemporaryObjectSetRequestV2.md deleted file mode 100644 index f684fe8a..00000000 --- a/docs/v1/models/CreateTemporaryObjectSetRequestV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTemporaryObjectSetRequestV2 - -CreateTemporaryObjectSetRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_set** | ObjectSet | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreateTemporaryObjectSetRequestV2Dict.md b/docs/v1/models/CreateTemporaryObjectSetRequestV2Dict.md deleted file mode 100644 index 6aeecb1d..00000000 --- a/docs/v1/models/CreateTemporaryObjectSetRequestV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTemporaryObjectSetRequestV2Dict - -CreateTemporaryObjectSetRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreateTemporaryObjectSetResponseV2.md b/docs/v1/models/CreateTemporaryObjectSetResponseV2.md deleted file mode 100644 index 157c13c8..00000000 --- a/docs/v1/models/CreateTemporaryObjectSetResponseV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTemporaryObjectSetResponseV2 - -CreateTemporaryObjectSetResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_set_rid** | ObjectSetRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreateTemporaryObjectSetResponseV2Dict.md b/docs/v1/models/CreateTemporaryObjectSetResponseV2Dict.md deleted file mode 100644 index 090aabe8..00000000 --- a/docs/v1/models/CreateTemporaryObjectSetResponseV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTemporaryObjectSetResponseV2Dict - -CreateTemporaryObjectSetResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSetRid** | ObjectSetRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreateTransactionRequest.md b/docs/v1/models/CreateTransactionRequest.md deleted file mode 100644 index 24d229cf..00000000 --- a/docs/v1/models/CreateTransactionRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTransactionRequest - -CreateTransactionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**transaction_type** | Optional[TransactionType] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreateTransactionRequestDict.md b/docs/v1/models/CreateTransactionRequestDict.md deleted file mode 100644 index e9622277..00000000 --- a/docs/v1/models/CreateTransactionRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTransactionRequestDict - -CreateTransactionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**transactionType** | NotRequired[TransactionType] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CreatedTime.md b/docs/v1/models/CreatedTime.md deleted file mode 100644 index 852f6909..00000000 --- a/docs/v1/models/CreatedTime.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreatedTime - -The time at which the resource was created. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/CustomTypeId.md b/docs/v1/models/CustomTypeId.md deleted file mode 100644 index 2e71b527..00000000 --- a/docs/v1/models/CustomTypeId.md +++ /dev/null @@ -1,12 +0,0 @@ -# CustomTypeId - -A UUID representing a custom type in a given Function. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DataValue.md b/docs/v1/models/DataValue.md deleted file mode 100644 index 19ed4b03..00000000 --- a/docs/v1/models/DataValue.md +++ /dev/null @@ -1,35 +0,0 @@ -# DataValue - -Represents the value of data in the following format. Note that these values can be nested, for example an array of structs. -| Type | JSON encoding | Example | -|-----------------------------|-------------------------------------------------------|-------------------------------------------------------------------------------| -| Array | array | `["alpha", "bravo", "charlie"]` | -| Attachment | string | `"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"` | -| Boolean | boolean | `true` | -| Byte | number | `31` | -| Date | ISO 8601 extended local date string | `"2021-05-01"` | -| Decimal | string | `"2.718281828"` | -| Float | number | `3.14159265` | -| Double | number | `3.14159265` | -| Integer | number | `238940` | -| Long | string | `"58319870951433"` | -| Marking | string | `"MU"` | -| Null | null | `null` | -| Object Set | string OR the object set definition | `ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z`| -| Ontology Object Reference | JSON encoding of the object's primary key | `10033123` or `"EMP1234"` | -| Set | array | `["alpha", "bravo", "charlie"]` | -| Short | number | `8739` | -| String | string | `"Call me Ishmael"` | -| Struct | JSON object | `{"name": "John Doe", "age": 42}` | -| TwoDimensionalAggregation | JSON object | `{"groups": [{"key": "alpha", "value": 100}, {"key": "beta", "value": 101}]}` | -| ThreeDimensionalAggregation | JSON object | `{"groups": [{"key": "NYC", "groups": [{"key": "Engineer", "value" : 100}]}]}`| -| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | - - -## Type -```python -Any -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Dataset.md b/docs/v1/models/Dataset.md deleted file mode 100644 index 38ebf89a..00000000 --- a/docs/v1/models/Dataset.md +++ /dev/null @@ -1,13 +0,0 @@ -# Dataset - -Dataset - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | DatasetRid | Yes | | -**name** | DatasetName | Yes | | -**parent_folder_rid** | FolderRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DatasetDict.md b/docs/v1/models/DatasetDict.md deleted file mode 100644 index ea42c8ed..00000000 --- a/docs/v1/models/DatasetDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# DatasetDict - -Dataset - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | DatasetRid | Yes | | -**name** | DatasetName | Yes | | -**parentFolderRid** | FolderRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DatasetName.md b/docs/v1/models/DatasetName.md deleted file mode 100644 index f1bcb80c..00000000 --- a/docs/v1/models/DatasetName.md +++ /dev/null @@ -1,11 +0,0 @@ -# DatasetName - -DatasetName - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DatasetRid.md b/docs/v1/models/DatasetRid.md deleted file mode 100644 index 9278c503..00000000 --- a/docs/v1/models/DatasetRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# DatasetRid - -The Resource Identifier (RID) of a Dataset. Example: `ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da`. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DateType.md b/docs/v1/models/DateType.md deleted file mode 100644 index 0b8d70ef..00000000 --- a/docs/v1/models/DateType.md +++ /dev/null @@ -1,11 +0,0 @@ -# DateType - -DateType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["date"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DateTypeDict.md b/docs/v1/models/DateTypeDict.md deleted file mode 100644 index 8d904f23..00000000 --- a/docs/v1/models/DateTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# DateTypeDict - -DateType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["date"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DecimalType.md b/docs/v1/models/DecimalType.md deleted file mode 100644 index 7eb2a100..00000000 --- a/docs/v1/models/DecimalType.md +++ /dev/null @@ -1,13 +0,0 @@ -# DecimalType - -DecimalType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**precision** | Optional[StrictInt] | No | | -**scale** | Optional[StrictInt] | No | | -**type** | Literal["decimal"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DecimalTypeDict.md b/docs/v1/models/DecimalTypeDict.md deleted file mode 100644 index 711fcfab..00000000 --- a/docs/v1/models/DecimalTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# DecimalTypeDict - -DecimalType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**precision** | NotRequired[StrictInt] | No | | -**scale** | NotRequired[StrictInt] | No | | -**type** | Literal["decimal"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DeleteLinkRule.md b/docs/v1/models/DeleteLinkRule.md deleted file mode 100644 index 1051300c..00000000 --- a/docs/v1/models/DeleteLinkRule.md +++ /dev/null @@ -1,15 +0,0 @@ -# DeleteLinkRule - -DeleteLinkRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**link_type_api_name_ato_b** | LinkTypeApiName | Yes | | -**link_type_api_name_bto_a** | LinkTypeApiName | Yes | | -**a_side_object_type_api_name** | ObjectTypeApiName | Yes | | -**b_side_object_type_api_name** | ObjectTypeApiName | Yes | | -**type** | Literal["deleteLink"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DeleteLinkRuleDict.md b/docs/v1/models/DeleteLinkRuleDict.md deleted file mode 100644 index bebd9ca0..00000000 --- a/docs/v1/models/DeleteLinkRuleDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# DeleteLinkRuleDict - -DeleteLinkRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | -**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | -**aSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**bSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["deleteLink"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DeleteObjectRule.md b/docs/v1/models/DeleteObjectRule.md deleted file mode 100644 index 4d3426f1..00000000 --- a/docs/v1/models/DeleteObjectRule.md +++ /dev/null @@ -1,12 +0,0 @@ -# DeleteObjectRule - -DeleteObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_type_api_name** | ObjectTypeApiName | Yes | | -**type** | Literal["deleteObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DeleteObjectRuleDict.md b/docs/v1/models/DeleteObjectRuleDict.md deleted file mode 100644 index dd5931c5..00000000 --- a/docs/v1/models/DeleteObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# DeleteObjectRuleDict - -DeleteObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["deleteObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DisplayName.md b/docs/v1/models/DisplayName.md deleted file mode 100644 index a98de135..00000000 --- a/docs/v1/models/DisplayName.md +++ /dev/null @@ -1,11 +0,0 @@ -# DisplayName - -The display name of the entity. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Distance.md b/docs/v1/models/Distance.md deleted file mode 100644 index 7f4f637a..00000000 --- a/docs/v1/models/Distance.md +++ /dev/null @@ -1,12 +0,0 @@ -# Distance - -A measurement of distance. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | StrictFloat | Yes | | -**unit** | DistanceUnit | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DistanceDict.md b/docs/v1/models/DistanceDict.md deleted file mode 100644 index 44b9903d..00000000 --- a/docs/v1/models/DistanceDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# DistanceDict - -A measurement of distance. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | StrictFloat | Yes | | -**unit** | DistanceUnit | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DistanceUnit.md b/docs/v1/models/DistanceUnit.md deleted file mode 100644 index 8ade626b..00000000 --- a/docs/v1/models/DistanceUnit.md +++ /dev/null @@ -1,18 +0,0 @@ -# DistanceUnit - -DistanceUnit - -| **Value** | -| --------- | -| `"MILLIMETERS"` | -| `"CENTIMETERS"` | -| `"METERS"` | -| `"KILOMETERS"` | -| `"INCHES"` | -| `"FEET"` | -| `"YARDS"` | -| `"MILES"` | -| `"NAUTICAL_MILES"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DoesNotIntersectBoundingBoxQuery.md b/docs/v1/models/DoesNotIntersectBoundingBoxQuery.md deleted file mode 100644 index 5ca6d528..00000000 --- a/docs/v1/models/DoesNotIntersectBoundingBoxQuery.md +++ /dev/null @@ -1,14 +0,0 @@ -# DoesNotIntersectBoundingBoxQuery - -Returns objects where the specified field does not intersect the bounding box provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | BoundingBoxValue | Yes | | -**type** | Literal["doesNotIntersectBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DoesNotIntersectBoundingBoxQueryDict.md b/docs/v1/models/DoesNotIntersectBoundingBoxQueryDict.md deleted file mode 100644 index d763cb67..00000000 --- a/docs/v1/models/DoesNotIntersectBoundingBoxQueryDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# DoesNotIntersectBoundingBoxQueryDict - -Returns objects where the specified field does not intersect the bounding box provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | BoundingBoxValueDict | Yes | | -**type** | Literal["doesNotIntersectBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DoesNotIntersectPolygonQuery.md b/docs/v1/models/DoesNotIntersectPolygonQuery.md deleted file mode 100644 index ac0ef155..00000000 --- a/docs/v1/models/DoesNotIntersectPolygonQuery.md +++ /dev/null @@ -1,14 +0,0 @@ -# DoesNotIntersectPolygonQuery - -Returns objects where the specified field does not intersect the polygon provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PolygonValue | Yes | | -**type** | Literal["doesNotIntersectPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DoesNotIntersectPolygonQueryDict.md b/docs/v1/models/DoesNotIntersectPolygonQueryDict.md deleted file mode 100644 index a38edf4a..00000000 --- a/docs/v1/models/DoesNotIntersectPolygonQueryDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# DoesNotIntersectPolygonQueryDict - -Returns objects where the specified field does not intersect the polygon provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PolygonValueDict | Yes | | -**type** | Literal["doesNotIntersectPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DoubleType.md b/docs/v1/models/DoubleType.md deleted file mode 100644 index af09ae90..00000000 --- a/docs/v1/models/DoubleType.md +++ /dev/null @@ -1,11 +0,0 @@ -# DoubleType - -DoubleType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["double"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/DoubleTypeDict.md b/docs/v1/models/DoubleTypeDict.md deleted file mode 100644 index c1f0237c..00000000 --- a/docs/v1/models/DoubleTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# DoubleTypeDict - -DoubleType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["double"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Duration.md b/docs/v1/models/Duration.md deleted file mode 100644 index 550592aa..00000000 --- a/docs/v1/models/Duration.md +++ /dev/null @@ -1,11 +0,0 @@ -# Duration - -An ISO 8601 formatted duration. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/EqualsQuery.md b/docs/v1/models/EqualsQuery.md deleted file mode 100644 index cd66cf5f..00000000 --- a/docs/v1/models/EqualsQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# EqualsQuery - -Returns objects where the specified field is equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["eq"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/EqualsQueryDict.md b/docs/v1/models/EqualsQueryDict.md deleted file mode 100644 index d3e8c53c..00000000 --- a/docs/v1/models/EqualsQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# EqualsQueryDict - -Returns objects where the specified field is equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["eq"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/EqualsQueryV2.md b/docs/v1/models/EqualsQueryV2.md deleted file mode 100644 index 2270ebd6..00000000 --- a/docs/v1/models/EqualsQueryV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# EqualsQueryV2 - -Returns objects where the specified field is equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["eq"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/EqualsQueryV2Dict.md b/docs/v1/models/EqualsQueryV2Dict.md deleted file mode 100644 index 1f8a5f4b..00000000 --- a/docs/v1/models/EqualsQueryV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# EqualsQueryV2Dict - -Returns objects where the specified field is equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["eq"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Error.md b/docs/v1/models/Error.md deleted file mode 100644 index 3d35e187..00000000 --- a/docs/v1/models/Error.md +++ /dev/null @@ -1,13 +0,0 @@ -# Error - -Error - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**error** | ErrorName | Yes | | -**args** | List[Arg] | Yes | | -**type** | Literal["error"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ErrorDict.md b/docs/v1/models/ErrorDict.md deleted file mode 100644 index d5ff76c1..00000000 --- a/docs/v1/models/ErrorDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ErrorDict - -Error - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**error** | ErrorName | Yes | | -**args** | List[ArgDict] | Yes | | -**type** | Literal["error"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ErrorName.md b/docs/v1/models/ErrorName.md deleted file mode 100644 index 77550856..00000000 --- a/docs/v1/models/ErrorName.md +++ /dev/null @@ -1,11 +0,0 @@ -# ErrorName - -ErrorName - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ExactDistinctAggregationV2.md b/docs/v1/models/ExactDistinctAggregationV2.md deleted file mode 100644 index 8bbb7ce6..00000000 --- a/docs/v1/models/ExactDistinctAggregationV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# ExactDistinctAggregationV2 - -Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["exactDistinct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ExactDistinctAggregationV2Dict.md b/docs/v1/models/ExactDistinctAggregationV2Dict.md deleted file mode 100644 index 4e025669..00000000 --- a/docs/v1/models/ExactDistinctAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ExactDistinctAggregationV2Dict - -Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["exactDistinct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ExecuteQueryRequest.md b/docs/v1/models/ExecuteQueryRequest.md deleted file mode 100644 index d94190ba..00000000 --- a/docs/v1/models/ExecuteQueryRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExecuteQueryRequest - -ExecuteQueryRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ExecuteQueryRequestDict.md b/docs/v1/models/ExecuteQueryRequestDict.md deleted file mode 100644 index 80b43b99..00000000 --- a/docs/v1/models/ExecuteQueryRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExecuteQueryRequestDict - -ExecuteQueryRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ExecuteQueryResponse.md b/docs/v1/models/ExecuteQueryResponse.md deleted file mode 100644 index 96e4443a..00000000 --- a/docs/v1/models/ExecuteQueryResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExecuteQueryResponse - -ExecuteQueryResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | DataValue | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ExecuteQueryResponseDict.md b/docs/v1/models/ExecuteQueryResponseDict.md deleted file mode 100644 index b81c9994..00000000 --- a/docs/v1/models/ExecuteQueryResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExecuteQueryResponseDict - -ExecuteQueryResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | DataValue | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Feature.md b/docs/v1/models/Feature.md deleted file mode 100644 index c091cff6..00000000 --- a/docs/v1/models/Feature.md +++ /dev/null @@ -1,15 +0,0 @@ -# Feature - -GeoJSon 'Feature' object - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**geometry** | Optional[Geometry] | No | | -**properties** | Dict[FeaturePropertyKey, Any] | Yes | A `Feature` object has a member with the name "properties". The value of the properties member is an object (any JSON object or a JSON null value). | -**id** | Optional[Any] | No | If a `Feature` has a commonly used identifier, that identifier SHOULD be included as a member of the Feature object with the name "id", and the value of this member is either a JSON string or number. | -**bbox** | Optional[BBox] | No | | -**type** | Literal["Feature"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FeatureCollection.md b/docs/v1/models/FeatureCollection.md deleted file mode 100644 index 7273a29d..00000000 --- a/docs/v1/models/FeatureCollection.md +++ /dev/null @@ -1,13 +0,0 @@ -# FeatureCollection - -GeoJSon 'FeatureCollection' object - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**features** | List[FeatureCollectionTypes] | Yes | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["FeatureCollection"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FeatureCollectionDict.md b/docs/v1/models/FeatureCollectionDict.md deleted file mode 100644 index 39f9da49..00000000 --- a/docs/v1/models/FeatureCollectionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# FeatureCollectionDict - -GeoJSon 'FeatureCollection' object - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**features** | List[FeatureCollectionTypesDict] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["FeatureCollection"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FeatureCollectionTypes.md b/docs/v1/models/FeatureCollectionTypes.md deleted file mode 100644 index 6a8a6576..00000000 --- a/docs/v1/models/FeatureCollectionTypes.md +++ /dev/null @@ -1,11 +0,0 @@ -# FeatureCollectionTypes - -FeatureCollectionTypes - -## Type -```python -Feature -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FeatureCollectionTypesDict.md b/docs/v1/models/FeatureCollectionTypesDict.md deleted file mode 100644 index 7c7f31ed..00000000 --- a/docs/v1/models/FeatureCollectionTypesDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# FeatureCollectionTypesDict - -FeatureCollectionTypes - -## Type -```python -FeatureDict -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FeatureDict.md b/docs/v1/models/FeatureDict.md deleted file mode 100644 index 8c454678..00000000 --- a/docs/v1/models/FeatureDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# FeatureDict - -GeoJSon 'Feature' object - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**geometry** | NotRequired[GeometryDict] | No | | -**properties** | Dict[FeaturePropertyKey, Any] | Yes | A `Feature` object has a member with the name "properties". The value of the properties member is an object (any JSON object or a JSON null value). | -**id** | NotRequired[Any] | No | If a `Feature` has a commonly used identifier, that identifier SHOULD be included as a member of the Feature object with the name "id", and the value of this member is either a JSON string or number. | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["Feature"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FeaturePropertyKey.md b/docs/v1/models/FeaturePropertyKey.md deleted file mode 100644 index 11e3449e..00000000 --- a/docs/v1/models/FeaturePropertyKey.md +++ /dev/null @@ -1,11 +0,0 @@ -# FeaturePropertyKey - -FeaturePropertyKey - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FieldNameV1.md b/docs/v1/models/FieldNameV1.md deleted file mode 100644 index ed9bfdf4..00000000 --- a/docs/v1/models/FieldNameV1.md +++ /dev/null @@ -1,11 +0,0 @@ -# FieldNameV1 - -A reference to an Ontology object property with the form `properties.{propertyApiName}`. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/File.md b/docs/v1/models/File.md deleted file mode 100644 index 75f80d85..00000000 --- a/docs/v1/models/File.md +++ /dev/null @@ -1,14 +0,0 @@ -# File - -File - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**path** | FilePath | Yes | | -**transaction_rid** | TransactionRid | Yes | | -**size_bytes** | Optional[StrictStr] | No | | -**updated_time** | datetime | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FileDict.md b/docs/v1/models/FileDict.md deleted file mode 100644 index af2c68b5..00000000 --- a/docs/v1/models/FileDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# FileDict - -File - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**path** | FilePath | Yes | | -**transactionRid** | TransactionRid | Yes | | -**sizeBytes** | NotRequired[StrictStr] | No | | -**updatedTime** | datetime | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FilePath.md b/docs/v1/models/FilePath.md deleted file mode 100644 index b2bfa41e..00000000 --- a/docs/v1/models/FilePath.md +++ /dev/null @@ -1,12 +0,0 @@ -# FilePath - -The path to a File within Foundry. Examples: `my-file.txt`, `path/to/my-file.jpg`, `dataframe.snappy.parquet`. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Filename.md b/docs/v1/models/Filename.md deleted file mode 100644 index 5d9c8adb..00000000 --- a/docs/v1/models/Filename.md +++ /dev/null @@ -1,12 +0,0 @@ -# Filename - -The name of a File within Foundry. Examples: `my-file.txt`, `my-file.jpg`, `dataframe.snappy.parquet`. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FilesystemResource.md b/docs/v1/models/FilesystemResource.md deleted file mode 100644 index 16406ba4..00000000 --- a/docs/v1/models/FilesystemResource.md +++ /dev/null @@ -1,10 +0,0 @@ -# FilesystemResource - -FilesystemResource - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FilesystemResourceDict.md b/docs/v1/models/FilesystemResourceDict.md deleted file mode 100644 index b4d1882a..00000000 --- a/docs/v1/models/FilesystemResourceDict.md +++ /dev/null @@ -1,10 +0,0 @@ -# FilesystemResourceDict - -FilesystemResource - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FilterValue.md b/docs/v1/models/FilterValue.md deleted file mode 100644 index 564f035c..00000000 --- a/docs/v1/models/FilterValue.md +++ /dev/null @@ -1,13 +0,0 @@ -# FilterValue - -Represents the value of a property filter. For instance, false is the FilterValue in -`properties.{propertyApiName}.isNull=false`. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FloatType.md b/docs/v1/models/FloatType.md deleted file mode 100644 index 97e48cc1..00000000 --- a/docs/v1/models/FloatType.md +++ /dev/null @@ -1,11 +0,0 @@ -# FloatType - -FloatType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["float"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FloatTypeDict.md b/docs/v1/models/FloatTypeDict.md deleted file mode 100644 index 9eee0165..00000000 --- a/docs/v1/models/FloatTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# FloatTypeDict - -FloatType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["float"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FolderRid.md b/docs/v1/models/FolderRid.md deleted file mode 100644 index 460abec6..00000000 --- a/docs/v1/models/FolderRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# FolderRid - -FolderRid - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FunctionRid.md b/docs/v1/models/FunctionRid.md deleted file mode 100644 index 2a81663f..00000000 --- a/docs/v1/models/FunctionRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# FunctionRid - -The unique resource identifier of a Function, useful for interacting with other Foundry APIs. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FunctionVersion.md b/docs/v1/models/FunctionVersion.md deleted file mode 100644 index 6e532df2..00000000 --- a/docs/v1/models/FunctionVersion.md +++ /dev/null @@ -1,13 +0,0 @@ -# FunctionVersion - -The version of the given Function, written `..-`, where `-` is optional. -Examples: `1.2.3`, `1.2.3-rc1`. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Fuzzy.md b/docs/v1/models/Fuzzy.md deleted file mode 100644 index 1e314ca5..00000000 --- a/docs/v1/models/Fuzzy.md +++ /dev/null @@ -1,11 +0,0 @@ -# Fuzzy - -Setting fuzzy to `true` allows approximate matching in search queries that support it. - -## Type -```python -StrictBool -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/FuzzyV2.md b/docs/v1/models/FuzzyV2.md deleted file mode 100644 index 352d2b0e..00000000 --- a/docs/v1/models/FuzzyV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# FuzzyV2 - -Setting fuzzy to `true` allows approximate matching in search queries that support it. - -## Type -```python -StrictBool -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GeoJsonObject.md b/docs/v1/models/GeoJsonObject.md deleted file mode 100644 index 6bc9e2be..00000000 --- a/docs/v1/models/GeoJsonObject.md +++ /dev/null @@ -1,35 +0,0 @@ -# GeoJsonObject - -GeoJSon object - -The coordinate reference system for all GeoJSON coordinates is a -geographic coordinate reference system, using the World Geodetic System -1984 (WGS 84) datum, with longitude and latitude units of decimal -degrees. -This is equivalent to the coordinate reference system identified by the -Open Geospatial Consortium (OGC) URN -An OPTIONAL third-position element SHALL be the height in meters above -or below the WGS 84 reference ellipsoid. -In the absence of elevation values, applications sensitive to height or -depth SHOULD interpret positions as being at local ground or sea level. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[Feature](Feature.md) | Feature -[FeatureCollection](FeatureCollection.md) | FeatureCollection -[GeoPoint](GeoPoint.md) | Point -[MultiPoint](MultiPoint.md) | MultiPoint -[LineString](LineString.md) | LineString -[MultiLineString](MultiLineString.md) | MultiLineString -[Polygon](Polygon.md) | Polygon -[MultiPolygon](MultiPolygon.md) | MultiPolygon -[GeometryCollection](GeometryCollection.md) | GeometryCollection - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GeoJsonObjectDict.md b/docs/v1/models/GeoJsonObjectDict.md deleted file mode 100644 index 39a043d0..00000000 --- a/docs/v1/models/GeoJsonObjectDict.md +++ /dev/null @@ -1,35 +0,0 @@ -# GeoJsonObjectDict - -GeoJSon object - -The coordinate reference system for all GeoJSON coordinates is a -geographic coordinate reference system, using the World Geodetic System -1984 (WGS 84) datum, with longitude and latitude units of decimal -degrees. -This is equivalent to the coordinate reference system identified by the -Open Geospatial Consortium (OGC) URN -An OPTIONAL third-position element SHALL be the height in meters above -or below the WGS 84 reference ellipsoid. -In the absence of elevation values, applications sensitive to height or -depth SHOULD interpret positions as being at local ground or sea level. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[FeatureDict](FeatureDict.md) | Feature -[FeatureCollectionDict](FeatureCollectionDict.md) | FeatureCollection -[GeoPointDict](GeoPointDict.md) | Point -[MultiPointDict](MultiPointDict.md) | MultiPoint -[LineStringDict](LineStringDict.md) | LineString -[MultiLineStringDict](MultiLineStringDict.md) | MultiLineString -[PolygonDict](PolygonDict.md) | Polygon -[MultiPolygonDict](MultiPolygonDict.md) | MultiPolygon -[GeometryCollectionDict](GeometryCollectionDict.md) | GeometryCollection - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GeoPoint.md b/docs/v1/models/GeoPoint.md deleted file mode 100644 index 3d4ba2ac..00000000 --- a/docs/v1/models/GeoPoint.md +++ /dev/null @@ -1,13 +0,0 @@ -# GeoPoint - -GeoPoint - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | Position | Yes | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["Point"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GeoPointDict.md b/docs/v1/models/GeoPointDict.md deleted file mode 100644 index b626f000..00000000 --- a/docs/v1/models/GeoPointDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GeoPointDict - -GeoPoint - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | Position | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["Point"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GeoPointType.md b/docs/v1/models/GeoPointType.md deleted file mode 100644 index 4081f369..00000000 --- a/docs/v1/models/GeoPointType.md +++ /dev/null @@ -1,11 +0,0 @@ -# GeoPointType - -GeoPointType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["geopoint"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GeoPointTypeDict.md b/docs/v1/models/GeoPointTypeDict.md deleted file mode 100644 index b3e35bf6..00000000 --- a/docs/v1/models/GeoPointTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GeoPointTypeDict - -GeoPointType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["geopoint"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GeoShapeType.md b/docs/v1/models/GeoShapeType.md deleted file mode 100644 index bf4af889..00000000 --- a/docs/v1/models/GeoShapeType.md +++ /dev/null @@ -1,11 +0,0 @@ -# GeoShapeType - -GeoShapeType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["geoshape"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GeoShapeTypeDict.md b/docs/v1/models/GeoShapeTypeDict.md deleted file mode 100644 index 71b42bba..00000000 --- a/docs/v1/models/GeoShapeTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GeoShapeTypeDict - -GeoShapeType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["geoshape"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Geometry.md b/docs/v1/models/Geometry.md deleted file mode 100644 index 1ddad4ac..00000000 --- a/docs/v1/models/Geometry.md +++ /dev/null @@ -1,21 +0,0 @@ -# Geometry - -Abstract type for all GeoJSon object except Feature and FeatureCollection - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[GeoPoint](GeoPoint.md) | Point -[MultiPoint](MultiPoint.md) | MultiPoint -[LineString](LineString.md) | LineString -[MultiLineString](MultiLineString.md) | MultiLineString -[Polygon](Polygon.md) | Polygon -[MultiPolygon](MultiPolygon.md) | MultiPolygon -[GeometryCollection](GeometryCollection.md) | GeometryCollection - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GeometryCollection.md b/docs/v1/models/GeometryCollection.md deleted file mode 100644 index d48929e3..00000000 --- a/docs/v1/models/GeometryCollection.md +++ /dev/null @@ -1,19 +0,0 @@ -# GeometryCollection - -GeoJSon geometry collection - -GeometryCollections composed of a single part or a number of parts of a -single type SHOULD be avoided when that single part or a single object -of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could -be used instead. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**geometries** | List[Geometry] | Yes | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["GeometryCollection"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GeometryCollectionDict.md b/docs/v1/models/GeometryCollectionDict.md deleted file mode 100644 index b22eab91..00000000 --- a/docs/v1/models/GeometryCollectionDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# GeometryCollectionDict - -GeoJSon geometry collection - -GeometryCollections composed of a single part or a number of parts of a -single type SHOULD be avoided when that single part or a single object -of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could -be used instead. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**geometries** | List[GeometryDict] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["GeometryCollection"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GeometryDict.md b/docs/v1/models/GeometryDict.md deleted file mode 100644 index 4ababb09..00000000 --- a/docs/v1/models/GeometryDict.md +++ /dev/null @@ -1,21 +0,0 @@ -# GeometryDict - -Abstract type for all GeoJSon object except Feature and FeatureCollection - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[GeoPointDict](GeoPointDict.md) | Point -[MultiPointDict](MultiPointDict.md) | MultiPoint -[LineStringDict](LineStringDict.md) | LineString -[MultiLineStringDict](MultiLineStringDict.md) | MultiLineString -[PolygonDict](PolygonDict.md) | Polygon -[MultiPolygonDict](MultiPolygonDict.md) | MultiPolygon -[GeometryCollectionDict](GeometryCollectionDict.md) | GeometryCollection - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GeotimeSeriesValue.md b/docs/v1/models/GeotimeSeriesValue.md deleted file mode 100644 index adaaa62b..00000000 --- a/docs/v1/models/GeotimeSeriesValue.md +++ /dev/null @@ -1,13 +0,0 @@ -# GeotimeSeriesValue - -The underlying data values pointed to by a GeotimeSeriesReference. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**position** | Position | Yes | | -**timestamp** | datetime | Yes | | -**type** | Literal["geotimeSeriesValue"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GeotimeSeriesValueDict.md b/docs/v1/models/GeotimeSeriesValueDict.md deleted file mode 100644 index 9fbfe1f1..00000000 --- a/docs/v1/models/GeotimeSeriesValueDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GeotimeSeriesValueDict - -The underlying data values pointed to by a GeotimeSeriesReference. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**position** | Position | Yes | | -**timestamp** | datetime | Yes | | -**type** | Literal["geotimeSeriesValue"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GroupMemberConstraint.md b/docs/v1/models/GroupMemberConstraint.md deleted file mode 100644 index 22d6bd3e..00000000 --- a/docs/v1/models/GroupMemberConstraint.md +++ /dev/null @@ -1,12 +0,0 @@ -# GroupMemberConstraint - -The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["groupMember"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GroupMemberConstraintDict.md b/docs/v1/models/GroupMemberConstraintDict.md deleted file mode 100644 index cbf308be..00000000 --- a/docs/v1/models/GroupMemberConstraintDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# GroupMemberConstraintDict - -The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["groupMember"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GtQuery.md b/docs/v1/models/GtQuery.md deleted file mode 100644 index 102e047a..00000000 --- a/docs/v1/models/GtQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# GtQuery - -Returns objects where the specified field is greater than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GtQueryDict.md b/docs/v1/models/GtQueryDict.md deleted file mode 100644 index 60919e97..00000000 --- a/docs/v1/models/GtQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GtQueryDict - -Returns objects where the specified field is greater than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GtQueryV2.md b/docs/v1/models/GtQueryV2.md deleted file mode 100644 index f4d9262c..00000000 --- a/docs/v1/models/GtQueryV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# GtQueryV2 - -Returns objects where the specified field is greater than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GtQueryV2Dict.md b/docs/v1/models/GtQueryV2Dict.md deleted file mode 100644 index 9ac7d110..00000000 --- a/docs/v1/models/GtQueryV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GtQueryV2Dict - -Returns objects where the specified field is greater than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GteQuery.md b/docs/v1/models/GteQuery.md deleted file mode 100644 index 4ef45afe..00000000 --- a/docs/v1/models/GteQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# GteQuery - -Returns objects where the specified field is greater than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GteQueryDict.md b/docs/v1/models/GteQueryDict.md deleted file mode 100644 index e42206c6..00000000 --- a/docs/v1/models/GteQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GteQueryDict - -Returns objects where the specified field is greater than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GteQueryV2.md b/docs/v1/models/GteQueryV2.md deleted file mode 100644 index 69c7cdaa..00000000 --- a/docs/v1/models/GteQueryV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# GteQueryV2 - -Returns objects where the specified field is greater than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/GteQueryV2Dict.md b/docs/v1/models/GteQueryV2Dict.md deleted file mode 100644 index ba398398..00000000 --- a/docs/v1/models/GteQueryV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GteQueryV2Dict - -Returns objects where the specified field is greater than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Icon.md b/docs/v1/models/Icon.md deleted file mode 100644 index 60051c36..00000000 --- a/docs/v1/models/Icon.md +++ /dev/null @@ -1,11 +0,0 @@ -# Icon - -A union currently only consisting of the BlueprintIcon (more icon types may be added in the future). - -## Type -```python -BlueprintIcon -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/IconDict.md b/docs/v1/models/IconDict.md deleted file mode 100644 index b40fa620..00000000 --- a/docs/v1/models/IconDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# IconDict - -A union currently only consisting of the BlueprintIcon (more icon types may be added in the future). - -## Type -```python -BlueprintIconDict -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/IntegerType.md b/docs/v1/models/IntegerType.md deleted file mode 100644 index 8717aac8..00000000 --- a/docs/v1/models/IntegerType.md +++ /dev/null @@ -1,11 +0,0 @@ -# IntegerType - -IntegerType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["integer"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/IntegerTypeDict.md b/docs/v1/models/IntegerTypeDict.md deleted file mode 100644 index 7b85414b..00000000 --- a/docs/v1/models/IntegerTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# IntegerTypeDict - -IntegerType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["integer"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/InterfaceLinkType.md b/docs/v1/models/InterfaceLinkType.md deleted file mode 100644 index f54c2733..00000000 --- a/docs/v1/models/InterfaceLinkType.md +++ /dev/null @@ -1,19 +0,0 @@ -# InterfaceLinkType - -A link type constraint defined at the interface level where the implementation of the links is provided -by the implementing object types. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | InterfaceLinkTypeRid | Yes | | -**api_name** | InterfaceLinkTypeApiName | Yes | | -**display_name** | DisplayName | Yes | | -**description** | Optional[StrictStr] | No | The description of the interface link type. | -**linked_entity_api_name** | InterfaceLinkTypeLinkedEntityApiName | Yes | | -**cardinality** | InterfaceLinkTypeCardinality | Yes | | -**required** | StrictBool | Yes | Whether each implementing object type must declare at least one implementation of this link. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/InterfaceLinkTypeApiName.md b/docs/v1/models/InterfaceLinkTypeApiName.md deleted file mode 100644 index b2912241..00000000 --- a/docs/v1/models/InterfaceLinkTypeApiName.md +++ /dev/null @@ -1,11 +0,0 @@ -# InterfaceLinkTypeApiName - -A string indicating the API name to use for the interface link. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/InterfaceLinkTypeCardinality.md b/docs/v1/models/InterfaceLinkTypeCardinality.md deleted file mode 100644 index 095f8206..00000000 --- a/docs/v1/models/InterfaceLinkTypeCardinality.md +++ /dev/null @@ -1,13 +0,0 @@ -# InterfaceLinkTypeCardinality - -The cardinality of the link in the given direction. Cardinality can be "ONE", meaning an object can -link to zero or one other objects, or "MANY", meaning an object can link to any number of other objects. - - -| **Value** | -| --------- | -| `"ONE"` | -| `"MANY"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/InterfaceLinkTypeDict.md b/docs/v1/models/InterfaceLinkTypeDict.md deleted file mode 100644 index ed9e1a30..00000000 --- a/docs/v1/models/InterfaceLinkTypeDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# InterfaceLinkTypeDict - -A link type constraint defined at the interface level where the implementation of the links is provided -by the implementing object types. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | InterfaceLinkTypeRid | Yes | | -**apiName** | InterfaceLinkTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | NotRequired[StrictStr] | No | The description of the interface link type. | -**linkedEntityApiName** | InterfaceLinkTypeLinkedEntityApiNameDict | Yes | | -**cardinality** | InterfaceLinkTypeCardinality | Yes | | -**required** | StrictBool | Yes | Whether each implementing object type must declare at least one implementation of this link. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/InterfaceLinkTypeLinkedEntityApiName.md b/docs/v1/models/InterfaceLinkTypeLinkedEntityApiName.md deleted file mode 100644 index 68975cd8..00000000 --- a/docs/v1/models/InterfaceLinkTypeLinkedEntityApiName.md +++ /dev/null @@ -1,16 +0,0 @@ -# InterfaceLinkTypeLinkedEntityApiName - -A reference to the linked entity. This can either be an object or an interface type. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[LinkedInterfaceTypeApiName](LinkedInterfaceTypeApiName.md) | interfaceTypeApiName -[LinkedObjectTypeApiName](LinkedObjectTypeApiName.md) | objectTypeApiName - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/InterfaceLinkTypeLinkedEntityApiNameDict.md b/docs/v1/models/InterfaceLinkTypeLinkedEntityApiNameDict.md deleted file mode 100644 index 49c0d299..00000000 --- a/docs/v1/models/InterfaceLinkTypeLinkedEntityApiNameDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# InterfaceLinkTypeLinkedEntityApiNameDict - -A reference to the linked entity. This can either be an object or an interface type. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[LinkedInterfaceTypeApiNameDict](LinkedInterfaceTypeApiNameDict.md) | interfaceTypeApiName -[LinkedObjectTypeApiNameDict](LinkedObjectTypeApiNameDict.md) | objectTypeApiName - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/InterfaceLinkTypeRid.md b/docs/v1/models/InterfaceLinkTypeRid.md deleted file mode 100644 index 50cfe8f3..00000000 --- a/docs/v1/models/InterfaceLinkTypeRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# InterfaceLinkTypeRid - -The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/InterfaceType.md b/docs/v1/models/InterfaceType.md deleted file mode 100644 index 170b00d4..00000000 --- a/docs/v1/models/InterfaceType.md +++ /dev/null @@ -1,17 +0,0 @@ -# InterfaceType - -Represents an interface type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | InterfaceTypeRid | Yes | | -**api_name** | InterfaceTypeApiName | Yes | | -**display_name** | DisplayName | Yes | | -**description** | Optional[StrictStr] | No | The description of the interface. | -**properties** | Dict[SharedPropertyTypeApiName, SharedPropertyType] | Yes | A map from a shared property type API name to the corresponding shared property type. The map describes the set of properties the interface has. A shared property type must be unique across all of the properties. | -**extends_interfaces** | List[InterfaceTypeApiName] | Yes | A list of interface API names that this interface extends. An interface can extend other interfaces to inherit their properties. | -**links** | Dict[InterfaceLinkTypeApiName, InterfaceLinkType] | Yes | A map from an interface link type API name to the corresponding interface link type. The map describes the set of link types the interface has. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/InterfaceTypeApiName.md b/docs/v1/models/InterfaceTypeApiName.md deleted file mode 100644 index 5e033d89..00000000 --- a/docs/v1/models/InterfaceTypeApiName.md +++ /dev/null @@ -1,13 +0,0 @@ -# InterfaceTypeApiName - -The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface -type, use the `List interface types` endpoint or check the **Ontology Manager**. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/InterfaceTypeDict.md b/docs/v1/models/InterfaceTypeDict.md deleted file mode 100644 index ca7c4691..00000000 --- a/docs/v1/models/InterfaceTypeDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# InterfaceTypeDict - -Represents an interface type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | InterfaceTypeRid | Yes | | -**apiName** | InterfaceTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | NotRequired[StrictStr] | No | The description of the interface. | -**properties** | Dict[SharedPropertyTypeApiName, SharedPropertyTypeDict] | Yes | A map from a shared property type API name to the corresponding shared property type. The map describes the set of properties the interface has. A shared property type must be unique across all of the properties. | -**extendsInterfaces** | List[InterfaceTypeApiName] | Yes | A list of interface API names that this interface extends. An interface can extend other interfaces to inherit their properties. | -**links** | Dict[InterfaceLinkTypeApiName, InterfaceLinkTypeDict] | Yes | A map from an interface link type API name to the corresponding interface link type. The map describes the set of link types the interface has. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/InterfaceTypeRid.md b/docs/v1/models/InterfaceTypeRid.md deleted file mode 100644 index a67963e5..00000000 --- a/docs/v1/models/InterfaceTypeRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# InterfaceTypeRid - -The unique resource identifier of an interface, useful for interacting with other Foundry APIs. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/IntersectsBoundingBoxQuery.md b/docs/v1/models/IntersectsBoundingBoxQuery.md deleted file mode 100644 index 6af914af..00000000 --- a/docs/v1/models/IntersectsBoundingBoxQuery.md +++ /dev/null @@ -1,14 +0,0 @@ -# IntersectsBoundingBoxQuery - -Returns objects where the specified field intersects the bounding box provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | BoundingBoxValue | Yes | | -**type** | Literal["intersectsBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/IntersectsBoundingBoxQueryDict.md b/docs/v1/models/IntersectsBoundingBoxQueryDict.md deleted file mode 100644 index 7ece7cff..00000000 --- a/docs/v1/models/IntersectsBoundingBoxQueryDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# IntersectsBoundingBoxQueryDict - -Returns objects where the specified field intersects the bounding box provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | BoundingBoxValueDict | Yes | | -**type** | Literal["intersectsBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/IntersectsPolygonQuery.md b/docs/v1/models/IntersectsPolygonQuery.md deleted file mode 100644 index ce382982..00000000 --- a/docs/v1/models/IntersectsPolygonQuery.md +++ /dev/null @@ -1,14 +0,0 @@ -# IntersectsPolygonQuery - -Returns objects where the specified field intersects the polygon provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PolygonValue | Yes | | -**type** | Literal["intersectsPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/IntersectsPolygonQueryDict.md b/docs/v1/models/IntersectsPolygonQueryDict.md deleted file mode 100644 index abf6f541..00000000 --- a/docs/v1/models/IntersectsPolygonQueryDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# IntersectsPolygonQueryDict - -Returns objects where the specified field intersects the polygon provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PolygonValueDict | Yes | | -**type** | Literal["intersectsPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/IsNullQuery.md b/docs/v1/models/IsNullQuery.md deleted file mode 100644 index 84bfe10e..00000000 --- a/docs/v1/models/IsNullQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# IsNullQuery - -Returns objects based on the existence of the specified field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictBool | Yes | | -**type** | Literal["isNull"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/IsNullQueryDict.md b/docs/v1/models/IsNullQueryDict.md deleted file mode 100644 index dbe12060..00000000 --- a/docs/v1/models/IsNullQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# IsNullQueryDict - -Returns objects based on the existence of the specified field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictBool | Yes | | -**type** | Literal["isNull"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/IsNullQueryV2.md b/docs/v1/models/IsNullQueryV2.md deleted file mode 100644 index b51a0cc5..00000000 --- a/docs/v1/models/IsNullQueryV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# IsNullQueryV2 - -Returns objects based on the existence of the specified field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictBool | Yes | | -**type** | Literal["isNull"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/IsNullQueryV2Dict.md b/docs/v1/models/IsNullQueryV2Dict.md deleted file mode 100644 index aacc827e..00000000 --- a/docs/v1/models/IsNullQueryV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# IsNullQueryV2Dict - -Returns objects based on the existence of the specified field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictBool | Yes | | -**type** | Literal["isNull"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LineString.md b/docs/v1/models/LineString.md deleted file mode 100644 index 81b4d131..00000000 --- a/docs/v1/models/LineString.md +++ /dev/null @@ -1,13 +0,0 @@ -# LineString - -LineString - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | Optional[LineStringCoordinates] | No | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["LineString"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LineStringCoordinates.md b/docs/v1/models/LineStringCoordinates.md deleted file mode 100644 index 127083dc..00000000 --- a/docs/v1/models/LineStringCoordinates.md +++ /dev/null @@ -1,12 +0,0 @@ -# LineStringCoordinates - -GeoJSon fundamental geometry construct, array of two or more positions. - - -## Type -```python -List[Position] -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LineStringDict.md b/docs/v1/models/LineStringDict.md deleted file mode 100644 index 3f8c9a01..00000000 --- a/docs/v1/models/LineStringDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LineStringDict - -LineString - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | NotRequired[LineStringCoordinates] | No | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["LineString"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinearRing.md b/docs/v1/models/LinearRing.md deleted file mode 100644 index 156580b3..00000000 --- a/docs/v1/models/LinearRing.md +++ /dev/null @@ -1,22 +0,0 @@ -# LinearRing - -A linear ring is a closed LineString with four or more positions. - -The first and last positions are equivalent, and they MUST contain -identical values; their representation SHOULD also be identical. - -A linear ring is the boundary of a surface or the boundary of a hole in -a surface. - -A linear ring MUST follow the right-hand rule with respect to the area -it bounds, i.e., exterior rings are counterclockwise, and holes are -clockwise. - - -## Type -```python -List[Position] -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinkSideObject.md b/docs/v1/models/LinkSideObject.md deleted file mode 100644 index 12f40ee3..00000000 --- a/docs/v1/models/LinkSideObject.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkSideObject - -LinkSideObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primary_key** | PropertyValue | Yes | | -**object_type** | ObjectTypeApiName | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinkSideObjectDict.md b/docs/v1/models/LinkSideObjectDict.md deleted file mode 100644 index 7dcc978e..00000000 --- a/docs/v1/models/LinkSideObjectDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkSideObjectDict - -LinkSideObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primaryKey** | PropertyValue | Yes | | -**objectType** | ObjectTypeApiName | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinkTypeApiName.md b/docs/v1/models/LinkTypeApiName.md deleted file mode 100644 index b8028932..00000000 --- a/docs/v1/models/LinkTypeApiName.md +++ /dev/null @@ -1,13 +0,0 @@ -# LinkTypeApiName - -The name of the link type in the API. To find the API name for your Link Type, check the **Ontology Manager** -application. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinkTypeRid.md b/docs/v1/models/LinkTypeRid.md deleted file mode 100644 index 01eef4a2..00000000 --- a/docs/v1/models/LinkTypeRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# LinkTypeRid - -LinkTypeRid - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinkTypeSide.md b/docs/v1/models/LinkTypeSide.md deleted file mode 100644 index 4990585b..00000000 --- a/docs/v1/models/LinkTypeSide.md +++ /dev/null @@ -1,16 +0,0 @@ -# LinkTypeSide - -LinkTypeSide - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | LinkTypeApiName | Yes | | -**display_name** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**object_type_api_name** | ObjectTypeApiName | Yes | | -**cardinality** | LinkTypeSideCardinality | Yes | | -**foreign_key_property_api_name** | Optional[PropertyApiName] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinkTypeSideCardinality.md b/docs/v1/models/LinkTypeSideCardinality.md deleted file mode 100644 index a9ef1876..00000000 --- a/docs/v1/models/LinkTypeSideCardinality.md +++ /dev/null @@ -1,11 +0,0 @@ -# LinkTypeSideCardinality - -LinkTypeSideCardinality - -| **Value** | -| --------- | -| `"ONE"` | -| `"MANY"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinkTypeSideDict.md b/docs/v1/models/LinkTypeSideDict.md deleted file mode 100644 index d5593217..00000000 --- a/docs/v1/models/LinkTypeSideDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# LinkTypeSideDict - -LinkTypeSide - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | LinkTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**cardinality** | LinkTypeSideCardinality | Yes | | -**foreignKeyPropertyApiName** | NotRequired[PropertyApiName] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinkTypeSideV2.md b/docs/v1/models/LinkTypeSideV2.md deleted file mode 100644 index 50e510d2..00000000 --- a/docs/v1/models/LinkTypeSideV2.md +++ /dev/null @@ -1,17 +0,0 @@ -# LinkTypeSideV2 - -LinkTypeSideV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | LinkTypeApiName | Yes | | -**display_name** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**object_type_api_name** | ObjectTypeApiName | Yes | | -**cardinality** | LinkTypeSideCardinality | Yes | | -**foreign_key_property_api_name** | Optional[PropertyApiName] | No | | -**link_type_rid** | LinkTypeRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinkTypeSideV2Dict.md b/docs/v1/models/LinkTypeSideV2Dict.md deleted file mode 100644 index 23bc1590..00000000 --- a/docs/v1/models/LinkTypeSideV2Dict.md +++ /dev/null @@ -1,17 +0,0 @@ -# LinkTypeSideV2Dict - -LinkTypeSideV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | LinkTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**cardinality** | LinkTypeSideCardinality | Yes | | -**foreignKeyPropertyApiName** | NotRequired[PropertyApiName] | No | | -**linkTypeRid** | LinkTypeRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinkedInterfaceTypeApiName.md b/docs/v1/models/LinkedInterfaceTypeApiName.md deleted file mode 100644 index 3a5ff4a1..00000000 --- a/docs/v1/models/LinkedInterfaceTypeApiName.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedInterfaceTypeApiName - -A reference to the linked interface type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | InterfaceTypeApiName | Yes | | -**type** | Literal["interfaceTypeApiName"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinkedInterfaceTypeApiNameDict.md b/docs/v1/models/LinkedInterfaceTypeApiNameDict.md deleted file mode 100644 index 1a5b8b2c..00000000 --- a/docs/v1/models/LinkedInterfaceTypeApiNameDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedInterfaceTypeApiNameDict - -A reference to the linked interface type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | InterfaceTypeApiName | Yes | | -**type** | Literal["interfaceTypeApiName"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinkedObjectTypeApiName.md b/docs/v1/models/LinkedObjectTypeApiName.md deleted file mode 100644 index 80eba18a..00000000 --- a/docs/v1/models/LinkedObjectTypeApiName.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedObjectTypeApiName - -A reference to the linked object type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | ObjectTypeApiName | Yes | | -**type** | Literal["objectTypeApiName"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LinkedObjectTypeApiNameDict.md b/docs/v1/models/LinkedObjectTypeApiNameDict.md deleted file mode 100644 index ffe261cc..00000000 --- a/docs/v1/models/LinkedObjectTypeApiNameDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedObjectTypeApiNameDict - -A reference to the linked object type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ObjectTypeApiName | Yes | | -**type** | Literal["objectTypeApiName"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListActionTypesResponse.md b/docs/v1/models/ListActionTypesResponse.md deleted file mode 100644 index 07935c71..00000000 --- a/docs/v1/models/ListActionTypesResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListActionTypesResponse - -ListActionTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[ActionType] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListActionTypesResponseDict.md b/docs/v1/models/ListActionTypesResponseDict.md deleted file mode 100644 index 0d3c367c..00000000 --- a/docs/v1/models/ListActionTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListActionTypesResponseDict - -ListActionTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[ActionTypeDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListActionTypesResponseV2.md b/docs/v1/models/ListActionTypesResponseV2.md deleted file mode 100644 index c4ea9c80..00000000 --- a/docs/v1/models/ListActionTypesResponseV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListActionTypesResponseV2 - -ListActionTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[ActionTypeV2] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListActionTypesResponseV2Dict.md b/docs/v1/models/ListActionTypesResponseV2Dict.md deleted file mode 100644 index 94b2faf6..00000000 --- a/docs/v1/models/ListActionTypesResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListActionTypesResponseV2Dict - -ListActionTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[ActionTypeV2Dict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListAttachmentsResponseV2.md b/docs/v1/models/ListAttachmentsResponseV2.md deleted file mode 100644 index eefe16a8..00000000 --- a/docs/v1/models/ListAttachmentsResponseV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListAttachmentsResponseV2 - -ListAttachmentsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[AttachmentV2] | Yes | | -**next_page_token** | Optional[PageToken] | No | | -**type** | Literal["multiple"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListAttachmentsResponseV2Dict.md b/docs/v1/models/ListAttachmentsResponseV2Dict.md deleted file mode 100644 index a23d144f..00000000 --- a/docs/v1/models/ListAttachmentsResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListAttachmentsResponseV2Dict - -ListAttachmentsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[AttachmentV2Dict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | -**type** | Literal["multiple"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListBranchesResponse.md b/docs/v1/models/ListBranchesResponse.md deleted file mode 100644 index 3cd4a321..00000000 --- a/docs/v1/models/ListBranchesResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListBranchesResponse - -ListBranchesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[Branch] | Yes | The list of branches in the current page. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListBranchesResponseDict.md b/docs/v1/models/ListBranchesResponseDict.md deleted file mode 100644 index cc3857fd..00000000 --- a/docs/v1/models/ListBranchesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListBranchesResponseDict - -ListBranchesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[BranchDict] | Yes | The list of branches in the current page. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListFilesResponse.md b/docs/v1/models/ListFilesResponse.md deleted file mode 100644 index 94ad17f6..00000000 --- a/docs/v1/models/ListFilesResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListFilesResponse - -A page of Files and an optional page token that can be used to retrieve the next page. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[File] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListFilesResponseDict.md b/docs/v1/models/ListFilesResponseDict.md deleted file mode 100644 index 9e28f657..00000000 --- a/docs/v1/models/ListFilesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListFilesResponseDict - -A page of Files and an optional page token that can be used to retrieve the next page. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[FileDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListInterfaceTypesResponse.md b/docs/v1/models/ListInterfaceTypesResponse.md deleted file mode 100644 index 125346f8..00000000 --- a/docs/v1/models/ListInterfaceTypesResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListInterfaceTypesResponse - -ListInterfaceTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[InterfaceType] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListInterfaceTypesResponseDict.md b/docs/v1/models/ListInterfaceTypesResponseDict.md deleted file mode 100644 index f498c9b3..00000000 --- a/docs/v1/models/ListInterfaceTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListInterfaceTypesResponseDict - -ListInterfaceTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[InterfaceTypeDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListLinkedObjectsResponse.md b/docs/v1/models/ListLinkedObjectsResponse.md deleted file mode 100644 index 35ba6aa6..00000000 --- a/docs/v1/models/ListLinkedObjectsResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListLinkedObjectsResponse - -ListLinkedObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[OntologyObject] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListLinkedObjectsResponseDict.md b/docs/v1/models/ListLinkedObjectsResponseDict.md deleted file mode 100644 index c1c22f99..00000000 --- a/docs/v1/models/ListLinkedObjectsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListLinkedObjectsResponseDict - -ListLinkedObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[OntologyObjectDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListLinkedObjectsResponseV2.md b/docs/v1/models/ListLinkedObjectsResponseV2.md deleted file mode 100644 index 9ab46579..00000000 --- a/docs/v1/models/ListLinkedObjectsResponseV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListLinkedObjectsResponseV2 - -ListLinkedObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | | -**next_page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListLinkedObjectsResponseV2Dict.md b/docs/v1/models/ListLinkedObjectsResponseV2Dict.md deleted file mode 100644 index 036cd04a..00000000 --- a/docs/v1/models/ListLinkedObjectsResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListLinkedObjectsResponseV2Dict - -ListLinkedObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListObjectTypesResponse.md b/docs/v1/models/ListObjectTypesResponse.md deleted file mode 100644 index 2d295786..00000000 --- a/docs/v1/models/ListObjectTypesResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListObjectTypesResponse - -ListObjectTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[ObjectType] | Yes | The list of object types in the current page. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListObjectTypesResponseDict.md b/docs/v1/models/ListObjectTypesResponseDict.md deleted file mode 100644 index 73fc9b51..00000000 --- a/docs/v1/models/ListObjectTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListObjectTypesResponseDict - -ListObjectTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[ObjectTypeDict] | Yes | The list of object types in the current page. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListObjectTypesV2Response.md b/docs/v1/models/ListObjectTypesV2Response.md deleted file mode 100644 index 62efb25f..00000000 --- a/docs/v1/models/ListObjectTypesV2Response.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListObjectTypesV2Response - -ListObjectTypesV2Response - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[ObjectTypeV2] | Yes | The list of object types in the current page. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListObjectTypesV2ResponseDict.md b/docs/v1/models/ListObjectTypesV2ResponseDict.md deleted file mode 100644 index 11f573cf..00000000 --- a/docs/v1/models/ListObjectTypesV2ResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListObjectTypesV2ResponseDict - -ListObjectTypesV2Response - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[ObjectTypeV2Dict] | Yes | The list of object types in the current page. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListObjectsResponse.md b/docs/v1/models/ListObjectsResponse.md deleted file mode 100644 index ae8809dd..00000000 --- a/docs/v1/models/ListObjectsResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListObjectsResponse - -ListObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[OntologyObject] | Yes | The list of objects in the current page. | -**total_count** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListObjectsResponseDict.md b/docs/v1/models/ListObjectsResponseDict.md deleted file mode 100644 index 71b949c9..00000000 --- a/docs/v1/models/ListObjectsResponseDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListObjectsResponseDict - -ListObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[OntologyObjectDict] | Yes | The list of objects in the current page. | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListObjectsResponseV2.md b/docs/v1/models/ListObjectsResponseV2.md deleted file mode 100644 index 6592e03f..00000000 --- a/docs/v1/models/ListObjectsResponseV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListObjectsResponseV2 - -ListObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[OntologyObjectV2] | Yes | The list of objects in the current page. | -**total_count** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListObjectsResponseV2Dict.md b/docs/v1/models/ListObjectsResponseV2Dict.md deleted file mode 100644 index baa5ed69..00000000 --- a/docs/v1/models/ListObjectsResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListObjectsResponseV2Dict - -ListObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[OntologyObjectV2] | Yes | The list of objects in the current page. | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListOntologiesResponse.md b/docs/v1/models/ListOntologiesResponse.md deleted file mode 100644 index 022ad12a..00000000 --- a/docs/v1/models/ListOntologiesResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListOntologiesResponse - -ListOntologiesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[Ontology] | Yes | The list of Ontologies the user has access to. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListOntologiesResponseDict.md b/docs/v1/models/ListOntologiesResponseDict.md deleted file mode 100644 index aadd6d54..00000000 --- a/docs/v1/models/ListOntologiesResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListOntologiesResponseDict - -ListOntologiesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyDict] | Yes | The list of Ontologies the user has access to. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListOntologiesV2Response.md b/docs/v1/models/ListOntologiesV2Response.md deleted file mode 100644 index b7023b8d..00000000 --- a/docs/v1/models/ListOntologiesV2Response.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListOntologiesV2Response - -ListOntologiesV2Response - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyV2] | Yes | The list of Ontologies the user has access to. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListOntologiesV2ResponseDict.md b/docs/v1/models/ListOntologiesV2ResponseDict.md deleted file mode 100644 index 6c0b95fd..00000000 --- a/docs/v1/models/ListOntologiesV2ResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListOntologiesV2ResponseDict - -ListOntologiesV2Response - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyV2Dict] | Yes | The list of Ontologies the user has access to. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListOutgoingLinkTypesResponse.md b/docs/v1/models/ListOutgoingLinkTypesResponse.md deleted file mode 100644 index 5f434b96..00000000 --- a/docs/v1/models/ListOutgoingLinkTypesResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListOutgoingLinkTypesResponse - -ListOutgoingLinkTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[LinkTypeSide] | Yes | The list of link type sides in the current page. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListOutgoingLinkTypesResponseDict.md b/docs/v1/models/ListOutgoingLinkTypesResponseDict.md deleted file mode 100644 index 878b8706..00000000 --- a/docs/v1/models/ListOutgoingLinkTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListOutgoingLinkTypesResponseDict - -ListOutgoingLinkTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[LinkTypeSideDict] | Yes | The list of link type sides in the current page. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListOutgoingLinkTypesResponseV2.md b/docs/v1/models/ListOutgoingLinkTypesResponseV2.md deleted file mode 100644 index 6debc8cb..00000000 --- a/docs/v1/models/ListOutgoingLinkTypesResponseV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListOutgoingLinkTypesResponseV2 - -ListOutgoingLinkTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[LinkTypeSideV2] | Yes | The list of link type sides in the current page. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListOutgoingLinkTypesResponseV2Dict.md b/docs/v1/models/ListOutgoingLinkTypesResponseV2Dict.md deleted file mode 100644 index a0d36124..00000000 --- a/docs/v1/models/ListOutgoingLinkTypesResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListOutgoingLinkTypesResponseV2Dict - -ListOutgoingLinkTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[LinkTypeSideV2Dict] | Yes | The list of link type sides in the current page. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListQueryTypesResponse.md b/docs/v1/models/ListQueryTypesResponse.md deleted file mode 100644 index c032bba5..00000000 --- a/docs/v1/models/ListQueryTypesResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListQueryTypesResponse - -ListQueryTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[QueryType] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListQueryTypesResponseDict.md b/docs/v1/models/ListQueryTypesResponseDict.md deleted file mode 100644 index 04c88772..00000000 --- a/docs/v1/models/ListQueryTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListQueryTypesResponseDict - -ListQueryTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[QueryTypeDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListQueryTypesResponseV2.md b/docs/v1/models/ListQueryTypesResponseV2.md deleted file mode 100644 index 25145de3..00000000 --- a/docs/v1/models/ListQueryTypesResponseV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListQueryTypesResponseV2 - -ListQueryTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[QueryTypeV2] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ListQueryTypesResponseV2Dict.md b/docs/v1/models/ListQueryTypesResponseV2Dict.md deleted file mode 100644 index bcc46b0e..00000000 --- a/docs/v1/models/ListQueryTypesResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListQueryTypesResponseV2Dict - -ListQueryTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[QueryTypeV2Dict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LoadObjectSetRequestV2.md b/docs/v1/models/LoadObjectSetRequestV2.md deleted file mode 100644 index 22239251..00000000 --- a/docs/v1/models/LoadObjectSetRequestV2.md +++ /dev/null @@ -1,16 +0,0 @@ -# LoadObjectSetRequestV2 - -Represents the API POST body when loading an `ObjectSet`. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_set** | ObjectSet | Yes | | -**order_by** | Optional[SearchOrderByV2] | No | | -**select** | List[SelectedPropertyApiName] | Yes | | -**page_token** | Optional[PageToken] | No | | -**page_size** | Optional[PageSize] | No | | -**exclude_rid** | Optional[StrictBool] | No | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LoadObjectSetRequestV2Dict.md b/docs/v1/models/LoadObjectSetRequestV2Dict.md deleted file mode 100644 index 8128f84c..00000000 --- a/docs/v1/models/LoadObjectSetRequestV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# LoadObjectSetRequestV2Dict - -Represents the API POST body when loading an `ObjectSet`. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | -**orderBy** | NotRequired[SearchOrderByV2Dict] | No | | -**select** | List[SelectedPropertyApiName] | Yes | | -**pageToken** | NotRequired[PageToken] | No | | -**pageSize** | NotRequired[PageSize] | No | | -**excludeRid** | NotRequired[StrictBool] | No | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LoadObjectSetResponseV2.md b/docs/v1/models/LoadObjectSetResponseV2.md deleted file mode 100644 index 581ed7b7..00000000 --- a/docs/v1/models/LoadObjectSetResponseV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# LoadObjectSetResponseV2 - -Represents the API response when loading an `ObjectSet`. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | The list of objects in the current Page. | -**next_page_token** | Optional[PageToken] | No | | -**total_count** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LoadObjectSetResponseV2Dict.md b/docs/v1/models/LoadObjectSetResponseV2Dict.md deleted file mode 100644 index 25cdfd0b..00000000 --- a/docs/v1/models/LoadObjectSetResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LoadObjectSetResponseV2Dict - -Represents the API response when loading an `ObjectSet`. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | The list of objects in the current Page. | -**nextPageToken** | NotRequired[PageToken] | No | | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LocalFilePath.md b/docs/v1/models/LocalFilePath.md deleted file mode 100644 index 2a09ffe5..00000000 --- a/docs/v1/models/LocalFilePath.md +++ /dev/null @@ -1,10 +0,0 @@ -# LocalFilePath - -LocalFilePath - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LocalFilePathDict.md b/docs/v1/models/LocalFilePathDict.md deleted file mode 100644 index 43ae6a92..00000000 --- a/docs/v1/models/LocalFilePathDict.md +++ /dev/null @@ -1,10 +0,0 @@ -# LocalFilePathDict - -LocalFilePath - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LogicRule.md b/docs/v1/models/LogicRule.md deleted file mode 100644 index da47767a..00000000 --- a/docs/v1/models/LogicRule.md +++ /dev/null @@ -1,19 +0,0 @@ -# LogicRule - -LogicRule - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[CreateObjectRule](CreateObjectRule.md) | createObject -[ModifyObjectRule](ModifyObjectRule.md) | modifyObject -[DeleteObjectRule](DeleteObjectRule.md) | deleteObject -[CreateLinkRule](CreateLinkRule.md) | createLink -[DeleteLinkRule](DeleteLinkRule.md) | deleteLink - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LogicRuleDict.md b/docs/v1/models/LogicRuleDict.md deleted file mode 100644 index 40a1663d..00000000 --- a/docs/v1/models/LogicRuleDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# LogicRuleDict - -LogicRule - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[CreateObjectRuleDict](CreateObjectRuleDict.md) | createObject -[ModifyObjectRuleDict](ModifyObjectRuleDict.md) | modifyObject -[DeleteObjectRuleDict](DeleteObjectRuleDict.md) | deleteObject -[CreateLinkRuleDict](CreateLinkRuleDict.md) | createLink -[DeleteLinkRuleDict](DeleteLinkRuleDict.md) | deleteLink - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LongType.md b/docs/v1/models/LongType.md deleted file mode 100644 index 8c120f43..00000000 --- a/docs/v1/models/LongType.md +++ /dev/null @@ -1,11 +0,0 @@ -# LongType - -LongType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["long"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LongTypeDict.md b/docs/v1/models/LongTypeDict.md deleted file mode 100644 index 96536485..00000000 --- a/docs/v1/models/LongTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# LongTypeDict - -LongType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["long"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LtQuery.md b/docs/v1/models/LtQuery.md deleted file mode 100644 index 9e0293ee..00000000 --- a/docs/v1/models/LtQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# LtQuery - -Returns objects where the specified field is less than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LtQueryDict.md b/docs/v1/models/LtQueryDict.md deleted file mode 100644 index 376197b8..00000000 --- a/docs/v1/models/LtQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LtQueryDict - -Returns objects where the specified field is less than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LtQueryV2.md b/docs/v1/models/LtQueryV2.md deleted file mode 100644 index 352b60cb..00000000 --- a/docs/v1/models/LtQueryV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# LtQueryV2 - -Returns objects where the specified field is less than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LtQueryV2Dict.md b/docs/v1/models/LtQueryV2Dict.md deleted file mode 100644 index 653b4b05..00000000 --- a/docs/v1/models/LtQueryV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LtQueryV2Dict - -Returns objects where the specified field is less than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LteQuery.md b/docs/v1/models/LteQuery.md deleted file mode 100644 index 53bc2153..00000000 --- a/docs/v1/models/LteQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# LteQuery - -Returns objects where the specified field is less than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LteQueryDict.md b/docs/v1/models/LteQueryDict.md deleted file mode 100644 index 0801bb4d..00000000 --- a/docs/v1/models/LteQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LteQueryDict - -Returns objects where the specified field is less than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LteQueryV2.md b/docs/v1/models/LteQueryV2.md deleted file mode 100644 index 78d2a09a..00000000 --- a/docs/v1/models/LteQueryV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# LteQueryV2 - -Returns objects where the specified field is less than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/LteQueryV2Dict.md b/docs/v1/models/LteQueryV2Dict.md deleted file mode 100644 index 5a58ceb4..00000000 --- a/docs/v1/models/LteQueryV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LteQueryV2Dict - -Returns objects where the specified field is less than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MarkingType.md b/docs/v1/models/MarkingType.md deleted file mode 100644 index 2fd8e464..00000000 --- a/docs/v1/models/MarkingType.md +++ /dev/null @@ -1,11 +0,0 @@ -# MarkingType - -MarkingType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["marking"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MarkingTypeDict.md b/docs/v1/models/MarkingTypeDict.md deleted file mode 100644 index 628a4733..00000000 --- a/docs/v1/models/MarkingTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# MarkingTypeDict - -MarkingType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["marking"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MaxAggregation.md b/docs/v1/models/MaxAggregation.md deleted file mode 100644 index fb2ceeec..00000000 --- a/docs/v1/models/MaxAggregation.md +++ /dev/null @@ -1,13 +0,0 @@ -# MaxAggregation - -Computes the maximum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**type** | Literal["max"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MaxAggregationDict.md b/docs/v1/models/MaxAggregationDict.md deleted file mode 100644 index 2029d31f..00000000 --- a/docs/v1/models/MaxAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MaxAggregationDict - -Computes the maximum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["max"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MaxAggregationV2.md b/docs/v1/models/MaxAggregationV2.md deleted file mode 100644 index 9cd0b73b..00000000 --- a/docs/v1/models/MaxAggregationV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# MaxAggregationV2 - -Computes the maximum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["max"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MaxAggregationV2Dict.md b/docs/v1/models/MaxAggregationV2Dict.md deleted file mode 100644 index b36151c2..00000000 --- a/docs/v1/models/MaxAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# MaxAggregationV2Dict - -Computes the maximum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["max"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MediaType.md b/docs/v1/models/MediaType.md deleted file mode 100644 index fca8a4c6..00000000 --- a/docs/v1/models/MediaType.md +++ /dev/null @@ -1,13 +0,0 @@ -# MediaType - -The [media type](https://www.iana.org/assignments/media-types/media-types.xhtml) of the file or attachment. -Examples: `application/json`, `application/pdf`, `application/octet-stream`, `image/jpeg` - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MinAggregation.md b/docs/v1/models/MinAggregation.md deleted file mode 100644 index a3cec24e..00000000 --- a/docs/v1/models/MinAggregation.md +++ /dev/null @@ -1,13 +0,0 @@ -# MinAggregation - -Computes the minimum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**type** | Literal["min"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MinAggregationDict.md b/docs/v1/models/MinAggregationDict.md deleted file mode 100644 index 10a3a5cd..00000000 --- a/docs/v1/models/MinAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MinAggregationDict - -Computes the minimum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["min"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MinAggregationV2.md b/docs/v1/models/MinAggregationV2.md deleted file mode 100644 index 62df5f30..00000000 --- a/docs/v1/models/MinAggregationV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# MinAggregationV2 - -Computes the minimum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["min"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MinAggregationV2Dict.md b/docs/v1/models/MinAggregationV2Dict.md deleted file mode 100644 index 9309c7e8..00000000 --- a/docs/v1/models/MinAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# MinAggregationV2Dict - -Computes the minimum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["min"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ModifyObject.md b/docs/v1/models/ModifyObject.md deleted file mode 100644 index 513a6ce9..00000000 --- a/docs/v1/models/ModifyObject.md +++ /dev/null @@ -1,13 +0,0 @@ -# ModifyObject - -ModifyObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primary_key** | PropertyValue | Yes | | -**object_type** | ObjectTypeApiName | Yes | | -**type** | Literal["modifyObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ModifyObjectDict.md b/docs/v1/models/ModifyObjectDict.md deleted file mode 100644 index 712f58d5..00000000 --- a/docs/v1/models/ModifyObjectDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ModifyObjectDict - -ModifyObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primaryKey** | PropertyValue | Yes | | -**objectType** | ObjectTypeApiName | Yes | | -**type** | Literal["modifyObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ModifyObjectRule.md b/docs/v1/models/ModifyObjectRule.md deleted file mode 100644 index a0f45a51..00000000 --- a/docs/v1/models/ModifyObjectRule.md +++ /dev/null @@ -1,12 +0,0 @@ -# ModifyObjectRule - -ModifyObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_type_api_name** | ObjectTypeApiName | Yes | | -**type** | Literal["modifyObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ModifyObjectRuleDict.md b/docs/v1/models/ModifyObjectRuleDict.md deleted file mode 100644 index 811e2a70..00000000 --- a/docs/v1/models/ModifyObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ModifyObjectRuleDict - -ModifyObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["modifyObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MultiLineString.md b/docs/v1/models/MultiLineString.md deleted file mode 100644 index d4437cca..00000000 --- a/docs/v1/models/MultiLineString.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiLineString - -MultiLineString - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[LineStringCoordinates] | Yes | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["MultiLineString"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MultiLineStringDict.md b/docs/v1/models/MultiLineStringDict.md deleted file mode 100644 index 31be24ec..00000000 --- a/docs/v1/models/MultiLineStringDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiLineStringDict - -MultiLineString - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[LineStringCoordinates] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["MultiLineString"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MultiPoint.md b/docs/v1/models/MultiPoint.md deleted file mode 100644 index 29b5e4fa..00000000 --- a/docs/v1/models/MultiPoint.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiPoint - -MultiPoint - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[Position] | Yes | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["MultiPoint"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MultiPointDict.md b/docs/v1/models/MultiPointDict.md deleted file mode 100644 index 5d390684..00000000 --- a/docs/v1/models/MultiPointDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiPointDict - -MultiPoint - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[Position] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["MultiPoint"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MultiPolygon.md b/docs/v1/models/MultiPolygon.md deleted file mode 100644 index 99e5fa6f..00000000 --- a/docs/v1/models/MultiPolygon.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiPolygon - -MultiPolygon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[List[LinearRing]] | Yes | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["MultiPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/MultiPolygonDict.md b/docs/v1/models/MultiPolygonDict.md deleted file mode 100644 index d4a020e4..00000000 --- a/docs/v1/models/MultiPolygonDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiPolygonDict - -MultiPolygon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[List[LinearRing]] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["MultiPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/NestedQueryAggregation.md b/docs/v1/models/NestedQueryAggregation.md deleted file mode 100644 index fdda0bac..00000000 --- a/docs/v1/models/NestedQueryAggregation.md +++ /dev/null @@ -1,12 +0,0 @@ -# NestedQueryAggregation - -NestedQueryAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key** | Any | Yes | | -**groups** | List[QueryAggregation] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/NestedQueryAggregationDict.md b/docs/v1/models/NestedQueryAggregationDict.md deleted file mode 100644 index 2d2beb23..00000000 --- a/docs/v1/models/NestedQueryAggregationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# NestedQueryAggregationDict - -NestedQueryAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key** | Any | Yes | | -**groups** | List[QueryAggregationDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/NotQuery.md b/docs/v1/models/NotQuery.md deleted file mode 100644 index 8314170f..00000000 --- a/docs/v1/models/NotQuery.md +++ /dev/null @@ -1,12 +0,0 @@ -# NotQuery - -Returns objects where the query is not satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | SearchJsonQuery | Yes | | -**type** | Literal["not"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/NotQueryDict.md b/docs/v1/models/NotQueryDict.md deleted file mode 100644 index 5ada5639..00000000 --- a/docs/v1/models/NotQueryDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# NotQueryDict - -Returns objects where the query is not satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | SearchJsonQueryDict | Yes | | -**type** | Literal["not"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/NotQueryV2.md b/docs/v1/models/NotQueryV2.md deleted file mode 100644 index 8babbaad..00000000 --- a/docs/v1/models/NotQueryV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# NotQueryV2 - -Returns objects where the query is not satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | SearchJsonQueryV2 | Yes | | -**type** | Literal["not"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/NotQueryV2Dict.md b/docs/v1/models/NotQueryV2Dict.md deleted file mode 100644 index 6f52a9c7..00000000 --- a/docs/v1/models/NotQueryV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# NotQueryV2Dict - -Returns objects where the query is not satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | SearchJsonQueryV2Dict | Yes | | -**type** | Literal["not"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/NullType.md b/docs/v1/models/NullType.md deleted file mode 100644 index e608166f..00000000 --- a/docs/v1/models/NullType.md +++ /dev/null @@ -1,11 +0,0 @@ -# NullType - -NullType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["null"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/NullTypeDict.md b/docs/v1/models/NullTypeDict.md deleted file mode 100644 index 7ff01e4a..00000000 --- a/docs/v1/models/NullTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# NullTypeDict - -NullType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["null"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectEdit.md b/docs/v1/models/ObjectEdit.md deleted file mode 100644 index bcf329c7..00000000 --- a/docs/v1/models/ObjectEdit.md +++ /dev/null @@ -1,17 +0,0 @@ -# ObjectEdit - -ObjectEdit - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AddObject](AddObject.md) | addObject -[ModifyObject](ModifyObject.md) | modifyObject -[AddLink](AddLink.md) | addLink - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectEditDict.md b/docs/v1/models/ObjectEditDict.md deleted file mode 100644 index e79d66f0..00000000 --- a/docs/v1/models/ObjectEditDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ObjectEditDict - -ObjectEdit - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AddObjectDict](AddObjectDict.md) | addObject -[ModifyObjectDict](ModifyObjectDict.md) | modifyObject -[AddLinkDict](AddLinkDict.md) | addLink - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectEdits.md b/docs/v1/models/ObjectEdits.md deleted file mode 100644 index 51ca6fb6..00000000 --- a/docs/v1/models/ObjectEdits.md +++ /dev/null @@ -1,17 +0,0 @@ -# ObjectEdits - -ObjectEdits - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**edits** | List[ObjectEdit] | Yes | | -**added_object_count** | StrictInt | Yes | | -**modified_objects_count** | StrictInt | Yes | | -**deleted_objects_count** | StrictInt | Yes | | -**added_links_count** | StrictInt | Yes | | -**deleted_links_count** | StrictInt | Yes | | -**type** | Literal["edits"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectEditsDict.md b/docs/v1/models/ObjectEditsDict.md deleted file mode 100644 index ec49015b..00000000 --- a/docs/v1/models/ObjectEditsDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ObjectEditsDict - -ObjectEdits - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**edits** | List[ObjectEditDict] | Yes | | -**addedObjectCount** | StrictInt | Yes | | -**modifiedObjectsCount** | StrictInt | Yes | | -**deletedObjectsCount** | StrictInt | Yes | | -**addedLinksCount** | StrictInt | Yes | | -**deletedLinksCount** | StrictInt | Yes | | -**type** | Literal["edits"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectPrimaryKey.md b/docs/v1/models/ObjectPrimaryKey.md deleted file mode 100644 index 80b495f3..00000000 --- a/docs/v1/models/ObjectPrimaryKey.md +++ /dev/null @@ -1,11 +0,0 @@ -# ObjectPrimaryKey - -ObjectPrimaryKey - -## Type -```python -Dict[PropertyApiName, PropertyValue] -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectPropertyType.md b/docs/v1/models/ObjectPropertyType.md deleted file mode 100644 index 0e0cd6df..00000000 --- a/docs/v1/models/ObjectPropertyType.md +++ /dev/null @@ -1,32 +0,0 @@ -# ObjectPropertyType - -A union of all the types supported by Ontology Object properties. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[OntologyObjectArrayType](OntologyObjectArrayType.md) | array -[AttachmentType](AttachmentType.md) | attachment -[BooleanType](BooleanType.md) | boolean -[ByteType](ByteType.md) | byte -[DateType](DateType.md) | date -[DecimalType](DecimalType.md) | decimal -[DoubleType](DoubleType.md) | double -[FloatType](FloatType.md) | float -[GeoPointType](GeoPointType.md) | geopoint -[GeoShapeType](GeoShapeType.md) | geoshape -[IntegerType](IntegerType.md) | integer -[LongType](LongType.md) | long -[MarkingType](MarkingType.md) | marking -[ShortType](ShortType.md) | short -[StringType](StringType.md) | string -[TimestampType](TimestampType.md) | timestamp -[TimeseriesType](TimeseriesType.md) | timeseries - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectPropertyTypeDict.md b/docs/v1/models/ObjectPropertyTypeDict.md deleted file mode 100644 index 14b5d12c..00000000 --- a/docs/v1/models/ObjectPropertyTypeDict.md +++ /dev/null @@ -1,32 +0,0 @@ -# ObjectPropertyTypeDict - -A union of all the types supported by Ontology Object properties. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[OntologyObjectArrayTypeDict](OntologyObjectArrayTypeDict.md) | array -[AttachmentTypeDict](AttachmentTypeDict.md) | attachment -[BooleanTypeDict](BooleanTypeDict.md) | boolean -[ByteTypeDict](ByteTypeDict.md) | byte -[DateTypeDict](DateTypeDict.md) | date -[DecimalTypeDict](DecimalTypeDict.md) | decimal -[DoubleTypeDict](DoubleTypeDict.md) | double -[FloatTypeDict](FloatTypeDict.md) | float -[GeoPointTypeDict](GeoPointTypeDict.md) | geopoint -[GeoShapeTypeDict](GeoShapeTypeDict.md) | geoshape -[IntegerTypeDict](IntegerTypeDict.md) | integer -[LongTypeDict](LongTypeDict.md) | long -[MarkingTypeDict](MarkingTypeDict.md) | marking -[ShortTypeDict](ShortTypeDict.md) | short -[StringTypeDict](StringTypeDict.md) | string -[TimestampTypeDict](TimestampTypeDict.md) | timestamp -[TimeseriesTypeDict](TimeseriesTypeDict.md) | timeseries - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectPropertyValueConstraint.md b/docs/v1/models/ObjectPropertyValueConstraint.md deleted file mode 100644 index 6505b5de..00000000 --- a/docs/v1/models/ObjectPropertyValueConstraint.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectPropertyValueConstraint - -The parameter value must be a property value of an object found within an object set. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["objectPropertyValue"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectPropertyValueConstraintDict.md b/docs/v1/models/ObjectPropertyValueConstraintDict.md deleted file mode 100644 index 1448d661..00000000 --- a/docs/v1/models/ObjectPropertyValueConstraintDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectPropertyValueConstraintDict - -The parameter value must be a property value of an object found within an object set. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["objectPropertyValue"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectQueryResultConstraint.md b/docs/v1/models/ObjectQueryResultConstraint.md deleted file mode 100644 index 0caf6ec8..00000000 --- a/docs/v1/models/ObjectQueryResultConstraint.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectQueryResultConstraint - -The parameter value must be the primary key of an object found within an object set. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["objectQueryResult"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectQueryResultConstraintDict.md b/docs/v1/models/ObjectQueryResultConstraintDict.md deleted file mode 100644 index 23e3c3d2..00000000 --- a/docs/v1/models/ObjectQueryResultConstraintDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectQueryResultConstraintDict - -The parameter value must be the primary key of an object found within an object set. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["objectQueryResult"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectRid.md b/docs/v1/models/ObjectRid.md deleted file mode 100644 index e9ba876f..00000000 --- a/docs/v1/models/ObjectRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectRid - -The unique resource identifier of an object, useful for interacting with other Foundry APIs. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSet.md b/docs/v1/models/ObjectSet.md deleted file mode 100644 index f1884f5c..00000000 --- a/docs/v1/models/ObjectSet.md +++ /dev/null @@ -1,22 +0,0 @@ -# ObjectSet - -Represents the definition of an `ObjectSet` in the `Ontology`. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectSetBaseType](ObjectSetBaseType.md) | base -[ObjectSetStaticType](ObjectSetStaticType.md) | static -[ObjectSetReferenceType](ObjectSetReferenceType.md) | reference -[ObjectSetFilterType](ObjectSetFilterType.md) | filter -[ObjectSetUnionType](ObjectSetUnionType.md) | union -[ObjectSetIntersectionType](ObjectSetIntersectionType.md) | intersect -[ObjectSetSubtractType](ObjectSetSubtractType.md) | subtract -[ObjectSetSearchAroundType](ObjectSetSearchAroundType.md) | searchAround - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetBaseType.md b/docs/v1/models/ObjectSetBaseType.md deleted file mode 100644 index 372982f7..00000000 --- a/docs/v1/models/ObjectSetBaseType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetBaseType - -ObjectSetBaseType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_type** | StrictStr | Yes | | -**type** | Literal["base"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetBaseTypeDict.md b/docs/v1/models/ObjectSetBaseTypeDict.md deleted file mode 100644 index 9b3b9c2a..00000000 --- a/docs/v1/models/ObjectSetBaseTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetBaseTypeDict - -ObjectSetBaseType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectType** | StrictStr | Yes | | -**type** | Literal["base"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetDict.md b/docs/v1/models/ObjectSetDict.md deleted file mode 100644 index 512f0a99..00000000 --- a/docs/v1/models/ObjectSetDict.md +++ /dev/null @@ -1,22 +0,0 @@ -# ObjectSetDict - -Represents the definition of an `ObjectSet` in the `Ontology`. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectSetBaseTypeDict](ObjectSetBaseTypeDict.md) | base -[ObjectSetStaticTypeDict](ObjectSetStaticTypeDict.md) | static -[ObjectSetReferenceTypeDict](ObjectSetReferenceTypeDict.md) | reference -[ObjectSetFilterTypeDict](ObjectSetFilterTypeDict.md) | filter -[ObjectSetUnionTypeDict](ObjectSetUnionTypeDict.md) | union -[ObjectSetIntersectionTypeDict](ObjectSetIntersectionTypeDict.md) | intersect -[ObjectSetSubtractTypeDict](ObjectSetSubtractTypeDict.md) | subtract -[ObjectSetSearchAroundTypeDict](ObjectSetSearchAroundTypeDict.md) | searchAround - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetFilterType.md b/docs/v1/models/ObjectSetFilterType.md deleted file mode 100644 index 932f91ea..00000000 --- a/docs/v1/models/ObjectSetFilterType.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetFilterType - -ObjectSetFilterType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_set** | ObjectSet | Yes | | -**where** | SearchJsonQueryV2 | Yes | | -**type** | Literal["filter"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetFilterTypeDict.md b/docs/v1/models/ObjectSetFilterTypeDict.md deleted file mode 100644 index b6c06204..00000000 --- a/docs/v1/models/ObjectSetFilterTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetFilterTypeDict - -ObjectSetFilterType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | -**where** | SearchJsonQueryV2Dict | Yes | | -**type** | Literal["filter"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetIntersectionType.md b/docs/v1/models/ObjectSetIntersectionType.md deleted file mode 100644 index 14967c08..00000000 --- a/docs/v1/models/ObjectSetIntersectionType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetIntersectionType - -ObjectSetIntersectionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_sets** | List[ObjectSet] | Yes | | -**type** | Literal["intersect"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetIntersectionTypeDict.md b/docs/v1/models/ObjectSetIntersectionTypeDict.md deleted file mode 100644 index 2e7767f7..00000000 --- a/docs/v1/models/ObjectSetIntersectionTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetIntersectionTypeDict - -ObjectSetIntersectionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSets** | List[ObjectSetDict] | Yes | | -**type** | Literal["intersect"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetReferenceType.md b/docs/v1/models/ObjectSetReferenceType.md deleted file mode 100644 index c0c3a4de..00000000 --- a/docs/v1/models/ObjectSetReferenceType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetReferenceType - -ObjectSetReferenceType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**reference** | RID | Yes | | -**type** | Literal["reference"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetReferenceTypeDict.md b/docs/v1/models/ObjectSetReferenceTypeDict.md deleted file mode 100644 index d1d713c8..00000000 --- a/docs/v1/models/ObjectSetReferenceTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetReferenceTypeDict - -ObjectSetReferenceType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**reference** | RID | Yes | | -**type** | Literal["reference"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetRid.md b/docs/v1/models/ObjectSetRid.md deleted file mode 100644 index d9a09a86..00000000 --- a/docs/v1/models/ObjectSetRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ObjectSetRid - -ObjectSetRid - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetSearchAroundType.md b/docs/v1/models/ObjectSetSearchAroundType.md deleted file mode 100644 index a6dca085..00000000 --- a/docs/v1/models/ObjectSetSearchAroundType.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetSearchAroundType - -ObjectSetSearchAroundType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_set** | ObjectSet | Yes | | -**link** | LinkTypeApiName | Yes | | -**type** | Literal["searchAround"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetSearchAroundTypeDict.md b/docs/v1/models/ObjectSetSearchAroundTypeDict.md deleted file mode 100644 index a72d1583..00000000 --- a/docs/v1/models/ObjectSetSearchAroundTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetSearchAroundTypeDict - -ObjectSetSearchAroundType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | -**link** | LinkTypeApiName | Yes | | -**type** | Literal["searchAround"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetStaticType.md b/docs/v1/models/ObjectSetStaticType.md deleted file mode 100644 index 6522c3ea..00000000 --- a/docs/v1/models/ObjectSetStaticType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetStaticType - -ObjectSetStaticType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objects** | List[ObjectRid] | Yes | | -**type** | Literal["static"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetStaticTypeDict.md b/docs/v1/models/ObjectSetStaticTypeDict.md deleted file mode 100644 index 22a02f60..00000000 --- a/docs/v1/models/ObjectSetStaticTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetStaticTypeDict - -ObjectSetStaticType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objects** | List[ObjectRid] | Yes | | -**type** | Literal["static"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetStreamSubscribeRequest.md b/docs/v1/models/ObjectSetStreamSubscribeRequest.md deleted file mode 100644 index 8db1d5c5..00000000 --- a/docs/v1/models/ObjectSetStreamSubscribeRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetStreamSubscribeRequest - -ObjectSetStreamSubscribeRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_set** | ObjectSet | Yes | | -**property_set** | List[SelectedPropertyApiName] | Yes | | -**reference_set** | List[SelectedPropertyApiName] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetStreamSubscribeRequestDict.md b/docs/v1/models/ObjectSetStreamSubscribeRequestDict.md deleted file mode 100644 index c7f9f391..00000000 --- a/docs/v1/models/ObjectSetStreamSubscribeRequestDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetStreamSubscribeRequestDict - -ObjectSetStreamSubscribeRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | -**propertySet** | List[SelectedPropertyApiName] | Yes | | -**referenceSet** | List[SelectedPropertyApiName] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetStreamSubscribeRequests.md b/docs/v1/models/ObjectSetStreamSubscribeRequests.md deleted file mode 100644 index 278c14d7..00000000 --- a/docs/v1/models/ObjectSetStreamSubscribeRequests.md +++ /dev/null @@ -1,14 +0,0 @@ -# ObjectSetStreamSubscribeRequests - -The list of object sets that should be subscribed to. A client can stop subscribing to an object set -by removing the request from subsequent ObjectSetStreamSubscribeRequests. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | RequestId | Yes | | -**requests** | List[ObjectSetStreamSubscribeRequest] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetStreamSubscribeRequestsDict.md b/docs/v1/models/ObjectSetStreamSubscribeRequestsDict.md deleted file mode 100644 index cc7cf961..00000000 --- a/docs/v1/models/ObjectSetStreamSubscribeRequestsDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ObjectSetStreamSubscribeRequestsDict - -The list of object sets that should be subscribed to. A client can stop subscribing to an object set -by removing the request from subsequent ObjectSetStreamSubscribeRequests. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | RequestId | Yes | | -**requests** | List[ObjectSetStreamSubscribeRequestDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetSubscribeResponse.md b/docs/v1/models/ObjectSetSubscribeResponse.md deleted file mode 100644 index 6d4978ac..00000000 --- a/docs/v1/models/ObjectSetSubscribeResponse.md +++ /dev/null @@ -1,17 +0,0 @@ -# ObjectSetSubscribeResponse - -ObjectSetSubscribeResponse - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[SubscriptionSuccess](SubscriptionSuccess.md) | success -[SubscriptionError](SubscriptionError.md) | error -[QosError](QosError.md) | qos - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetSubscribeResponseDict.md b/docs/v1/models/ObjectSetSubscribeResponseDict.md deleted file mode 100644 index e0c5a935..00000000 --- a/docs/v1/models/ObjectSetSubscribeResponseDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ObjectSetSubscribeResponseDict - -ObjectSetSubscribeResponse - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[SubscriptionSuccessDict](SubscriptionSuccessDict.md) | success -[SubscriptionErrorDict](SubscriptionErrorDict.md) | error -[QosErrorDict](QosErrorDict.md) | qos - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetSubscribeResponses.md b/docs/v1/models/ObjectSetSubscribeResponses.md deleted file mode 100644 index cb854c1d..00000000 --- a/docs/v1/models/ObjectSetSubscribeResponses.md +++ /dev/null @@ -1,14 +0,0 @@ -# ObjectSetSubscribeResponses - -Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**responses** | List[ObjectSetSubscribeResponse] | Yes | | -**id** | RequestId | Yes | | -**type** | Literal["subscribeResponses"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetSubscribeResponsesDict.md b/docs/v1/models/ObjectSetSubscribeResponsesDict.md deleted file mode 100644 index 7e462537..00000000 --- a/docs/v1/models/ObjectSetSubscribeResponsesDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ObjectSetSubscribeResponsesDict - -Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**responses** | List[ObjectSetSubscribeResponseDict] | Yes | | -**id** | RequestId | Yes | | -**type** | Literal["subscribeResponses"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetSubtractType.md b/docs/v1/models/ObjectSetSubtractType.md deleted file mode 100644 index 5d5a9367..00000000 --- a/docs/v1/models/ObjectSetSubtractType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetSubtractType - -ObjectSetSubtractType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_sets** | List[ObjectSet] | Yes | | -**type** | Literal["subtract"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetSubtractTypeDict.md b/docs/v1/models/ObjectSetSubtractTypeDict.md deleted file mode 100644 index 3bc1ee81..00000000 --- a/docs/v1/models/ObjectSetSubtractTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetSubtractTypeDict - -ObjectSetSubtractType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSets** | List[ObjectSetDict] | Yes | | -**type** | Literal["subtract"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetUnionType.md b/docs/v1/models/ObjectSetUnionType.md deleted file mode 100644 index 73627ebc..00000000 --- a/docs/v1/models/ObjectSetUnionType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetUnionType - -ObjectSetUnionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_sets** | List[ObjectSet] | Yes | | -**type** | Literal["union"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetUnionTypeDict.md b/docs/v1/models/ObjectSetUnionTypeDict.md deleted file mode 100644 index 7759a75d..00000000 --- a/docs/v1/models/ObjectSetUnionTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetUnionTypeDict - -ObjectSetUnionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSets** | List[ObjectSetDict] | Yes | | -**type** | Literal["union"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetUpdate.md b/docs/v1/models/ObjectSetUpdate.md deleted file mode 100644 index 97f04971..00000000 --- a/docs/v1/models/ObjectSetUpdate.md +++ /dev/null @@ -1,16 +0,0 @@ -# ObjectSetUpdate - -ObjectSetUpdate - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectUpdate](ObjectUpdate.md) | object -[ReferenceUpdate](ReferenceUpdate.md) | reference - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetUpdateDict.md b/docs/v1/models/ObjectSetUpdateDict.md deleted file mode 100644 index ce3aaa46..00000000 --- a/docs/v1/models/ObjectSetUpdateDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ObjectSetUpdateDict - -ObjectSetUpdate - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectUpdateDict](ObjectUpdateDict.md) | object -[ReferenceUpdateDict](ReferenceUpdateDict.md) | reference - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetUpdates.md b/docs/v1/models/ObjectSetUpdates.md deleted file mode 100644 index 97db58aa..00000000 --- a/docs/v1/models/ObjectSetUpdates.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetUpdates - -ObjectSetUpdates - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**updates** | List[ObjectSetUpdate] | Yes | | -**type** | Literal["objectSetChanged"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectSetUpdatesDict.md b/docs/v1/models/ObjectSetUpdatesDict.md deleted file mode 100644 index 98e3aa55..00000000 --- a/docs/v1/models/ObjectSetUpdatesDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetUpdatesDict - -ObjectSetUpdates - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**updates** | List[ObjectSetUpdateDict] | Yes | | -**type** | Literal["objectSetChanged"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectState.md b/docs/v1/models/ObjectState.md deleted file mode 100644 index 74ee2200..00000000 --- a/docs/v1/models/ObjectState.md +++ /dev/null @@ -1,15 +0,0 @@ -# ObjectState - -Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was -added to the set or the object has updated and was previously in the set. REMOVED indicates that the object -was removed from the set due to the object being deleted or the object no longer meets the object set -definition. - - -| **Value** | -| --------- | -| `"ADDED_OR_UPDATED"` | -| `"REMOVED"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectType.md b/docs/v1/models/ObjectType.md deleted file mode 100644 index 8520cb42..00000000 --- a/docs/v1/models/ObjectType.md +++ /dev/null @@ -1,18 +0,0 @@ -# ObjectType - -Represents an object type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | ObjectTypeApiName | Yes | | -**display_name** | Optional[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**description** | Optional[StrictStr] | No | The description of the object type. | -**visibility** | Optional[ObjectTypeVisibility] | No | | -**primary_key** | List[PropertyApiName] | Yes | The primary key of the object. This is a list of properties that can be used to uniquely identify the object. | -**properties** | Dict[PropertyApiName, Property] | Yes | A map of the properties of the object type. | -**rid** | ObjectTypeRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectTypeApiName.md b/docs/v1/models/ObjectTypeApiName.md deleted file mode 100644 index 5c55d823..00000000 --- a/docs/v1/models/ObjectTypeApiName.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectTypeApiName - -The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the -`List object types` endpoint or check the **Ontology Manager**. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectTypeDict.md b/docs/v1/models/ObjectTypeDict.md deleted file mode 100644 index 20bd6111..00000000 --- a/docs/v1/models/ObjectTypeDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# ObjectTypeDict - -Represents an object type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ObjectTypeApiName | Yes | | -**displayName** | NotRequired[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**description** | NotRequired[StrictStr] | No | The description of the object type. | -**visibility** | NotRequired[ObjectTypeVisibility] | No | | -**primaryKey** | List[PropertyApiName] | Yes | The primary key of the object. This is a list of properties that can be used to uniquely identify the object. | -**properties** | Dict[PropertyApiName, PropertyDict] | Yes | A map of the properties of the object type. | -**rid** | ObjectTypeRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectTypeEdits.md b/docs/v1/models/ObjectTypeEdits.md deleted file mode 100644 index 195a0616..00000000 --- a/docs/v1/models/ObjectTypeEdits.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectTypeEdits - -ObjectTypeEdits - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**edited_object_types** | List[ObjectTypeApiName] | Yes | | -**type** | Literal["largeScaleEdits"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectTypeEditsDict.md b/docs/v1/models/ObjectTypeEditsDict.md deleted file mode 100644 index da308a67..00000000 --- a/docs/v1/models/ObjectTypeEditsDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectTypeEditsDict - -ObjectTypeEdits - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**editedObjectTypes** | List[ObjectTypeApiName] | Yes | | -**type** | Literal["largeScaleEdits"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectTypeFullMetadata.md b/docs/v1/models/ObjectTypeFullMetadata.md deleted file mode 100644 index f7211448..00000000 --- a/docs/v1/models/ObjectTypeFullMetadata.md +++ /dev/null @@ -1,15 +0,0 @@ -# ObjectTypeFullMetadata - -ObjectTypeFullMetadata - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_type** | ObjectTypeV2 | Yes | | -**link_types** | List[LinkTypeSideV2] | Yes | | -**implements_interfaces** | List[InterfaceTypeApiName] | Yes | A list of interfaces that this object type implements. | -**implements_interfaces2** | Dict[InterfaceTypeApiName, ObjectTypeInterfaceImplementation] | Yes | A list of interfaces that this object type implements and how it implements them. | -**shared_property_type_mapping** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | A map from shared property type API name to backing local property API name for the shared property types present on this object type. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectTypeFullMetadataDict.md b/docs/v1/models/ObjectTypeFullMetadataDict.md deleted file mode 100644 index 88b55277..00000000 --- a/docs/v1/models/ObjectTypeFullMetadataDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# ObjectTypeFullMetadataDict - -ObjectTypeFullMetadata - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectType** | ObjectTypeV2Dict | Yes | | -**linkTypes** | List[LinkTypeSideV2Dict] | Yes | | -**implementsInterfaces** | List[InterfaceTypeApiName] | Yes | A list of interfaces that this object type implements. | -**implementsInterfaces2** | Dict[InterfaceTypeApiName, ObjectTypeInterfaceImplementationDict] | Yes | A list of interfaces that this object type implements and how it implements them. | -**sharedPropertyTypeMapping** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | A map from shared property type API name to backing local property API name for the shared property types present on this object type. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectTypeInterfaceImplementation.md b/docs/v1/models/ObjectTypeInterfaceImplementation.md deleted file mode 100644 index 01ef7b47..00000000 --- a/docs/v1/models/ObjectTypeInterfaceImplementation.md +++ /dev/null @@ -1,11 +0,0 @@ -# ObjectTypeInterfaceImplementation - -ObjectTypeInterfaceImplementation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**properties** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectTypeInterfaceImplementationDict.md b/docs/v1/models/ObjectTypeInterfaceImplementationDict.md deleted file mode 100644 index 4bc40836..00000000 --- a/docs/v1/models/ObjectTypeInterfaceImplementationDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ObjectTypeInterfaceImplementationDict - -ObjectTypeInterfaceImplementation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**properties** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectTypeRid.md b/docs/v1/models/ObjectTypeRid.md deleted file mode 100644 index 6622f3a3..00000000 --- a/docs/v1/models/ObjectTypeRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ObjectTypeRid - -The unique resource identifier of an object type, useful for interacting with other Foundry APIs. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectTypeV2.md b/docs/v1/models/ObjectTypeV2.md deleted file mode 100644 index e9a27152..00000000 --- a/docs/v1/models/ObjectTypeV2.md +++ /dev/null @@ -1,21 +0,0 @@ -# ObjectTypeV2 - -Represents an object type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | ObjectTypeApiName | Yes | | -**display_name** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**description** | Optional[StrictStr] | No | The description of the object type. | -**plural_display_name** | StrictStr | Yes | The plural display name of the object type. | -**icon** | Icon | Yes | | -**primary_key** | PropertyApiName | Yes | | -**properties** | Dict[PropertyApiName, PropertyV2] | Yes | A map of the properties of the object type. | -**rid** | ObjectTypeRid | Yes | | -**title_property** | PropertyApiName | Yes | | -**visibility** | Optional[ObjectTypeVisibility] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectTypeV2Dict.md b/docs/v1/models/ObjectTypeV2Dict.md deleted file mode 100644 index cb5bf47c..00000000 --- a/docs/v1/models/ObjectTypeV2Dict.md +++ /dev/null @@ -1,21 +0,0 @@ -# ObjectTypeV2Dict - -Represents an object type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ObjectTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**description** | NotRequired[StrictStr] | No | The description of the object type. | -**pluralDisplayName** | StrictStr | Yes | The plural display name of the object type. | -**icon** | IconDict | Yes | | -**primaryKey** | PropertyApiName | Yes | | -**properties** | Dict[PropertyApiName, PropertyV2Dict] | Yes | A map of the properties of the object type. | -**rid** | ObjectTypeRid | Yes | | -**titleProperty** | PropertyApiName | Yes | | -**visibility** | NotRequired[ObjectTypeVisibility] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectTypeVisibility.md b/docs/v1/models/ObjectTypeVisibility.md deleted file mode 100644 index 6b7c9b22..00000000 --- a/docs/v1/models/ObjectTypeVisibility.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectTypeVisibility - -The suggested visibility of the object type. - -| **Value** | -| --------- | -| `"NORMAL"` | -| `"PROMINENT"` | -| `"HIDDEN"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectUpdate.md b/docs/v1/models/ObjectUpdate.md deleted file mode 100644 index a6403550..00000000 --- a/docs/v1/models/ObjectUpdate.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectUpdate - -ObjectUpdate - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object** | OntologyObjectV2 | Yes | | -**state** | ObjectState | Yes | | -**type** | Literal["object"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ObjectUpdateDict.md b/docs/v1/models/ObjectUpdateDict.md deleted file mode 100644 index 7e949c3d..00000000 --- a/docs/v1/models/ObjectUpdateDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectUpdateDict - -ObjectUpdate - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object** | OntologyObjectV2 | Yes | | -**state** | ObjectState | Yes | | -**type** | Literal["object"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OneOfConstraint.md b/docs/v1/models/OneOfConstraint.md deleted file mode 100644 index 9d04df05..00000000 --- a/docs/v1/models/OneOfConstraint.md +++ /dev/null @@ -1,14 +0,0 @@ -# OneOfConstraint - -The parameter has a manually predefined set of options. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**options** | List[ParameterOption] | Yes | | -**other_values_allowed** | StrictBool | Yes | A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**. | -**type** | Literal["oneOf"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OneOfConstraintDict.md b/docs/v1/models/OneOfConstraintDict.md deleted file mode 100644 index a562b6fe..00000000 --- a/docs/v1/models/OneOfConstraintDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# OneOfConstraintDict - -The parameter has a manually predefined set of options. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**options** | List[ParameterOptionDict] | Yes | | -**otherValuesAllowed** | StrictBool | Yes | A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**. | -**type** | Literal["oneOf"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Ontology.md b/docs/v1/models/Ontology.md deleted file mode 100644 index 4ac77fdb..00000000 --- a/docs/v1/models/Ontology.md +++ /dev/null @@ -1,14 +0,0 @@ -# Ontology - -Metadata about an Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | OntologyApiName | Yes | | -**display_name** | DisplayName | Yes | | -**description** | StrictStr | Yes | | -**rid** | OntologyRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyApiName.md b/docs/v1/models/OntologyApiName.md deleted file mode 100644 index dbebf171..00000000 --- a/docs/v1/models/OntologyApiName.md +++ /dev/null @@ -1,11 +0,0 @@ -# OntologyApiName - -OntologyApiName - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyArrayType.md b/docs/v1/models/OntologyArrayType.md deleted file mode 100644 index a6e7425a..00000000 --- a/docs/v1/models/OntologyArrayType.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyArrayType - -OntologyArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**item_type** | OntologyDataType | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyArrayTypeDict.md b/docs/v1/models/OntologyArrayTypeDict.md deleted file mode 100644 index 15b87407..00000000 --- a/docs/v1/models/OntologyArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyArrayTypeDict - -OntologyArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**itemType** | OntologyDataTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyDataType.md b/docs/v1/models/OntologyDataType.md deleted file mode 100644 index 67da1951..00000000 --- a/docs/v1/models/OntologyDataType.md +++ /dev/null @@ -1,36 +0,0 @@ -# OntologyDataType - -A union of all the primitive types used by Palantir's Ontology-based products. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AnyType](AnyType.md) | any -[BinaryType](BinaryType.md) | binary -[BooleanType](BooleanType.md) | boolean -[ByteType](ByteType.md) | byte -[DateType](DateType.md) | date -[DecimalType](DecimalType.md) | decimal -[DoubleType](DoubleType.md) | double -[FloatType](FloatType.md) | float -[IntegerType](IntegerType.md) | integer -[LongType](LongType.md) | long -[MarkingType](MarkingType.md) | marking -[ShortType](ShortType.md) | short -[StringType](StringType.md) | string -[TimestampType](TimestampType.md) | timestamp -[OntologyArrayType](OntologyArrayType.md) | array -[OntologyMapType](OntologyMapType.md) | map -[OntologySetType](OntologySetType.md) | set -[OntologyStructType](OntologyStructType.md) | struct -[OntologyObjectType](OntologyObjectType.md) | object -[OntologyObjectSetType](OntologyObjectSetType.md) | objectSet -[UnsupportedType](UnsupportedType.md) | unsupported - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyDataTypeDict.md b/docs/v1/models/OntologyDataTypeDict.md deleted file mode 100644 index b9e717f0..00000000 --- a/docs/v1/models/OntologyDataTypeDict.md +++ /dev/null @@ -1,36 +0,0 @@ -# OntologyDataTypeDict - -A union of all the primitive types used by Palantir's Ontology-based products. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AnyTypeDict](AnyTypeDict.md) | any -[BinaryTypeDict](BinaryTypeDict.md) | binary -[BooleanTypeDict](BooleanTypeDict.md) | boolean -[ByteTypeDict](ByteTypeDict.md) | byte -[DateTypeDict](DateTypeDict.md) | date -[DecimalTypeDict](DecimalTypeDict.md) | decimal -[DoubleTypeDict](DoubleTypeDict.md) | double -[FloatTypeDict](FloatTypeDict.md) | float -[IntegerTypeDict](IntegerTypeDict.md) | integer -[LongTypeDict](LongTypeDict.md) | long -[MarkingTypeDict](MarkingTypeDict.md) | marking -[ShortTypeDict](ShortTypeDict.md) | short -[StringTypeDict](StringTypeDict.md) | string -[TimestampTypeDict](TimestampTypeDict.md) | timestamp -[OntologyArrayTypeDict](OntologyArrayTypeDict.md) | array -[OntologyMapTypeDict](OntologyMapTypeDict.md) | map -[OntologySetTypeDict](OntologySetTypeDict.md) | set -[OntologyStructTypeDict](OntologyStructTypeDict.md) | struct -[OntologyObjectTypeDict](OntologyObjectTypeDict.md) | object -[OntologyObjectSetTypeDict](OntologyObjectSetTypeDict.md) | objectSet -[UnsupportedTypeDict](UnsupportedTypeDict.md) | unsupported - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyDict.md b/docs/v1/models/OntologyDict.md deleted file mode 100644 index 5d3c27eb..00000000 --- a/docs/v1/models/OntologyDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# OntologyDict - -Metadata about an Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | OntologyApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | StrictStr | Yes | | -**rid** | OntologyRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyFullMetadata.md b/docs/v1/models/OntologyFullMetadata.md deleted file mode 100644 index 1dc273d7..00000000 --- a/docs/v1/models/OntologyFullMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# OntologyFullMetadata - -OntologyFullMetadata - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**ontology** | OntologyV2 | Yes | | -**object_types** | Dict[ObjectTypeApiName, ObjectTypeFullMetadata] | Yes | | -**action_types** | Dict[ActionTypeApiName, ActionTypeV2] | Yes | | -**query_types** | Dict[QueryApiName, QueryTypeV2] | Yes | | -**interface_types** | Dict[InterfaceTypeApiName, InterfaceType] | Yes | | -**shared_property_types** | Dict[SharedPropertyTypeApiName, SharedPropertyType] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyFullMetadataDict.md b/docs/v1/models/OntologyFullMetadataDict.md deleted file mode 100644 index c3cf657e..00000000 --- a/docs/v1/models/OntologyFullMetadataDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# OntologyFullMetadataDict - -OntologyFullMetadata - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**ontology** | OntologyV2Dict | Yes | | -**objectTypes** | Dict[ObjectTypeApiName, ObjectTypeFullMetadataDict] | Yes | | -**actionTypes** | Dict[ActionTypeApiName, ActionTypeV2Dict] | Yes | | -**queryTypes** | Dict[QueryApiName, QueryTypeV2Dict] | Yes | | -**interfaceTypes** | Dict[InterfaceTypeApiName, InterfaceTypeDict] | Yes | | -**sharedPropertyTypes** | Dict[SharedPropertyTypeApiName, SharedPropertyTypeDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyIdentifier.md b/docs/v1/models/OntologyIdentifier.md deleted file mode 100644 index 6a565834..00000000 --- a/docs/v1/models/OntologyIdentifier.md +++ /dev/null @@ -1,11 +0,0 @@ -# OntologyIdentifier - -Either an ontology rid or an ontology api name. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyMapType.md b/docs/v1/models/OntologyMapType.md deleted file mode 100644 index c9d277c4..00000000 --- a/docs/v1/models/OntologyMapType.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyMapType - -OntologyMapType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key_type** | OntologyDataType | Yes | | -**value_type** | OntologyDataType | Yes | | -**type** | Literal["map"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyMapTypeDict.md b/docs/v1/models/OntologyMapTypeDict.md deleted file mode 100644 index 01e2e080..00000000 --- a/docs/v1/models/OntologyMapTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyMapTypeDict - -OntologyMapType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyType** | OntologyDataTypeDict | Yes | | -**valueType** | OntologyDataTypeDict | Yes | | -**type** | Literal["map"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyObject.md b/docs/v1/models/OntologyObject.md deleted file mode 100644 index b05ee28e..00000000 --- a/docs/v1/models/OntologyObject.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyObject - -Represents an object in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**properties** | Dict[PropertyApiName, Optional[PropertyValue]] | Yes | A map of the property values of the object. | -**rid** | ObjectRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyObjectArrayType.md b/docs/v1/models/OntologyObjectArrayType.md deleted file mode 100644 index 2391470c..00000000 --- a/docs/v1/models/OntologyObjectArrayType.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyObjectArrayType - -OntologyObjectArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**sub_type** | ObjectPropertyType | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyObjectArrayTypeDict.md b/docs/v1/models/OntologyObjectArrayTypeDict.md deleted file mode 100644 index 78f4c93c..00000000 --- a/docs/v1/models/OntologyObjectArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyObjectArrayTypeDict - -OntologyObjectArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | ObjectPropertyTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyObjectDict.md b/docs/v1/models/OntologyObjectDict.md deleted file mode 100644 index 5ffe80fb..00000000 --- a/docs/v1/models/OntologyObjectDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyObjectDict - -Represents an object in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**properties** | Dict[PropertyApiName, Optional[PropertyValue]] | Yes | A map of the property values of the object. | -**rid** | ObjectRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyObjectSetType.md b/docs/v1/models/OntologyObjectSetType.md deleted file mode 100644 index edfc4fc7..00000000 --- a/docs/v1/models/OntologyObjectSetType.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyObjectSetType - -OntologyObjectSetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_api_name** | Optional[ObjectTypeApiName] | No | | -**object_type_api_name** | Optional[ObjectTypeApiName] | No | | -**type** | Literal["objectSet"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyObjectSetTypeDict.md b/docs/v1/models/OntologyObjectSetTypeDict.md deleted file mode 100644 index c6f6ff66..00000000 --- a/docs/v1/models/OntologyObjectSetTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyObjectSetTypeDict - -OntologyObjectSetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectApiName** | NotRequired[ObjectTypeApiName] | No | | -**objectTypeApiName** | NotRequired[ObjectTypeApiName] | No | | -**type** | Literal["objectSet"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyObjectType.md b/docs/v1/models/OntologyObjectType.md deleted file mode 100644 index 7dc811a3..00000000 --- a/docs/v1/models/OntologyObjectType.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyObjectType - -OntologyObjectType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_api_name** | ObjectTypeApiName | Yes | | -**object_type_api_name** | ObjectTypeApiName | Yes | | -**type** | Literal["object"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyObjectTypeDict.md b/docs/v1/models/OntologyObjectTypeDict.md deleted file mode 100644 index 7a454e68..00000000 --- a/docs/v1/models/OntologyObjectTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyObjectTypeDict - -OntologyObjectType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectApiName** | ObjectTypeApiName | Yes | | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["object"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyObjectV2.md b/docs/v1/models/OntologyObjectV2.md deleted file mode 100644 index eb153efe..00000000 --- a/docs/v1/models/OntologyObjectV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# OntologyObjectV2 - -Represents an object in the Ontology. - -## Type -```python -Dict[PropertyApiName, PropertyValue] -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyRid.md b/docs/v1/models/OntologyRid.md deleted file mode 100644 index 13ec401b..00000000 --- a/docs/v1/models/OntologyRid.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyRid - -The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the -`List ontologies` endpoint or check the **Ontology Manager**. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologySetType.md b/docs/v1/models/OntologySetType.md deleted file mode 100644 index 3b62c1fd..00000000 --- a/docs/v1/models/OntologySetType.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologySetType - -OntologySetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**item_type** | OntologyDataType | Yes | | -**type** | Literal["set"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologySetTypeDict.md b/docs/v1/models/OntologySetTypeDict.md deleted file mode 100644 index ba0a6584..00000000 --- a/docs/v1/models/OntologySetTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologySetTypeDict - -OntologySetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**itemType** | OntologyDataTypeDict | Yes | | -**type** | Literal["set"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyStructField.md b/docs/v1/models/OntologyStructField.md deleted file mode 100644 index 075eed24..00000000 --- a/docs/v1/models/OntologyStructField.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyStructField - -OntologyStructField - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StructFieldName | Yes | | -**field_type** | OntologyDataType | Yes | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyStructFieldDict.md b/docs/v1/models/OntologyStructFieldDict.md deleted file mode 100644 index 2e59d8d3..00000000 --- a/docs/v1/models/OntologyStructFieldDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyStructFieldDict - -OntologyStructField - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StructFieldName | Yes | | -**fieldType** | OntologyDataTypeDict | Yes | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyStructType.md b/docs/v1/models/OntologyStructType.md deleted file mode 100644 index 93d01c63..00000000 --- a/docs/v1/models/OntologyStructType.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyStructType - -OntologyStructType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[OntologyStructField] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyStructTypeDict.md b/docs/v1/models/OntologyStructTypeDict.md deleted file mode 100644 index 562e1700..00000000 --- a/docs/v1/models/OntologyStructTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyStructTypeDict - -OntologyStructType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[OntologyStructFieldDict] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyV2.md b/docs/v1/models/OntologyV2.md deleted file mode 100644 index b622c1bf..00000000 --- a/docs/v1/models/OntologyV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# OntologyV2 - -Metadata about an Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | OntologyApiName | Yes | | -**display_name** | DisplayName | Yes | | -**description** | StrictStr | Yes | | -**rid** | OntologyRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OntologyV2Dict.md b/docs/v1/models/OntologyV2Dict.md deleted file mode 100644 index 6fccab1f..00000000 --- a/docs/v1/models/OntologyV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# OntologyV2Dict - -Metadata about an Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | OntologyApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | StrictStr | Yes | | -**rid** | OntologyRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OrQuery.md b/docs/v1/models/OrQuery.md deleted file mode 100644 index 22e664ae..00000000 --- a/docs/v1/models/OrQuery.md +++ /dev/null @@ -1,12 +0,0 @@ -# OrQuery - -Returns objects where at least 1 query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQuery] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OrQueryDict.md b/docs/v1/models/OrQueryDict.md deleted file mode 100644 index c3bfd241..00000000 --- a/docs/v1/models/OrQueryDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OrQueryDict - -Returns objects where at least 1 query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryDict] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OrQueryV2.md b/docs/v1/models/OrQueryV2.md deleted file mode 100644 index 9a57a2a7..00000000 --- a/docs/v1/models/OrQueryV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# OrQueryV2 - -Returns objects where at least 1 query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryV2] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OrQueryV2Dict.md b/docs/v1/models/OrQueryV2Dict.md deleted file mode 100644 index 77be641e..00000000 --- a/docs/v1/models/OrQueryV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OrQueryV2Dict - -Returns objects where at least 1 query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryV2Dict] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OrderBy.md b/docs/v1/models/OrderBy.md deleted file mode 100644 index 6c334555..00000000 --- a/docs/v1/models/OrderBy.md +++ /dev/null @@ -1,21 +0,0 @@ -# OrderBy - -A command representing the list of properties to order by. Properties should be delimited by commas and -prefixed by `p` or `properties`. The format expected format is -`orderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...` - -By default, the ordering for a property is ascending, and this can be explicitly specified by appending -`:asc` (for ascending) or `:desc` (for descending). - -Example: use `orderBy=properties.lastName:asc` to order by a single property, -`orderBy=properties.lastName,properties.firstName,properties.age:desc` to order by multiple properties. -You may also use the shorthand `p` instead of `properties` such as `orderBy=p.lastName:asc`. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/OrderByDirection.md b/docs/v1/models/OrderByDirection.md deleted file mode 100644 index 4af3f01b..00000000 --- a/docs/v1/models/OrderByDirection.md +++ /dev/null @@ -1,11 +0,0 @@ -# OrderByDirection - -OrderByDirection - -| **Value** | -| --------- | -| `"ASC"` | -| `"DESC"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PageSize.md b/docs/v1/models/PageSize.md deleted file mode 100644 index 2d6016de..00000000 --- a/docs/v1/models/PageSize.md +++ /dev/null @@ -1,11 +0,0 @@ -# PageSize - -The page size to use for the endpoint. - -## Type -```python -StrictInt -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PageToken.md b/docs/v1/models/PageToken.md deleted file mode 100644 index 636b9458..00000000 --- a/docs/v1/models/PageToken.md +++ /dev/null @@ -1,14 +0,0 @@ -# PageToken - -The page token indicates where to start paging. This should be omitted from the first page's request. -To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response -and populate the next request's `pageToken` field with it. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Parameter.md b/docs/v1/models/Parameter.md deleted file mode 100644 index e9f05268..00000000 --- a/docs/v1/models/Parameter.md +++ /dev/null @@ -1,14 +0,0 @@ -# Parameter - -Details about a parameter of an action or query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | Optional[StrictStr] | No | | -**base_type** | ValueType | Yes | | -**data_type** | Optional[OntologyDataType] | No | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ParameterDict.md b/docs/v1/models/ParameterDict.md deleted file mode 100644 index a36eae55..00000000 --- a/docs/v1/models/ParameterDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ParameterDict - -Details about a parameter of an action or query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[StrictStr] | No | | -**baseType** | ValueType | Yes | | -**dataType** | NotRequired[OntologyDataTypeDict] | No | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ParameterEvaluatedConstraint.md b/docs/v1/models/ParameterEvaluatedConstraint.md deleted file mode 100644 index 30768f6a..00000000 --- a/docs/v1/models/ParameterEvaluatedConstraint.md +++ /dev/null @@ -1,40 +0,0 @@ -# ParameterEvaluatedConstraint - -A constraint that an action parameter value must satisfy in order to be considered valid. -Constraints can be configured on action parameters in the **Ontology Manager**. -Applicable constraints are determined dynamically based on parameter inputs. -Parameter values are evaluated against the final set of constraints. - -The type of the constraint. -| Type | Description | -|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | -| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | -| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | -| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | -| `oneOf` | The parameter has a manually predefined set of options. | -| `range` | The parameter value must be within the defined range. | -| `stringLength` | The parameter value must have a length within the defined range. | -| `stringRegexMatch` | The parameter value must match a predefined regular expression. | -| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ArraySizeConstraint](ArraySizeConstraint.md) | arraySize -[GroupMemberConstraint](GroupMemberConstraint.md) | groupMember -[ObjectPropertyValueConstraint](ObjectPropertyValueConstraint.md) | objectPropertyValue -[ObjectQueryResultConstraint](ObjectQueryResultConstraint.md) | objectQueryResult -[OneOfConstraint](OneOfConstraint.md) | oneOf -[RangeConstraint](RangeConstraint.md) | range -[StringLengthConstraint](StringLengthConstraint.md) | stringLength -[StringRegexMatchConstraint](StringRegexMatchConstraint.md) | stringRegexMatch -[UnevaluableConstraint](UnevaluableConstraint.md) | unevaluable - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ParameterEvaluatedConstraintDict.md b/docs/v1/models/ParameterEvaluatedConstraintDict.md deleted file mode 100644 index 86bbd6ca..00000000 --- a/docs/v1/models/ParameterEvaluatedConstraintDict.md +++ /dev/null @@ -1,40 +0,0 @@ -# ParameterEvaluatedConstraintDict - -A constraint that an action parameter value must satisfy in order to be considered valid. -Constraints can be configured on action parameters in the **Ontology Manager**. -Applicable constraints are determined dynamically based on parameter inputs. -Parameter values are evaluated against the final set of constraints. - -The type of the constraint. -| Type | Description | -|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | -| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | -| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | -| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | -| `oneOf` | The parameter has a manually predefined set of options. | -| `range` | The parameter value must be within the defined range. | -| `stringLength` | The parameter value must have a length within the defined range. | -| `stringRegexMatch` | The parameter value must match a predefined regular expression. | -| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ArraySizeConstraintDict](ArraySizeConstraintDict.md) | arraySize -[GroupMemberConstraintDict](GroupMemberConstraintDict.md) | groupMember -[ObjectPropertyValueConstraintDict](ObjectPropertyValueConstraintDict.md) | objectPropertyValue -[ObjectQueryResultConstraintDict](ObjectQueryResultConstraintDict.md) | objectQueryResult -[OneOfConstraintDict](OneOfConstraintDict.md) | oneOf -[RangeConstraintDict](RangeConstraintDict.md) | range -[StringLengthConstraintDict](StringLengthConstraintDict.md) | stringLength -[StringRegexMatchConstraintDict](StringRegexMatchConstraintDict.md) | stringRegexMatch -[UnevaluableConstraintDict](UnevaluableConstraintDict.md) | unevaluable - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ParameterEvaluationResult.md b/docs/v1/models/ParameterEvaluationResult.md deleted file mode 100644 index 109a7af3..00000000 --- a/docs/v1/models/ParameterEvaluationResult.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterEvaluationResult - -Represents the validity of a parameter against the configured constraints. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**evaluated_constraints** | List[ParameterEvaluatedConstraint] | Yes | | -**required** | StrictBool | Yes | Represents whether the parameter is a required input to the action. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ParameterEvaluationResultDict.md b/docs/v1/models/ParameterEvaluationResultDict.md deleted file mode 100644 index 23dbffc6..00000000 --- a/docs/v1/models/ParameterEvaluationResultDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterEvaluationResultDict - -Represents the validity of a parameter against the configured constraints. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**evaluatedConstraints** | List[ParameterEvaluatedConstraintDict] | Yes | | -**required** | StrictBool | Yes | Represents whether the parameter is a required input to the action. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ParameterId.md b/docs/v1/models/ParameterId.md deleted file mode 100644 index 8711f135..00000000 --- a/docs/v1/models/ParameterId.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterId - -The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied. -Parameters can be viewed and managed in the **Ontology Manager**. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ParameterOption.md b/docs/v1/models/ParameterOption.md deleted file mode 100644 index 49e3004d..00000000 --- a/docs/v1/models/ParameterOption.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterOption - -A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**display_name** | Optional[DisplayName] | No | | -**value** | Optional[Any] | No | An allowed configured value for a parameter within an action. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ParameterOptionDict.md b/docs/v1/models/ParameterOptionDict.md deleted file mode 100644 index b68f94f1..00000000 --- a/docs/v1/models/ParameterOptionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterOptionDict - -A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**displayName** | NotRequired[DisplayName] | No | | -**value** | NotRequired[Any] | No | An allowed configured value for a parameter within an action. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PhraseQuery.md b/docs/v1/models/PhraseQuery.md deleted file mode 100644 index 8859de9a..00000000 --- a/docs/v1/models/PhraseQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# PhraseQuery - -Returns objects where the specified field contains the provided value as a substring. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["phrase"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PhraseQueryDict.md b/docs/v1/models/PhraseQueryDict.md deleted file mode 100644 index c86d2e9c..00000000 --- a/docs/v1/models/PhraseQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PhraseQueryDict - -Returns objects where the specified field contains the provided value as a substring. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["phrase"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Polygon.md b/docs/v1/models/Polygon.md deleted file mode 100644 index 2b4a7fe0..00000000 --- a/docs/v1/models/Polygon.md +++ /dev/null @@ -1,13 +0,0 @@ -# Polygon - -Polygon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[LinearRing] | Yes | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["Polygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PolygonDict.md b/docs/v1/models/PolygonDict.md deleted file mode 100644 index e90e690e..00000000 --- a/docs/v1/models/PolygonDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PolygonDict - -Polygon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[LinearRing] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["Polygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PolygonValue.md b/docs/v1/models/PolygonValue.md deleted file mode 100644 index 79c8d204..00000000 --- a/docs/v1/models/PolygonValue.md +++ /dev/null @@ -1,11 +0,0 @@ -# PolygonValue - -PolygonValue - -## Type -```python -Polygon -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PolygonValueDict.md b/docs/v1/models/PolygonValueDict.md deleted file mode 100644 index c9889d7d..00000000 --- a/docs/v1/models/PolygonValueDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# PolygonValueDict - -PolygonValue - -## Type -```python -PolygonDict -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Position.md b/docs/v1/models/Position.md deleted file mode 100644 index f1335e4e..00000000 --- a/docs/v1/models/Position.md +++ /dev/null @@ -1,25 +0,0 @@ -# Position - -GeoJSon fundamental geometry construct. - -A position is an array of numbers. There MUST be two or more elements. -The first two elements are longitude and latitude, precisely in that order and using decimal numbers. -Altitude or elevation MAY be included as an optional third element. - -Implementations SHOULD NOT extend positions beyond three elements -because the semantics of extra elements are unspecified and ambiguous. -Historically, some implementations have used a fourth element to carry -a linear referencing measure (sometimes denoted as "M") or a numerical -timestamp, but in most situations a parser will not be able to properly -interpret these values. The interpretation and meaning of additional -elements is beyond the scope of this specification, and additional -elements MAY be ignored by parsers. - - -## Type -```python -List[Coordinate] -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PrefixQuery.md b/docs/v1/models/PrefixQuery.md deleted file mode 100644 index 42636a23..00000000 --- a/docs/v1/models/PrefixQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# PrefixQuery - -Returns objects where the specified field starts with the provided value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["prefix"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PrefixQueryDict.md b/docs/v1/models/PrefixQueryDict.md deleted file mode 100644 index b0add0c8..00000000 --- a/docs/v1/models/PrefixQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PrefixQueryDict - -Returns objects where the specified field starts with the provided value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["prefix"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PreviewMode.md b/docs/v1/models/PreviewMode.md deleted file mode 100644 index b43e29c0..00000000 --- a/docs/v1/models/PreviewMode.md +++ /dev/null @@ -1,11 +0,0 @@ -# PreviewMode - -Enables the use of preview functionality. - -## Type -```python -StrictBool -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PrimaryKeyValue.md b/docs/v1/models/PrimaryKeyValue.md deleted file mode 100644 index c689a16d..00000000 --- a/docs/v1/models/PrimaryKeyValue.md +++ /dev/null @@ -1,11 +0,0 @@ -# PrimaryKeyValue - -Represents the primary key value that is used as a unique identifier for an object. - -## Type -```python -Any -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Property.md b/docs/v1/models/Property.md deleted file mode 100644 index fbd6eadf..00000000 --- a/docs/v1/models/Property.md +++ /dev/null @@ -1,13 +0,0 @@ -# Property - -Details about some property of an object. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | Optional[StrictStr] | No | | -**display_name** | Optional[DisplayName] | No | | -**base_type** | ValueType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PropertyApiName.md b/docs/v1/models/PropertyApiName.md deleted file mode 100644 index d00985e2..00000000 --- a/docs/v1/models/PropertyApiName.md +++ /dev/null @@ -1,13 +0,0 @@ -# PropertyApiName - -The name of the property in the API. To find the API name for your property, use the `Get object type` -endpoint or check the **Ontology Manager**. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PropertyDict.md b/docs/v1/models/PropertyDict.md deleted file mode 100644 index ddd09db4..00000000 --- a/docs/v1/models/PropertyDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PropertyDict - -Details about some property of an object. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[StrictStr] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**baseType** | ValueType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PropertyFilter.md b/docs/v1/models/PropertyFilter.md deleted file mode 100644 index 51c8b7b3..00000000 --- a/docs/v1/models/PropertyFilter.md +++ /dev/null @@ -1,36 +0,0 @@ -# PropertyFilter - -Represents a filter used on properties. - -Endpoints that accept this supports optional parameters that have the form: -`properties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString}` to filter the returned objects. -For instance, you may use `properties.firstName.eq=John` to find objects that contain a property called -"firstName" that has the exact value of "John". - -The following are a list of supported property filters: - -- `properties.{propertyApiName}.contains` - supported on arrays and can be used to filter array properties - that have at least one of the provided values. If multiple query parameters are provided, then objects - that have any of the given values for the specified property will be matched. -- `properties.{propertyApiName}.eq` - used to filter objects that have the exact value for the provided - property. If multiple query parameters are provided, then objects that have any of the given values - will be matched. For instance, if the user provides a request by doing - `?properties.firstName.eq=John&properties.firstName.eq=Anna`, then objects that have a firstName property - of either John or Anna will be matched. This filter is supported on all property types except Arrays. -- `properties.{propertyApiName}.neq` - used to filter objects that do not have the provided property values. - Similar to the `eq` filter, if multiple values are provided, then objects that have any of the given values - will be excluded from the result. -- `properties.{propertyApiName}.lt`, `properties.{propertyApiName}.lte`, `properties.{propertyApiName}.gt` - `properties.{propertyApiName}.gte` - represent less than, less than or equal to, greater than, and greater - than or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal. -- `properties.{propertyApiName}.isNull` - used to filter objects where the provided property is (or is not) null. - This filter is supported on all property types. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PropertyId.md b/docs/v1/models/PropertyId.md deleted file mode 100644 index d1a21ce4..00000000 --- a/docs/v1/models/PropertyId.md +++ /dev/null @@ -1,13 +0,0 @@ -# PropertyId - -The immutable ID of a property. Property IDs are only used to identify properties in the **Ontology Manager** -application and assign them API names. In every other case, API names should be used instead of property IDs. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PropertyV2.md b/docs/v1/models/PropertyV2.md deleted file mode 100644 index 3aab442c..00000000 --- a/docs/v1/models/PropertyV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# PropertyV2 - -Details about some property of an object. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | Optional[StrictStr] | No | | -**display_name** | Optional[DisplayName] | No | | -**data_type** | ObjectPropertyType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PropertyV2Dict.md b/docs/v1/models/PropertyV2Dict.md deleted file mode 100644 index 8c275a5f..00000000 --- a/docs/v1/models/PropertyV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PropertyV2Dict - -Details about some property of an object. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[StrictStr] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**dataType** | ObjectPropertyTypeDict | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PropertyValue.md b/docs/v1/models/PropertyValue.md deleted file mode 100644 index 8f8b677b..00000000 --- a/docs/v1/models/PropertyValue.md +++ /dev/null @@ -1,32 +0,0 @@ -# PropertyValue - -Represents the value of a property in the following format. - -| Type | JSON encoding | Example | -|----------- |-------------------------------------------------------|----------------------------------------------------------------------------------------------------| -| Array | array | `["alpha", "bravo", "charlie"]` | -| Attachment | JSON encoded `AttachmentProperty` object | `{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}` | -| Boolean | boolean | `true` | -| Byte | number | `31` | -| Date | ISO 8601 extended local date string | `"2021-05-01"` | -| Decimal | string | `"2.718281828"` | -| Double | number | `3.14159265` | -| Float | number | `3.14159265` | -| GeoPoint | geojson | `{"type":"Point","coordinates":[102.0,0.5]}` | -| GeoShape | geojson | `{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` | -| Integer | number | `238940` | -| Long | string | `"58319870951433"` | -| Short | number | `8739` | -| String | string | `"Call me Ishmael"` | -| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | - -Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings. - - -## Type -```python -Any -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/PropertyValueEscapedString.md b/docs/v1/models/PropertyValueEscapedString.md deleted file mode 100644 index e2cacd12..00000000 --- a/docs/v1/models/PropertyValueEscapedString.md +++ /dev/null @@ -1,11 +0,0 @@ -# PropertyValueEscapedString - -Represents the value of a property in string format. This is used in URL parameters. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QosError.md b/docs/v1/models/QosError.md deleted file mode 100644 index fcc3d8b3..00000000 --- a/docs/v1/models/QosError.md +++ /dev/null @@ -1,12 +0,0 @@ -# QosError - -An error indicating that the subscribe request should be attempted on a different node. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["qos"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QosErrorDict.md b/docs/v1/models/QosErrorDict.md deleted file mode 100644 index 460ffe90..00000000 --- a/docs/v1/models/QosErrorDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QosErrorDict - -An error indicating that the subscribe request should be attempted on a different node. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["qos"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryAggregation.md b/docs/v1/models/QueryAggregation.md deleted file mode 100644 index 76c5028c..00000000 --- a/docs/v1/models/QueryAggregation.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryAggregation - -QueryAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key** | Any | Yes | | -**value** | Any | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryAggregationDict.md b/docs/v1/models/QueryAggregationDict.md deleted file mode 100644 index 78447c21..00000000 --- a/docs/v1/models/QueryAggregationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryAggregationDict - -QueryAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key** | Any | Yes | | -**value** | Any | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryAggregationKeyType.md b/docs/v1/models/QueryAggregationKeyType.md deleted file mode 100644 index 088e0805..00000000 --- a/docs/v1/models/QueryAggregationKeyType.md +++ /dev/null @@ -1,22 +0,0 @@ -# QueryAggregationKeyType - -A union of all the types supported by query aggregation keys. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[BooleanType](BooleanType.md) | boolean -[DateType](DateType.md) | date -[DoubleType](DoubleType.md) | double -[IntegerType](IntegerType.md) | integer -[StringType](StringType.md) | string -[TimestampType](TimestampType.md) | timestamp -[QueryAggregationRangeType](QueryAggregationRangeType.md) | range - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryAggregationKeyTypeDict.md b/docs/v1/models/QueryAggregationKeyTypeDict.md deleted file mode 100644 index 674195c3..00000000 --- a/docs/v1/models/QueryAggregationKeyTypeDict.md +++ /dev/null @@ -1,22 +0,0 @@ -# QueryAggregationKeyTypeDict - -A union of all the types supported by query aggregation keys. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[BooleanTypeDict](BooleanTypeDict.md) | boolean -[DateTypeDict](DateTypeDict.md) | date -[DoubleTypeDict](DoubleTypeDict.md) | double -[IntegerTypeDict](IntegerTypeDict.md) | integer -[StringTypeDict](StringTypeDict.md) | string -[TimestampTypeDict](TimestampTypeDict.md) | timestamp -[QueryAggregationRangeTypeDict](QueryAggregationRangeTypeDict.md) | range - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryAggregationRange.md b/docs/v1/models/QueryAggregationRange.md deleted file mode 100644 index 6a0340c4..00000000 --- a/docs/v1/models/QueryAggregationRange.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryAggregationRange - -Specifies a range from an inclusive start value to an exclusive end value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**start_value** | Optional[Any] | No | Inclusive start. | -**end_value** | Optional[Any] | No | Exclusive end. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryAggregationRangeDict.md b/docs/v1/models/QueryAggregationRangeDict.md deleted file mode 100644 index 23e0bb0f..00000000 --- a/docs/v1/models/QueryAggregationRangeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryAggregationRangeDict - -Specifies a range from an inclusive start value to an exclusive end value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**startValue** | NotRequired[Any] | No | Inclusive start. | -**endValue** | NotRequired[Any] | No | Exclusive end. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryAggregationRangeSubType.md b/docs/v1/models/QueryAggregationRangeSubType.md deleted file mode 100644 index 57b49427..00000000 --- a/docs/v1/models/QueryAggregationRangeSubType.md +++ /dev/null @@ -1,19 +0,0 @@ -# QueryAggregationRangeSubType - -A union of all the types supported by query aggregation ranges. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[DateType](DateType.md) | date -[DoubleType](DoubleType.md) | double -[IntegerType](IntegerType.md) | integer -[TimestampType](TimestampType.md) | timestamp - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryAggregationRangeSubTypeDict.md b/docs/v1/models/QueryAggregationRangeSubTypeDict.md deleted file mode 100644 index d8c3bd4c..00000000 --- a/docs/v1/models/QueryAggregationRangeSubTypeDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# QueryAggregationRangeSubTypeDict - -A union of all the types supported by query aggregation ranges. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[DateTypeDict](DateTypeDict.md) | date -[DoubleTypeDict](DoubleTypeDict.md) | double -[IntegerTypeDict](IntegerTypeDict.md) | integer -[TimestampTypeDict](TimestampTypeDict.md) | timestamp - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryAggregationRangeType.md b/docs/v1/models/QueryAggregationRangeType.md deleted file mode 100644 index 5f5336b7..00000000 --- a/docs/v1/models/QueryAggregationRangeType.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryAggregationRangeType - -QueryAggregationRangeType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**sub_type** | QueryAggregationRangeSubType | Yes | | -**type** | Literal["range"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryAggregationRangeTypeDict.md b/docs/v1/models/QueryAggregationRangeTypeDict.md deleted file mode 100644 index 6f4e2d47..00000000 --- a/docs/v1/models/QueryAggregationRangeTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryAggregationRangeTypeDict - -QueryAggregationRangeType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | QueryAggregationRangeSubTypeDict | Yes | | -**type** | Literal["range"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryAggregationValueType.md b/docs/v1/models/QueryAggregationValueType.md deleted file mode 100644 index 4305cec3..00000000 --- a/docs/v1/models/QueryAggregationValueType.md +++ /dev/null @@ -1,18 +0,0 @@ -# QueryAggregationValueType - -A union of all the types supported by query aggregation keys. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[DateType](DateType.md) | date -[DoubleType](DoubleType.md) | double -[TimestampType](TimestampType.md) | timestamp - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryAggregationValueTypeDict.md b/docs/v1/models/QueryAggregationValueTypeDict.md deleted file mode 100644 index 57de61ae..00000000 --- a/docs/v1/models/QueryAggregationValueTypeDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# QueryAggregationValueTypeDict - -A union of all the types supported by query aggregation keys. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[DateTypeDict](DateTypeDict.md) | date -[DoubleTypeDict](DoubleTypeDict.md) | double -[TimestampTypeDict](TimestampTypeDict.md) | timestamp - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryApiName.md b/docs/v1/models/QueryApiName.md deleted file mode 100644 index 6e9a835f..00000000 --- a/docs/v1/models/QueryApiName.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryApiName - -The name of the Query in the API. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryArrayType.md b/docs/v1/models/QueryArrayType.md deleted file mode 100644 index ce9df560..00000000 --- a/docs/v1/models/QueryArrayType.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryArrayType - -QueryArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**sub_type** | QueryDataType | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryArrayTypeDict.md b/docs/v1/models/QueryArrayTypeDict.md deleted file mode 100644 index 03adb540..00000000 --- a/docs/v1/models/QueryArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryArrayTypeDict - -QueryArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | QueryDataTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryDataType.md b/docs/v1/models/QueryDataType.md deleted file mode 100644 index 88e55b5b..00000000 --- a/docs/v1/models/QueryDataType.md +++ /dev/null @@ -1,34 +0,0 @@ -# QueryDataType - -A union of all the types supported by Ontology Query parameters or outputs. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[QueryArrayType](QueryArrayType.md) | array -[AttachmentType](AttachmentType.md) | attachment -[BooleanType](BooleanType.md) | boolean -[DateType](DateType.md) | date -[DoubleType](DoubleType.md) | double -[FloatType](FloatType.md) | float -[IntegerType](IntegerType.md) | integer -[LongType](LongType.md) | long -[OntologyObjectSetType](OntologyObjectSetType.md) | objectSet -[OntologyObjectType](OntologyObjectType.md) | object -[QuerySetType](QuerySetType.md) | set -[StringType](StringType.md) | string -[QueryStructType](QueryStructType.md) | struct -[ThreeDimensionalAggregation](ThreeDimensionalAggregation.md) | threeDimensionalAggregation -[TimestampType](TimestampType.md) | timestamp -[TwoDimensionalAggregation](TwoDimensionalAggregation.md) | twoDimensionalAggregation -[QueryUnionType](QueryUnionType.md) | union -[NullType](NullType.md) | null -[UnsupportedType](UnsupportedType.md) | unsupported - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryDataTypeDict.md b/docs/v1/models/QueryDataTypeDict.md deleted file mode 100644 index 3c4e1e63..00000000 --- a/docs/v1/models/QueryDataTypeDict.md +++ /dev/null @@ -1,34 +0,0 @@ -# QueryDataTypeDict - -A union of all the types supported by Ontology Query parameters or outputs. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[QueryArrayTypeDict](QueryArrayTypeDict.md) | array -[AttachmentTypeDict](AttachmentTypeDict.md) | attachment -[BooleanTypeDict](BooleanTypeDict.md) | boolean -[DateTypeDict](DateTypeDict.md) | date -[DoubleTypeDict](DoubleTypeDict.md) | double -[FloatTypeDict](FloatTypeDict.md) | float -[IntegerTypeDict](IntegerTypeDict.md) | integer -[LongTypeDict](LongTypeDict.md) | long -[OntologyObjectSetTypeDict](OntologyObjectSetTypeDict.md) | objectSet -[OntologyObjectTypeDict](OntologyObjectTypeDict.md) | object -[QuerySetTypeDict](QuerySetTypeDict.md) | set -[StringTypeDict](StringTypeDict.md) | string -[QueryStructTypeDict](QueryStructTypeDict.md) | struct -[ThreeDimensionalAggregationDict](ThreeDimensionalAggregationDict.md) | threeDimensionalAggregation -[TimestampTypeDict](TimestampTypeDict.md) | timestamp -[TwoDimensionalAggregationDict](TwoDimensionalAggregationDict.md) | twoDimensionalAggregation -[QueryUnionTypeDict](QueryUnionTypeDict.md) | union -[NullTypeDict](NullTypeDict.md) | null -[UnsupportedTypeDict](UnsupportedTypeDict.md) | unsupported - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryOutputV2.md b/docs/v1/models/QueryOutputV2.md deleted file mode 100644 index 697fc3ef..00000000 --- a/docs/v1/models/QueryOutputV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryOutputV2 - -Details about the output of a query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data_type** | QueryDataType | Yes | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryOutputV2Dict.md b/docs/v1/models/QueryOutputV2Dict.md deleted file mode 100644 index 8765ac80..00000000 --- a/docs/v1/models/QueryOutputV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryOutputV2Dict - -Details about the output of a query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**dataType** | QueryDataTypeDict | Yes | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryParameterV2.md b/docs/v1/models/QueryParameterV2.md deleted file mode 100644 index baabd3af..00000000 --- a/docs/v1/models/QueryParameterV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryParameterV2 - -Details about a parameter of a query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | Optional[StrictStr] | No | | -**data_type** | QueryDataType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryParameterV2Dict.md b/docs/v1/models/QueryParameterV2Dict.md deleted file mode 100644 index 39235274..00000000 --- a/docs/v1/models/QueryParameterV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryParameterV2Dict - -Details about a parameter of a query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[StrictStr] | No | | -**dataType** | QueryDataTypeDict | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryRuntimeErrorParameter.md b/docs/v1/models/QueryRuntimeErrorParameter.md deleted file mode 100644 index 4e997813..00000000 --- a/docs/v1/models/QueryRuntimeErrorParameter.md +++ /dev/null @@ -1,11 +0,0 @@ -# QueryRuntimeErrorParameter - -QueryRuntimeErrorParameter - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QuerySetType.md b/docs/v1/models/QuerySetType.md deleted file mode 100644 index 4b65e190..00000000 --- a/docs/v1/models/QuerySetType.md +++ /dev/null @@ -1,12 +0,0 @@ -# QuerySetType - -QuerySetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**sub_type** | QueryDataType | Yes | | -**type** | Literal["set"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QuerySetTypeDict.md b/docs/v1/models/QuerySetTypeDict.md deleted file mode 100644 index 0ab24e7f..00000000 --- a/docs/v1/models/QuerySetTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QuerySetTypeDict - -QuerySetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | QueryDataTypeDict | Yes | | -**type** | Literal["set"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryStructField.md b/docs/v1/models/QueryStructField.md deleted file mode 100644 index 8be0dfbb..00000000 --- a/docs/v1/models/QueryStructField.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryStructField - -QueryStructField - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StructFieldName | Yes | | -**field_type** | QueryDataType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryStructFieldDict.md b/docs/v1/models/QueryStructFieldDict.md deleted file mode 100644 index 3c4c8a75..00000000 --- a/docs/v1/models/QueryStructFieldDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryStructFieldDict - -QueryStructField - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StructFieldName | Yes | | -**fieldType** | QueryDataTypeDict | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryStructType.md b/docs/v1/models/QueryStructType.md deleted file mode 100644 index b4bf1fe0..00000000 --- a/docs/v1/models/QueryStructType.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryStructType - -QueryStructType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[QueryStructField] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryStructTypeDict.md b/docs/v1/models/QueryStructTypeDict.md deleted file mode 100644 index 2ef07562..00000000 --- a/docs/v1/models/QueryStructTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryStructTypeDict - -QueryStructType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[QueryStructFieldDict] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryThreeDimensionalAggregation.md b/docs/v1/models/QueryThreeDimensionalAggregation.md deleted file mode 100644 index 6d601f66..00000000 --- a/docs/v1/models/QueryThreeDimensionalAggregation.md +++ /dev/null @@ -1,11 +0,0 @@ -# QueryThreeDimensionalAggregation - -QueryThreeDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**groups** | List[NestedQueryAggregation] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryThreeDimensionalAggregationDict.md b/docs/v1/models/QueryThreeDimensionalAggregationDict.md deleted file mode 100644 index f8aed23b..00000000 --- a/docs/v1/models/QueryThreeDimensionalAggregationDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# QueryThreeDimensionalAggregationDict - -QueryThreeDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**groups** | List[NestedQueryAggregationDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryTwoDimensionalAggregation.md b/docs/v1/models/QueryTwoDimensionalAggregation.md deleted file mode 100644 index 1e7bf30a..00000000 --- a/docs/v1/models/QueryTwoDimensionalAggregation.md +++ /dev/null @@ -1,11 +0,0 @@ -# QueryTwoDimensionalAggregation - -QueryTwoDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**groups** | List[QueryAggregation] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryTwoDimensionalAggregationDict.md b/docs/v1/models/QueryTwoDimensionalAggregationDict.md deleted file mode 100644 index acfbdf95..00000000 --- a/docs/v1/models/QueryTwoDimensionalAggregationDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# QueryTwoDimensionalAggregationDict - -QueryTwoDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**groups** | List[QueryAggregationDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryType.md b/docs/v1/models/QueryType.md deleted file mode 100644 index 7f386099..00000000 --- a/docs/v1/models/QueryType.md +++ /dev/null @@ -1,17 +0,0 @@ -# QueryType - -Represents a query type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | QueryApiName | Yes | | -**description** | Optional[StrictStr] | No | | -**display_name** | Optional[DisplayName] | No | | -**parameters** | Dict[ParameterId, Parameter] | Yes | | -**output** | Optional[OntologyDataType] | No | | -**rid** | FunctionRid | Yes | | -**version** | FunctionVersion | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryTypeDict.md b/docs/v1/models/QueryTypeDict.md deleted file mode 100644 index 30d5b3f9..00000000 --- a/docs/v1/models/QueryTypeDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# QueryTypeDict - -Represents a query type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | QueryApiName | Yes | | -**description** | NotRequired[StrictStr] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**parameters** | Dict[ParameterId, ParameterDict] | Yes | | -**output** | NotRequired[OntologyDataTypeDict] | No | | -**rid** | FunctionRid | Yes | | -**version** | FunctionVersion | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryTypeV2.md b/docs/v1/models/QueryTypeV2.md deleted file mode 100644 index b700a35a..00000000 --- a/docs/v1/models/QueryTypeV2.md +++ /dev/null @@ -1,17 +0,0 @@ -# QueryTypeV2 - -Represents a query type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | QueryApiName | Yes | | -**description** | Optional[StrictStr] | No | | -**display_name** | Optional[DisplayName] | No | | -**parameters** | Dict[ParameterId, QueryParameterV2] | Yes | | -**output** | QueryDataType | Yes | | -**rid** | FunctionRid | Yes | | -**version** | FunctionVersion | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryTypeV2Dict.md b/docs/v1/models/QueryTypeV2Dict.md deleted file mode 100644 index 5381169a..00000000 --- a/docs/v1/models/QueryTypeV2Dict.md +++ /dev/null @@ -1,17 +0,0 @@ -# QueryTypeV2Dict - -Represents a query type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | QueryApiName | Yes | | -**description** | NotRequired[StrictStr] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**parameters** | Dict[ParameterId, QueryParameterV2Dict] | Yes | | -**output** | QueryDataTypeDict | Yes | | -**rid** | FunctionRid | Yes | | -**version** | FunctionVersion | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryUnionType.md b/docs/v1/models/QueryUnionType.md deleted file mode 100644 index 9db87c10..00000000 --- a/docs/v1/models/QueryUnionType.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryUnionType - -QueryUnionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**union_types** | List[QueryDataType] | Yes | | -**type** | Literal["union"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/QueryUnionTypeDict.md b/docs/v1/models/QueryUnionTypeDict.md deleted file mode 100644 index f7c229b6..00000000 --- a/docs/v1/models/QueryUnionTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryUnionTypeDict - -QueryUnionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**unionTypes** | List[QueryDataTypeDict] | Yes | | -**type** | Literal["union"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/RangeConstraint.md b/docs/v1/models/RangeConstraint.md deleted file mode 100644 index 26f7a37f..00000000 --- a/docs/v1/models/RangeConstraint.md +++ /dev/null @@ -1,16 +0,0 @@ -# RangeConstraint - -The parameter value must be within the defined range. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | Optional[Any] | No | Less than | -**lte** | Optional[Any] | No | Less than or equal | -**gt** | Optional[Any] | No | Greater than | -**gte** | Optional[Any] | No | Greater than or equal | -**type** | Literal["range"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/RangeConstraintDict.md b/docs/v1/models/RangeConstraintDict.md deleted file mode 100644 index 225b66e8..00000000 --- a/docs/v1/models/RangeConstraintDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# RangeConstraintDict - -The parameter value must be within the defined range. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Less than | -**lte** | NotRequired[Any] | No | Less than or equal | -**gt** | NotRequired[Any] | No | Greater than | -**gte** | NotRequired[Any] | No | Greater than or equal | -**type** | Literal["range"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Reason.md b/docs/v1/models/Reason.md deleted file mode 100644 index 269e01ba..00000000 --- a/docs/v1/models/Reason.md +++ /dev/null @@ -1,12 +0,0 @@ -# Reason - -Reason - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**reason** | ReasonType | Yes | | -**type** | Literal["reason"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ReasonDict.md b/docs/v1/models/ReasonDict.md deleted file mode 100644 index 06124eb1..00000000 --- a/docs/v1/models/ReasonDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReasonDict - -Reason - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**reason** | ReasonType | Yes | | -**type** | Literal["reason"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ReasonType.md b/docs/v1/models/ReasonType.md deleted file mode 100644 index 898cb3cc..00000000 --- a/docs/v1/models/ReasonType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReasonType - -Represents the reason a subscription was closed. - - -| **Value** | -| --------- | -| `"USER_CLOSED"` | -| `"CHANNEL_CLOSED"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ReferenceUpdate.md b/docs/v1/models/ReferenceUpdate.md deleted file mode 100644 index 02b4da91..00000000 --- a/docs/v1/models/ReferenceUpdate.md +++ /dev/null @@ -1,18 +0,0 @@ -# ReferenceUpdate - -The updated data value associated with an object instance's external reference. The object instance -is uniquely identified by an object type and a primary key. Note that the value of the property -field returns a dereferenced value rather than the reference itself. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_type** | ObjectTypeApiName | Yes | | -**primary_key** | ObjectPrimaryKey | Yes | | -**property** | PropertyApiName | Yes | | -**value** | ReferenceValue | Yes | | -**type** | Literal["reference"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ReferenceUpdateDict.md b/docs/v1/models/ReferenceUpdateDict.md deleted file mode 100644 index 02fa17a6..00000000 --- a/docs/v1/models/ReferenceUpdateDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# ReferenceUpdateDict - -The updated data value associated with an object instance's external reference. The object instance -is uniquely identified by an object type and a primary key. Note that the value of the property -field returns a dereferenced value rather than the reference itself. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectType** | ObjectTypeApiName | Yes | | -**primaryKey** | ObjectPrimaryKey | Yes | | -**property** | PropertyApiName | Yes | | -**value** | ReferenceValueDict | Yes | | -**type** | Literal["reference"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ReferenceValue.md b/docs/v1/models/ReferenceValue.md deleted file mode 100644 index 4e1e9549..00000000 --- a/docs/v1/models/ReferenceValue.md +++ /dev/null @@ -1,11 +0,0 @@ -# ReferenceValue - -Resolved data values pointed to by a reference. - -## Type -```python -GeotimeSeriesValue -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ReferenceValueDict.md b/docs/v1/models/ReferenceValueDict.md deleted file mode 100644 index 957c2deb..00000000 --- a/docs/v1/models/ReferenceValueDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ReferenceValueDict - -Resolved data values pointed to by a reference. - -## Type -```python -GeotimeSeriesValueDict -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/RefreshObjectSet.md b/docs/v1/models/RefreshObjectSet.md deleted file mode 100644 index a258c473..00000000 --- a/docs/v1/models/RefreshObjectSet.md +++ /dev/null @@ -1,14 +0,0 @@ -# RefreshObjectSet - -The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**object_type** | ObjectTypeApiName | Yes | | -**type** | Literal["refreshObjectSet"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/RefreshObjectSetDict.md b/docs/v1/models/RefreshObjectSetDict.md deleted file mode 100644 index 3aec7b82..00000000 --- a/docs/v1/models/RefreshObjectSetDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# RefreshObjectSetDict - -The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**objectType** | ObjectTypeApiName | Yes | | -**type** | Literal["refreshObjectSet"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/RelativeTime.md b/docs/v1/models/RelativeTime.md deleted file mode 100644 index 8c5dea58..00000000 --- a/docs/v1/models/RelativeTime.md +++ /dev/null @@ -1,14 +0,0 @@ -# RelativeTime - -A relative time, such as "3 days before" or "2 hours after" the current moment. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**when** | RelativeTimeRelation | Yes | | -**value** | StrictInt | Yes | | -**unit** | RelativeTimeSeriesTimeUnit | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/RelativeTimeDict.md b/docs/v1/models/RelativeTimeDict.md deleted file mode 100644 index 2921fc17..00000000 --- a/docs/v1/models/RelativeTimeDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# RelativeTimeDict - -A relative time, such as "3 days before" or "2 hours after" the current moment. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**when** | RelativeTimeRelation | Yes | | -**value** | StrictInt | Yes | | -**unit** | RelativeTimeSeriesTimeUnit | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/RelativeTimeRange.md b/docs/v1/models/RelativeTimeRange.md deleted file mode 100644 index 147b58e4..00000000 --- a/docs/v1/models/RelativeTimeRange.md +++ /dev/null @@ -1,14 +0,0 @@ -# RelativeTimeRange - -A relative time range for a time series query. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**start_time** | Optional[RelativeTime] | No | | -**end_time** | Optional[RelativeTime] | No | | -**type** | Literal["relative"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/RelativeTimeRangeDict.md b/docs/v1/models/RelativeTimeRangeDict.md deleted file mode 100644 index c5b5a79b..00000000 --- a/docs/v1/models/RelativeTimeRangeDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# RelativeTimeRangeDict - -A relative time range for a time series query. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**startTime** | NotRequired[RelativeTimeDict] | No | | -**endTime** | NotRequired[RelativeTimeDict] | No | | -**type** | Literal["relative"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/RelativeTimeRelation.md b/docs/v1/models/RelativeTimeRelation.md deleted file mode 100644 index 2f79077b..00000000 --- a/docs/v1/models/RelativeTimeRelation.md +++ /dev/null @@ -1,11 +0,0 @@ -# RelativeTimeRelation - -RelativeTimeRelation - -| **Value** | -| --------- | -| `"BEFORE"` | -| `"AFTER"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/RelativeTimeSeriesTimeUnit.md b/docs/v1/models/RelativeTimeSeriesTimeUnit.md deleted file mode 100644 index 6ce63e02..00000000 --- a/docs/v1/models/RelativeTimeSeriesTimeUnit.md +++ /dev/null @@ -1,17 +0,0 @@ -# RelativeTimeSeriesTimeUnit - -RelativeTimeSeriesTimeUnit - -| **Value** | -| --------- | -| `"MILLISECONDS"` | -| `"SECONDS"` | -| `"MINUTES"` | -| `"HOURS"` | -| `"DAYS"` | -| `"WEEKS"` | -| `"MONTHS"` | -| `"YEARS"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ReleaseStatus.md b/docs/v1/models/ReleaseStatus.md deleted file mode 100644 index 58dc56fd..00000000 --- a/docs/v1/models/ReleaseStatus.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReleaseStatus - -The release status of the entity. - -| **Value** | -| --------- | -| `"ACTIVE"` | -| `"EXPERIMENTAL"` | -| `"DEPRECATED"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/RequestId.md b/docs/v1/models/RequestId.md deleted file mode 100644 index 44f3baf6..00000000 --- a/docs/v1/models/RequestId.md +++ /dev/null @@ -1,11 +0,0 @@ -# RequestId - -Unique request id - -## Type -```python -UUID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ResourcePath.md b/docs/v1/models/ResourcePath.md deleted file mode 100644 index f62d1509..00000000 --- a/docs/v1/models/ResourcePath.md +++ /dev/null @@ -1,12 +0,0 @@ -# ResourcePath - -A path in the Foundry file tree. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ReturnEditsMode.md b/docs/v1/models/ReturnEditsMode.md deleted file mode 100644 index 9d8deddc..00000000 --- a/docs/v1/models/ReturnEditsMode.md +++ /dev/null @@ -1,11 +0,0 @@ -# ReturnEditsMode - -ReturnEditsMode - -| **Value** | -| --------- | -| `"ALL"` | -| `"NONE"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SdkPackageName.md b/docs/v1/models/SdkPackageName.md deleted file mode 100644 index 08e481a5..00000000 --- a/docs/v1/models/SdkPackageName.md +++ /dev/null @@ -1,11 +0,0 @@ -# SdkPackageName - -SdkPackageName - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchJsonQuery.md b/docs/v1/models/SearchJsonQuery.md deleted file mode 100644 index 8114fa81..00000000 --- a/docs/v1/models/SearchJsonQuery.md +++ /dev/null @@ -1,28 +0,0 @@ -# SearchJsonQuery - -SearchJsonQuery - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[LtQuery](LtQuery.md) | lt -[GtQuery](GtQuery.md) | gt -[LteQuery](LteQuery.md) | lte -[GteQuery](GteQuery.md) | gte -[EqualsQuery](EqualsQuery.md) | eq -[IsNullQuery](IsNullQuery.md) | isNull -[ContainsQuery](ContainsQuery.md) | contains -[AndQuery](AndQuery.md) | and -[OrQuery](OrQuery.md) | or -[NotQuery](NotQuery.md) | not -[PrefixQuery](PrefixQuery.md) | prefix -[PhraseQuery](PhraseQuery.md) | phrase -[AnyTermQuery](AnyTermQuery.md) | anyTerm -[AllTermsQuery](AllTermsQuery.md) | allTerms - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchJsonQueryDict.md b/docs/v1/models/SearchJsonQueryDict.md deleted file mode 100644 index 19493c20..00000000 --- a/docs/v1/models/SearchJsonQueryDict.md +++ /dev/null @@ -1,28 +0,0 @@ -# SearchJsonQueryDict - -SearchJsonQuery - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[LtQueryDict](LtQueryDict.md) | lt -[GtQueryDict](GtQueryDict.md) | gt -[LteQueryDict](LteQueryDict.md) | lte -[GteQueryDict](GteQueryDict.md) | gte -[EqualsQueryDict](EqualsQueryDict.md) | eq -[IsNullQueryDict](IsNullQueryDict.md) | isNull -[ContainsQueryDict](ContainsQueryDict.md) | contains -[AndQueryDict](AndQueryDict.md) | and -[OrQueryDict](OrQueryDict.md) | or -[NotQueryDict](NotQueryDict.md) | not -[PrefixQueryDict](PrefixQueryDict.md) | prefix -[PhraseQueryDict](PhraseQueryDict.md) | phrase -[AnyTermQueryDict](AnyTermQueryDict.md) | anyTerm -[AllTermsQueryDict](AllTermsQueryDict.md) | allTerms - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchJsonQueryV2.md b/docs/v1/models/SearchJsonQueryV2.md deleted file mode 100644 index 029d8e5c..00000000 --- a/docs/v1/models/SearchJsonQueryV2.md +++ /dev/null @@ -1,36 +0,0 @@ -# SearchJsonQueryV2 - -SearchJsonQueryV2 - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[LtQueryV2](LtQueryV2.md) | lt -[GtQueryV2](GtQueryV2.md) | gt -[LteQueryV2](LteQueryV2.md) | lte -[GteQueryV2](GteQueryV2.md) | gte -[EqualsQueryV2](EqualsQueryV2.md) | eq -[IsNullQueryV2](IsNullQueryV2.md) | isNull -[ContainsQueryV2](ContainsQueryV2.md) | contains -[AndQueryV2](AndQueryV2.md) | and -[OrQueryV2](OrQueryV2.md) | or -[NotQueryV2](NotQueryV2.md) | not -[StartsWithQuery](StartsWithQuery.md) | startsWith -[ContainsAllTermsInOrderQuery](ContainsAllTermsInOrderQuery.md) | containsAllTermsInOrder -[ContainsAllTermsInOrderPrefixLastTerm](ContainsAllTermsInOrderPrefixLastTerm.md) | containsAllTermsInOrderPrefixLastTerm -[ContainsAnyTermQuery](ContainsAnyTermQuery.md) | containsAnyTerm -[ContainsAllTermsQuery](ContainsAllTermsQuery.md) | containsAllTerms -[WithinDistanceOfQuery](WithinDistanceOfQuery.md) | withinDistanceOf -[WithinBoundingBoxQuery](WithinBoundingBoxQuery.md) | withinBoundingBox -[IntersectsBoundingBoxQuery](IntersectsBoundingBoxQuery.md) | intersectsBoundingBox -[DoesNotIntersectBoundingBoxQuery](DoesNotIntersectBoundingBoxQuery.md) | doesNotIntersectBoundingBox -[WithinPolygonQuery](WithinPolygonQuery.md) | withinPolygon -[IntersectsPolygonQuery](IntersectsPolygonQuery.md) | intersectsPolygon -[DoesNotIntersectPolygonQuery](DoesNotIntersectPolygonQuery.md) | doesNotIntersectPolygon - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchJsonQueryV2Dict.md b/docs/v1/models/SearchJsonQueryV2Dict.md deleted file mode 100644 index 57e950f6..00000000 --- a/docs/v1/models/SearchJsonQueryV2Dict.md +++ /dev/null @@ -1,36 +0,0 @@ -# SearchJsonQueryV2Dict - -SearchJsonQueryV2 - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[LtQueryV2Dict](LtQueryV2Dict.md) | lt -[GtQueryV2Dict](GtQueryV2Dict.md) | gt -[LteQueryV2Dict](LteQueryV2Dict.md) | lte -[GteQueryV2Dict](GteQueryV2Dict.md) | gte -[EqualsQueryV2Dict](EqualsQueryV2Dict.md) | eq -[IsNullQueryV2Dict](IsNullQueryV2Dict.md) | isNull -[ContainsQueryV2Dict](ContainsQueryV2Dict.md) | contains -[AndQueryV2Dict](AndQueryV2Dict.md) | and -[OrQueryV2Dict](OrQueryV2Dict.md) | or -[NotQueryV2Dict](NotQueryV2Dict.md) | not -[StartsWithQueryDict](StartsWithQueryDict.md) | startsWith -[ContainsAllTermsInOrderQueryDict](ContainsAllTermsInOrderQueryDict.md) | containsAllTermsInOrder -[ContainsAllTermsInOrderPrefixLastTermDict](ContainsAllTermsInOrderPrefixLastTermDict.md) | containsAllTermsInOrderPrefixLastTerm -[ContainsAnyTermQueryDict](ContainsAnyTermQueryDict.md) | containsAnyTerm -[ContainsAllTermsQueryDict](ContainsAllTermsQueryDict.md) | containsAllTerms -[WithinDistanceOfQueryDict](WithinDistanceOfQueryDict.md) | withinDistanceOf -[WithinBoundingBoxQueryDict](WithinBoundingBoxQueryDict.md) | withinBoundingBox -[IntersectsBoundingBoxQueryDict](IntersectsBoundingBoxQueryDict.md) | intersectsBoundingBox -[DoesNotIntersectBoundingBoxQueryDict](DoesNotIntersectBoundingBoxQueryDict.md) | doesNotIntersectBoundingBox -[WithinPolygonQueryDict](WithinPolygonQueryDict.md) | withinPolygon -[IntersectsPolygonQueryDict](IntersectsPolygonQueryDict.md) | intersectsPolygon -[DoesNotIntersectPolygonQueryDict](DoesNotIntersectPolygonQueryDict.md) | doesNotIntersectPolygon - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchObjectsForInterfaceRequest.md b/docs/v1/models/SearchObjectsForInterfaceRequest.md deleted file mode 100644 index b4be8958..00000000 --- a/docs/v1/models/SearchObjectsForInterfaceRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# SearchObjectsForInterfaceRequest - -SearchObjectsForInterfaceRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**where** | Optional[SearchJsonQueryV2] | No | | -**order_by** | Optional[SearchOrderByV2] | No | | -**augmented_properties** | Dict[ObjectTypeApiName, List[PropertyApiName]] | Yes | A map from object type API name to a list of property type API names. For each returned object, if the object’s object type is a key in the map, then we augment the response for that object type with the list of properties specified in the value. | -**augmented_shared_property_types** | Dict[InterfaceTypeApiName, List[SharedPropertyTypeApiName]] | Yes | A map from interface type API name to a list of shared property type API names. For each returned object, if the object implements an interface that is a key in the map, then we augment the response for that object type with the list of properties specified in the value. | -**selected_shared_property_types** | List[SharedPropertyTypeApiName] | Yes | A list of shared property type API names of the interface type that should be included in the response. Omit this parameter to include all properties of the interface type in the response. | -**selected_object_types** | List[ObjectTypeApiName] | Yes | A list of object type API names that should be included in the response. If non-empty, object types that are not mentioned will not be included in the response even if they implement the specified interface. Omit the parameter to include all object types. | -**other_interface_types** | List[InterfaceTypeApiName] | Yes | A list of interface type API names. Object types must implement all the mentioned interfaces in order to be included in the response. | -**page_size** | Optional[PageSize] | No | | -**page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchObjectsForInterfaceRequestDict.md b/docs/v1/models/SearchObjectsForInterfaceRequestDict.md deleted file mode 100644 index 5ee44671..00000000 --- a/docs/v1/models/SearchObjectsForInterfaceRequestDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# SearchObjectsForInterfaceRequestDict - -SearchObjectsForInterfaceRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**where** | NotRequired[SearchJsonQueryV2Dict] | No | | -**orderBy** | NotRequired[SearchOrderByV2Dict] | No | | -**augmentedProperties** | Dict[ObjectTypeApiName, List[PropertyApiName]] | Yes | A map from object type API name to a list of property type API names. For each returned object, if the object’s object type is a key in the map, then we augment the response for that object type with the list of properties specified in the value. | -**augmentedSharedPropertyTypes** | Dict[InterfaceTypeApiName, List[SharedPropertyTypeApiName]] | Yes | A map from interface type API name to a list of shared property type API names. For each returned object, if the object implements an interface that is a key in the map, then we augment the response for that object type with the list of properties specified in the value. | -**selectedSharedPropertyTypes** | List[SharedPropertyTypeApiName] | Yes | A list of shared property type API names of the interface type that should be included in the response. Omit this parameter to include all properties of the interface type in the response. | -**selectedObjectTypes** | List[ObjectTypeApiName] | Yes | A list of object type API names that should be included in the response. If non-empty, object types that are not mentioned will not be included in the response even if they implement the specified interface. Omit the parameter to include all object types. | -**otherInterfaceTypes** | List[InterfaceTypeApiName] | Yes | A list of interface type API names. Object types must implement all the mentioned interfaces in order to be included in the response. | -**pageSize** | NotRequired[PageSize] | No | | -**pageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchObjectsRequest.md b/docs/v1/models/SearchObjectsRequest.md deleted file mode 100644 index b5228c2a..00000000 --- a/docs/v1/models/SearchObjectsRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# SearchObjectsRequest - -SearchObjectsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | SearchJsonQuery | Yes | | -**order_by** | Optional[SearchOrderBy] | No | | -**page_size** | Optional[PageSize] | No | | -**page_token** | Optional[PageToken] | No | | -**fields** | List[PropertyApiName] | Yes | The API names of the object type properties to include in the response. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchObjectsRequestDict.md b/docs/v1/models/SearchObjectsRequestDict.md deleted file mode 100644 index f66231e0..00000000 --- a/docs/v1/models/SearchObjectsRequestDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# SearchObjectsRequestDict - -SearchObjectsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | SearchJsonQueryDict | Yes | | -**orderBy** | NotRequired[SearchOrderByDict] | No | | -**pageSize** | NotRequired[PageSize] | No | | -**pageToken** | NotRequired[PageToken] | No | | -**fields** | List[PropertyApiName] | Yes | The API names of the object type properties to include in the response. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchObjectsRequestV2.md b/docs/v1/models/SearchObjectsRequestV2.md deleted file mode 100644 index 06d31b52..00000000 --- a/docs/v1/models/SearchObjectsRequestV2.md +++ /dev/null @@ -1,16 +0,0 @@ -# SearchObjectsRequestV2 - -SearchObjectsRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**where** | Optional[SearchJsonQueryV2] | No | | -**order_by** | Optional[SearchOrderByV2] | No | | -**page_size** | Optional[PageSize] | No | | -**page_token** | Optional[PageToken] | No | | -**select** | List[PropertyApiName] | Yes | The API names of the object type properties to include in the response. | -**exclude_rid** | Optional[StrictBool] | No | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchObjectsRequestV2Dict.md b/docs/v1/models/SearchObjectsRequestV2Dict.md deleted file mode 100644 index 304b20e8..00000000 --- a/docs/v1/models/SearchObjectsRequestV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# SearchObjectsRequestV2Dict - -SearchObjectsRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**where** | NotRequired[SearchJsonQueryV2Dict] | No | | -**orderBy** | NotRequired[SearchOrderByV2Dict] | No | | -**pageSize** | NotRequired[PageSize] | No | | -**pageToken** | NotRequired[PageToken] | No | | -**select** | List[PropertyApiName] | Yes | The API names of the object type properties to include in the response. | -**excludeRid** | NotRequired[StrictBool] | No | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchObjectsResponse.md b/docs/v1/models/SearchObjectsResponse.md deleted file mode 100644 index 15388e67..00000000 --- a/docs/v1/models/SearchObjectsResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchObjectsResponse - -SearchObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObject] | Yes | | -**next_page_token** | Optional[PageToken] | No | | -**total_count** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchObjectsResponseDict.md b/docs/v1/models/SearchObjectsResponseDict.md deleted file mode 100644 index 519f51f5..00000000 --- a/docs/v1/models/SearchObjectsResponseDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchObjectsResponseDict - -SearchObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchObjectsResponseV2.md b/docs/v1/models/SearchObjectsResponseV2.md deleted file mode 100644 index 8ab42326..00000000 --- a/docs/v1/models/SearchObjectsResponseV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchObjectsResponseV2 - -SearchObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | | -**next_page_token** | Optional[PageToken] | No | | -**total_count** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchObjectsResponseV2Dict.md b/docs/v1/models/SearchObjectsResponseV2Dict.md deleted file mode 100644 index 05536a04..00000000 --- a/docs/v1/models/SearchObjectsResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchObjectsResponseV2Dict - -SearchObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchOrderBy.md b/docs/v1/models/SearchOrderBy.md deleted file mode 100644 index 4839257d..00000000 --- a/docs/v1/models/SearchOrderBy.md +++ /dev/null @@ -1,11 +0,0 @@ -# SearchOrderBy - -Specifies the ordering of search results by a field and an ordering direction. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[SearchOrdering] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchOrderByDict.md b/docs/v1/models/SearchOrderByDict.md deleted file mode 100644 index bf977f98..00000000 --- a/docs/v1/models/SearchOrderByDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# SearchOrderByDict - -Specifies the ordering of search results by a field and an ordering direction. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[SearchOrderingDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchOrderByV2.md b/docs/v1/models/SearchOrderByV2.md deleted file mode 100644 index 477a3904..00000000 --- a/docs/v1/models/SearchOrderByV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# SearchOrderByV2 - -Specifies the ordering of search results by a field and an ordering direction. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[SearchOrderingV2] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchOrderByV2Dict.md b/docs/v1/models/SearchOrderByV2Dict.md deleted file mode 100644 index 1409385c..00000000 --- a/docs/v1/models/SearchOrderByV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# SearchOrderByV2Dict - -Specifies the ordering of search results by a field and an ordering direction. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[SearchOrderingV2Dict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchOrdering.md b/docs/v1/models/SearchOrdering.md deleted file mode 100644 index bff66d4b..00000000 --- a/docs/v1/models/SearchOrdering.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchOrdering - -SearchOrdering - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**direction** | Optional[StrictStr] | No | Specifies the ordering direction (can be either `asc` or `desc`) | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchOrderingDict.md b/docs/v1/models/SearchOrderingDict.md deleted file mode 100644 index e81b939a..00000000 --- a/docs/v1/models/SearchOrderingDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchOrderingDict - -SearchOrdering - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**direction** | NotRequired[StrictStr] | No | Specifies the ordering direction (can be either `asc` or `desc`) | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchOrderingV2.md b/docs/v1/models/SearchOrderingV2.md deleted file mode 100644 index b47a29cf..00000000 --- a/docs/v1/models/SearchOrderingV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchOrderingV2 - -SearchOrderingV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**direction** | Optional[StrictStr] | No | Specifies the ordering direction (can be either `asc` or `desc`) | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SearchOrderingV2Dict.md b/docs/v1/models/SearchOrderingV2Dict.md deleted file mode 100644 index 9b91d17f..00000000 --- a/docs/v1/models/SearchOrderingV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchOrderingV2Dict - -SearchOrderingV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**direction** | NotRequired[StrictStr] | No | Specifies the ordering direction (can be either `asc` or `desc`) | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SelectedPropertyApiName.md b/docs/v1/models/SelectedPropertyApiName.md deleted file mode 100644 index cfdbde82..00000000 --- a/docs/v1/models/SelectedPropertyApiName.md +++ /dev/null @@ -1,26 +0,0 @@ -# SelectedPropertyApiName - -By default, anytime an object is requested, every property belonging to that object is returned. -The response can be filtered to only include certain properties using the `properties` query parameter. - -Properties to include can be specified in one of two ways. - -- A comma delimited list as the value for the `properties` query parameter - `properties={property1ApiName},{property2ApiName}` -- Multiple `properties` query parameters. - `properties={property1ApiName}&properties={property2ApiName}` - -The primary key of the object will always be returned even if it wasn't specified in the `properties` values. - -Unknown properties specified in the `properties` list will result in a `PropertiesNotFound` error. - -To find the API name for your property, use the `Get object type` endpoint or check the **Ontology Manager**. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SharedPropertyType.md b/docs/v1/models/SharedPropertyType.md deleted file mode 100644 index 8a5dc805..00000000 --- a/docs/v1/models/SharedPropertyType.md +++ /dev/null @@ -1,15 +0,0 @@ -# SharedPropertyType - -A property type that can be shared across object types. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | SharedPropertyTypeRid | Yes | | -**api_name** | SharedPropertyTypeApiName | Yes | | -**display_name** | DisplayName | Yes | | -**description** | Optional[StrictStr] | No | A short text that describes the SharedPropertyType. | -**data_type** | ObjectPropertyType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SharedPropertyTypeApiName.md b/docs/v1/models/SharedPropertyTypeApiName.md deleted file mode 100644 index 960b547e..00000000 --- a/docs/v1/models/SharedPropertyTypeApiName.md +++ /dev/null @@ -1,13 +0,0 @@ -# SharedPropertyTypeApiName - -The name of the shared property type in the API in lowerCamelCase format. To find the API name for your -shared property type, use the `List shared property types` endpoint or check the **Ontology Manager**. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SharedPropertyTypeDict.md b/docs/v1/models/SharedPropertyTypeDict.md deleted file mode 100644 index 597551aa..00000000 --- a/docs/v1/models/SharedPropertyTypeDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# SharedPropertyTypeDict - -A property type that can be shared across object types. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | SharedPropertyTypeRid | Yes | | -**apiName** | SharedPropertyTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | NotRequired[StrictStr] | No | A short text that describes the SharedPropertyType. | -**dataType** | ObjectPropertyTypeDict | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SharedPropertyTypeRid.md b/docs/v1/models/SharedPropertyTypeRid.md deleted file mode 100644 index d04f1ee6..00000000 --- a/docs/v1/models/SharedPropertyTypeRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# SharedPropertyTypeRid - -The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ShortType.md b/docs/v1/models/ShortType.md deleted file mode 100644 index 428b9cd7..00000000 --- a/docs/v1/models/ShortType.md +++ /dev/null @@ -1,11 +0,0 @@ -# ShortType - -ShortType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["short"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ShortTypeDict.md b/docs/v1/models/ShortTypeDict.md deleted file mode 100644 index 10075c35..00000000 --- a/docs/v1/models/ShortTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ShortTypeDict - -ShortType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["short"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SizeBytes.md b/docs/v1/models/SizeBytes.md deleted file mode 100644 index 6dfa33b1..00000000 --- a/docs/v1/models/SizeBytes.md +++ /dev/null @@ -1,11 +0,0 @@ -# SizeBytes - -The size of the file or attachment in bytes. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StartsWithQuery.md b/docs/v1/models/StartsWithQuery.md deleted file mode 100644 index 2236ad16..00000000 --- a/docs/v1/models/StartsWithQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# StartsWithQuery - -Returns objects where the specified field starts with the provided value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["startsWith"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StartsWithQueryDict.md b/docs/v1/models/StartsWithQueryDict.md deleted file mode 100644 index 8eb4f071..00000000 --- a/docs/v1/models/StartsWithQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# StartsWithQueryDict - -Returns objects where the specified field starts with the provided value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["startsWith"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StreamMessage.md b/docs/v1/models/StreamMessage.md deleted file mode 100644 index 31dacdee..00000000 --- a/docs/v1/models/StreamMessage.md +++ /dev/null @@ -1,18 +0,0 @@ -# StreamMessage - -StreamMessage - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectSetSubscribeResponses](ObjectSetSubscribeResponses.md) | subscribeResponses -[ObjectSetUpdates](ObjectSetUpdates.md) | objectSetChanged -[RefreshObjectSet](RefreshObjectSet.md) | refreshObjectSet -[SubscriptionClosed](SubscriptionClosed.md) | subscriptionClosed - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StreamMessageDict.md b/docs/v1/models/StreamMessageDict.md deleted file mode 100644 index 4fe2a12c..00000000 --- a/docs/v1/models/StreamMessageDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# StreamMessageDict - -StreamMessage - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectSetSubscribeResponsesDict](ObjectSetSubscribeResponsesDict.md) | subscribeResponses -[ObjectSetUpdatesDict](ObjectSetUpdatesDict.md) | objectSetChanged -[RefreshObjectSetDict](RefreshObjectSetDict.md) | refreshObjectSet -[SubscriptionClosedDict](SubscriptionClosedDict.md) | subscriptionClosed - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StreamTimeSeriesPointsRequest.md b/docs/v1/models/StreamTimeSeriesPointsRequest.md deleted file mode 100644 index 7b143aec..00000000 --- a/docs/v1/models/StreamTimeSeriesPointsRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# StreamTimeSeriesPointsRequest - -StreamTimeSeriesPointsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**range** | Optional[TimeRange] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StreamTimeSeriesPointsRequestDict.md b/docs/v1/models/StreamTimeSeriesPointsRequestDict.md deleted file mode 100644 index efd3d1a9..00000000 --- a/docs/v1/models/StreamTimeSeriesPointsRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# StreamTimeSeriesPointsRequestDict - -StreamTimeSeriesPointsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**range** | NotRequired[TimeRangeDict] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StreamTimeSeriesPointsResponse.md b/docs/v1/models/StreamTimeSeriesPointsResponse.md deleted file mode 100644 index abb0986e..00000000 --- a/docs/v1/models/StreamTimeSeriesPointsResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# StreamTimeSeriesPointsResponse - -StreamTimeSeriesPointsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[TimeSeriesPoint] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StreamTimeSeriesPointsResponseDict.md b/docs/v1/models/StreamTimeSeriesPointsResponseDict.md deleted file mode 100644 index 24a6c218..00000000 --- a/docs/v1/models/StreamTimeSeriesPointsResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# StreamTimeSeriesPointsResponseDict - -StreamTimeSeriesPointsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[TimeSeriesPointDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StringLengthConstraint.md b/docs/v1/models/StringLengthConstraint.md deleted file mode 100644 index 5a475b51..00000000 --- a/docs/v1/models/StringLengthConstraint.md +++ /dev/null @@ -1,17 +0,0 @@ -# StringLengthConstraint - -The parameter value must have a length within the defined range. -*This range is always inclusive.* - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | Optional[Any] | No | Less than | -**lte** | Optional[Any] | No | Less than or equal | -**gt** | Optional[Any] | No | Greater than | -**gte** | Optional[Any] | No | Greater than or equal | -**type** | Literal["stringLength"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StringLengthConstraintDict.md b/docs/v1/models/StringLengthConstraintDict.md deleted file mode 100644 index 7568b60c..00000000 --- a/docs/v1/models/StringLengthConstraintDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# StringLengthConstraintDict - -The parameter value must have a length within the defined range. -*This range is always inclusive.* - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Less than | -**lte** | NotRequired[Any] | No | Less than or equal | -**gt** | NotRequired[Any] | No | Greater than | -**gte** | NotRequired[Any] | No | Greater than or equal | -**type** | Literal["stringLength"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StringRegexMatchConstraint.md b/docs/v1/models/StringRegexMatchConstraint.md deleted file mode 100644 index ad5042e3..00000000 --- a/docs/v1/models/StringRegexMatchConstraint.md +++ /dev/null @@ -1,14 +0,0 @@ -# StringRegexMatchConstraint - -The parameter value must match a predefined regular expression. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**regex** | StrictStr | Yes | The regular expression configured in the **Ontology Manager**. | -**configured_failure_message** | Optional[StrictStr] | No | The message indicating that the regular expression was not matched. This is configured per parameter in the **Ontology Manager**. | -**type** | Literal["stringRegexMatch"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StringRegexMatchConstraintDict.md b/docs/v1/models/StringRegexMatchConstraintDict.md deleted file mode 100644 index 5aa3ff21..00000000 --- a/docs/v1/models/StringRegexMatchConstraintDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# StringRegexMatchConstraintDict - -The parameter value must match a predefined regular expression. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**regex** | StrictStr | Yes | The regular expression configured in the **Ontology Manager**. | -**configuredFailureMessage** | NotRequired[StrictStr] | No | The message indicating that the regular expression was not matched. This is configured per parameter in the **Ontology Manager**. | -**type** | Literal["stringRegexMatch"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StringType.md b/docs/v1/models/StringType.md deleted file mode 100644 index 54f60e77..00000000 --- a/docs/v1/models/StringType.md +++ /dev/null @@ -1,11 +0,0 @@ -# StringType - -StringType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["string"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StringTypeDict.md b/docs/v1/models/StringTypeDict.md deleted file mode 100644 index 9f536a32..00000000 --- a/docs/v1/models/StringTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# StringTypeDict - -StringType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["string"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/StructFieldName.md b/docs/v1/models/StructFieldName.md deleted file mode 100644 index 5894ce91..00000000 --- a/docs/v1/models/StructFieldName.md +++ /dev/null @@ -1,12 +0,0 @@ -# StructFieldName - -The name of a field in a `Struct`. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SubmissionCriteriaEvaluation.md b/docs/v1/models/SubmissionCriteriaEvaluation.md deleted file mode 100644 index faf88b6f..00000000 --- a/docs/v1/models/SubmissionCriteriaEvaluation.md +++ /dev/null @@ -1,15 +0,0 @@ -# SubmissionCriteriaEvaluation - -Contains the status of the **submission criteria**. -**Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. -These are configured in the **Ontology Manager**. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**configured_failure_message** | Optional[StrictStr] | No | The message indicating one of the **submission criteria** was not satisfied. This is configured per **submission criteria** in the **Ontology Manager**. | -**result** | ValidationResult | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SubmissionCriteriaEvaluationDict.md b/docs/v1/models/SubmissionCriteriaEvaluationDict.md deleted file mode 100644 index 02105d32..00000000 --- a/docs/v1/models/SubmissionCriteriaEvaluationDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# SubmissionCriteriaEvaluationDict - -Contains the status of the **submission criteria**. -**Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. -These are configured in the **Ontology Manager**. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**configuredFailureMessage** | NotRequired[StrictStr] | No | The message indicating one of the **submission criteria** was not satisfied. This is configured per **submission criteria** in the **Ontology Manager**. | -**result** | ValidationResult | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SubscriptionClosed.md b/docs/v1/models/SubscriptionClosed.md deleted file mode 100644 index 7a0a7319..00000000 --- a/docs/v1/models/SubscriptionClosed.md +++ /dev/null @@ -1,14 +0,0 @@ -# SubscriptionClosed - -The subscription has been closed due to an irrecoverable error during its lifecycle. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**cause** | SubscriptionClosureCause | Yes | | -**type** | Literal["subscriptionClosed"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SubscriptionClosedDict.md b/docs/v1/models/SubscriptionClosedDict.md deleted file mode 100644 index 34e59f92..00000000 --- a/docs/v1/models/SubscriptionClosedDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# SubscriptionClosedDict - -The subscription has been closed due to an irrecoverable error during its lifecycle. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**cause** | SubscriptionClosureCauseDict | Yes | | -**type** | Literal["subscriptionClosed"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SubscriptionClosureCause.md b/docs/v1/models/SubscriptionClosureCause.md deleted file mode 100644 index ecb8c86b..00000000 --- a/docs/v1/models/SubscriptionClosureCause.md +++ /dev/null @@ -1,16 +0,0 @@ -# SubscriptionClosureCause - -SubscriptionClosureCause - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[Error](Error.md) | error -[Reason](Reason.md) | reason - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SubscriptionClosureCauseDict.md b/docs/v1/models/SubscriptionClosureCauseDict.md deleted file mode 100644 index c884a2ae..00000000 --- a/docs/v1/models/SubscriptionClosureCauseDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# SubscriptionClosureCauseDict - -SubscriptionClosureCause - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ErrorDict](ErrorDict.md) | error -[ReasonDict](ReasonDict.md) | reason - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SubscriptionError.md b/docs/v1/models/SubscriptionError.md deleted file mode 100644 index 0f9eabf3..00000000 --- a/docs/v1/models/SubscriptionError.md +++ /dev/null @@ -1,12 +0,0 @@ -# SubscriptionError - -SubscriptionError - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**errors** | List[Error] | Yes | | -**type** | Literal["error"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SubscriptionErrorDict.md b/docs/v1/models/SubscriptionErrorDict.md deleted file mode 100644 index 9fafae58..00000000 --- a/docs/v1/models/SubscriptionErrorDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SubscriptionErrorDict - -SubscriptionError - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**errors** | List[ErrorDict] | Yes | | -**type** | Literal["error"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SubscriptionId.md b/docs/v1/models/SubscriptionId.md deleted file mode 100644 index ce654a3a..00000000 --- a/docs/v1/models/SubscriptionId.md +++ /dev/null @@ -1,11 +0,0 @@ -# SubscriptionId - -A unique identifier used to associate subscription requests with responses. - -## Type -```python -UUID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SubscriptionSuccess.md b/docs/v1/models/SubscriptionSuccess.md deleted file mode 100644 index 8c2488d2..00000000 --- a/docs/v1/models/SubscriptionSuccess.md +++ /dev/null @@ -1,12 +0,0 @@ -# SubscriptionSuccess - -SubscriptionSuccess - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**type** | Literal["success"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SubscriptionSuccessDict.md b/docs/v1/models/SubscriptionSuccessDict.md deleted file mode 100644 index 83315775..00000000 --- a/docs/v1/models/SubscriptionSuccessDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SubscriptionSuccessDict - -SubscriptionSuccess - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**type** | Literal["success"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SumAggregation.md b/docs/v1/models/SumAggregation.md deleted file mode 100644 index 2d82cfd8..00000000 --- a/docs/v1/models/SumAggregation.md +++ /dev/null @@ -1,13 +0,0 @@ -# SumAggregation - -Computes the sum of values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**type** | Literal["sum"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SumAggregationDict.md b/docs/v1/models/SumAggregationDict.md deleted file mode 100644 index 178e61fc..00000000 --- a/docs/v1/models/SumAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SumAggregationDict - -Computes the sum of values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["sum"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SumAggregationV2.md b/docs/v1/models/SumAggregationV2.md deleted file mode 100644 index ec527a4d..00000000 --- a/docs/v1/models/SumAggregationV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# SumAggregationV2 - -Computes the sum of values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["sum"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SumAggregationV2Dict.md b/docs/v1/models/SumAggregationV2Dict.md deleted file mode 100644 index 0ca62bcf..00000000 --- a/docs/v1/models/SumAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# SumAggregationV2Dict - -Computes the sum of values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["sum"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SyncApplyActionResponseV2.md b/docs/v1/models/SyncApplyActionResponseV2.md deleted file mode 100644 index 7063d8be..00000000 --- a/docs/v1/models/SyncApplyActionResponseV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# SyncApplyActionResponseV2 - -SyncApplyActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**validation** | Optional[ValidateActionResponseV2] | No | | -**edits** | Optional[ActionResults] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/SyncApplyActionResponseV2Dict.md b/docs/v1/models/SyncApplyActionResponseV2Dict.md deleted file mode 100644 index 37b41dd4..00000000 --- a/docs/v1/models/SyncApplyActionResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SyncApplyActionResponseV2Dict - -SyncApplyActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**validation** | NotRequired[ValidateActionResponseV2Dict] | No | | -**edits** | NotRequired[ActionResultsDict] | No | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TableExportFormat.md b/docs/v1/models/TableExportFormat.md deleted file mode 100644 index eeb5c6f8..00000000 --- a/docs/v1/models/TableExportFormat.md +++ /dev/null @@ -1,12 +0,0 @@ -# TableExportFormat - -Format for tabular dataset export. - - -| **Value** | -| --------- | -| `"ARROW"` | -| `"CSV"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ThreeDimensionalAggregation.md b/docs/v1/models/ThreeDimensionalAggregation.md deleted file mode 100644 index 46b71d9a..00000000 --- a/docs/v1/models/ThreeDimensionalAggregation.md +++ /dev/null @@ -1,13 +0,0 @@ -# ThreeDimensionalAggregation - -ThreeDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key_type** | QueryAggregationKeyType | Yes | | -**value_type** | TwoDimensionalAggregation | Yes | | -**type** | Literal["threeDimensionalAggregation"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ThreeDimensionalAggregationDict.md b/docs/v1/models/ThreeDimensionalAggregationDict.md deleted file mode 100644 index 30c71674..00000000 --- a/docs/v1/models/ThreeDimensionalAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ThreeDimensionalAggregationDict - -ThreeDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyType** | QueryAggregationKeyTypeDict | Yes | | -**valueType** | TwoDimensionalAggregationDict | Yes | | -**type** | Literal["threeDimensionalAggregation"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TimeRange.md b/docs/v1/models/TimeRange.md deleted file mode 100644 index 3f2ca9f0..00000000 --- a/docs/v1/models/TimeRange.md +++ /dev/null @@ -1,16 +0,0 @@ -# TimeRange - -An absolute or relative range for a time series query. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AbsoluteTimeRange](AbsoluteTimeRange.md) | absolute -[RelativeTimeRange](RelativeTimeRange.md) | relative - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TimeRangeDict.md b/docs/v1/models/TimeRangeDict.md deleted file mode 100644 index f7a225e1..00000000 --- a/docs/v1/models/TimeRangeDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# TimeRangeDict - -An absolute or relative range for a time series query. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AbsoluteTimeRangeDict](AbsoluteTimeRangeDict.md) | absolute -[RelativeTimeRangeDict](RelativeTimeRangeDict.md) | relative - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TimeSeriesItemType.md b/docs/v1/models/TimeSeriesItemType.md deleted file mode 100644 index 3c94cb7c..00000000 --- a/docs/v1/models/TimeSeriesItemType.md +++ /dev/null @@ -1,17 +0,0 @@ -# TimeSeriesItemType - -A union of the types supported by time series properties. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[DoubleType](DoubleType.md) | double -[StringType](StringType.md) | string - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TimeSeriesItemTypeDict.md b/docs/v1/models/TimeSeriesItemTypeDict.md deleted file mode 100644 index cdac1a65..00000000 --- a/docs/v1/models/TimeSeriesItemTypeDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# TimeSeriesItemTypeDict - -A union of the types supported by time series properties. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[DoubleTypeDict](DoubleTypeDict.md) | double -[StringTypeDict](StringTypeDict.md) | string - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TimeSeriesPoint.md b/docs/v1/models/TimeSeriesPoint.md deleted file mode 100644 index e0cce6f7..00000000 --- a/docs/v1/models/TimeSeriesPoint.md +++ /dev/null @@ -1,13 +0,0 @@ -# TimeSeriesPoint - -A time and value pair. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**time** | datetime | Yes | An ISO 8601 timestamp | -**value** | Any | Yes | An object which is either an enum String or a double number. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TimeSeriesPointDict.md b/docs/v1/models/TimeSeriesPointDict.md deleted file mode 100644 index d2296f08..00000000 --- a/docs/v1/models/TimeSeriesPointDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# TimeSeriesPointDict - -A time and value pair. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**time** | datetime | Yes | An ISO 8601 timestamp | -**value** | Any | Yes | An object which is either an enum String or a double number. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TimeUnit.md b/docs/v1/models/TimeUnit.md deleted file mode 100644 index 8472d985..00000000 --- a/docs/v1/models/TimeUnit.md +++ /dev/null @@ -1,18 +0,0 @@ -# TimeUnit - -TimeUnit - -| **Value** | -| --------- | -| `"MILLISECONDS"` | -| `"SECONDS"` | -| `"MINUTES"` | -| `"HOURS"` | -| `"DAYS"` | -| `"WEEKS"` | -| `"MONTHS"` | -| `"YEARS"` | -| `"QUARTERS"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TimeseriesType.md b/docs/v1/models/TimeseriesType.md deleted file mode 100644 index 720f078c..00000000 --- a/docs/v1/models/TimeseriesType.md +++ /dev/null @@ -1,12 +0,0 @@ -# TimeseriesType - -TimeseriesType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**item_type** | TimeSeriesItemType | Yes | | -**type** | Literal["timeseries"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TimeseriesTypeDict.md b/docs/v1/models/TimeseriesTypeDict.md deleted file mode 100644 index 2cb678b7..00000000 --- a/docs/v1/models/TimeseriesTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# TimeseriesTypeDict - -TimeseriesType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**itemType** | TimeSeriesItemTypeDict | Yes | | -**type** | Literal["timeseries"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TimestampType.md b/docs/v1/models/TimestampType.md deleted file mode 100644 index 4d1f7b26..00000000 --- a/docs/v1/models/TimestampType.md +++ /dev/null @@ -1,11 +0,0 @@ -# TimestampType - -TimestampType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["timestamp"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TimestampTypeDict.md b/docs/v1/models/TimestampTypeDict.md deleted file mode 100644 index 3de412a8..00000000 --- a/docs/v1/models/TimestampTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# TimestampTypeDict - -TimestampType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["timestamp"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TotalCount.md b/docs/v1/models/TotalCount.md deleted file mode 100644 index 7caa82b1..00000000 --- a/docs/v1/models/TotalCount.md +++ /dev/null @@ -1,12 +0,0 @@ -# TotalCount - -The total number of items across all pages. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/Transaction.md b/docs/v1/models/Transaction.md deleted file mode 100644 index f1c2d2a2..00000000 --- a/docs/v1/models/Transaction.md +++ /dev/null @@ -1,16 +0,0 @@ -# Transaction - -An operation that modifies the files within a dataset. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | TransactionRid | Yes | | -**transaction_type** | TransactionType | Yes | | -**status** | TransactionStatus | Yes | | -**created_time** | datetime | Yes | The timestamp when the transaction was created, in ISO 8601 timestamp format. | -**closed_time** | Optional[datetime] | No | The timestamp when the transaction was closed, in ISO 8601 timestamp format. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TransactionDict.md b/docs/v1/models/TransactionDict.md deleted file mode 100644 index 039eeda1..00000000 --- a/docs/v1/models/TransactionDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# TransactionDict - -An operation that modifies the files within a dataset. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | TransactionRid | Yes | | -**transactionType** | TransactionType | Yes | | -**status** | TransactionStatus | Yes | | -**createdTime** | datetime | Yes | The timestamp when the transaction was created, in ISO 8601 timestamp format. | -**closedTime** | NotRequired[datetime] | No | The timestamp when the transaction was closed, in ISO 8601 timestamp format. | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TransactionRid.md b/docs/v1/models/TransactionRid.md deleted file mode 100644 index feac94bf..00000000 --- a/docs/v1/models/TransactionRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# TransactionRid - -The Resource Identifier (RID) of a Transaction. Example: `ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4`. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TransactionStatus.md b/docs/v1/models/TransactionStatus.md deleted file mode 100644 index 89bba325..00000000 --- a/docs/v1/models/TransactionStatus.md +++ /dev/null @@ -1,13 +0,0 @@ -# TransactionStatus - -The status of a Transaction. - - -| **Value** | -| --------- | -| `"ABORTED"` | -| `"COMMITTED"` | -| `"OPEN"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TransactionType.md b/docs/v1/models/TransactionType.md deleted file mode 100644 index 45768794..00000000 --- a/docs/v1/models/TransactionType.md +++ /dev/null @@ -1,14 +0,0 @@ -# TransactionType - -The type of a Transaction. - - -| **Value** | -| --------- | -| `"APPEND"` | -| `"UPDATE"` | -| `"SNAPSHOT"` | -| `"DELETE"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TwoDimensionalAggregation.md b/docs/v1/models/TwoDimensionalAggregation.md deleted file mode 100644 index 8737fe70..00000000 --- a/docs/v1/models/TwoDimensionalAggregation.md +++ /dev/null @@ -1,13 +0,0 @@ -# TwoDimensionalAggregation - -TwoDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key_type** | QueryAggregationKeyType | Yes | | -**value_type** | QueryAggregationValueType | Yes | | -**type** | Literal["twoDimensionalAggregation"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/TwoDimensionalAggregationDict.md b/docs/v1/models/TwoDimensionalAggregationDict.md deleted file mode 100644 index 0de329b9..00000000 --- a/docs/v1/models/TwoDimensionalAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# TwoDimensionalAggregationDict - -TwoDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyType** | QueryAggregationKeyTypeDict | Yes | | -**valueType** | QueryAggregationValueTypeDict | Yes | | -**type** | Literal["twoDimensionalAggregation"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/UnevaluableConstraint.md b/docs/v1/models/UnevaluableConstraint.md deleted file mode 100644 index ce9506d4..00000000 --- a/docs/v1/models/UnevaluableConstraint.md +++ /dev/null @@ -1,13 +0,0 @@ -# UnevaluableConstraint - -The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. -This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["unevaluable"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/UnevaluableConstraintDict.md b/docs/v1/models/UnevaluableConstraintDict.md deleted file mode 100644 index b1f3efc7..00000000 --- a/docs/v1/models/UnevaluableConstraintDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# UnevaluableConstraintDict - -The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. -This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["unevaluable"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/UnsupportedType.md b/docs/v1/models/UnsupportedType.md deleted file mode 100644 index a6f85b94..00000000 --- a/docs/v1/models/UnsupportedType.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnsupportedType - -UnsupportedType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**unsupported_type** | StrictStr | Yes | | -**type** | Literal["unsupported"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/UnsupportedTypeDict.md b/docs/v1/models/UnsupportedTypeDict.md deleted file mode 100644 index 3a774a4f..00000000 --- a/docs/v1/models/UnsupportedTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnsupportedTypeDict - -UnsupportedType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**unsupportedType** | StrictStr | Yes | | -**type** | Literal["unsupported"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/UpdatedTime.md b/docs/v1/models/UpdatedTime.md deleted file mode 100644 index e3cb241d..00000000 --- a/docs/v1/models/UpdatedTime.md +++ /dev/null @@ -1,12 +0,0 @@ -# UpdatedTime - -The time at which the resource was most recently updated. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/UserId.md b/docs/v1/models/UserId.md deleted file mode 100644 index bf50e3b4..00000000 --- a/docs/v1/models/UserId.md +++ /dev/null @@ -1,12 +0,0 @@ -# UserId - -A Foundry User ID. - - -## Type -```python -UUID -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ValidateActionRequest.md b/docs/v1/models/ValidateActionRequest.md deleted file mode 100644 index 654e40a9..00000000 --- a/docs/v1/models/ValidateActionRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValidateActionRequest - -ValidateActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ValidateActionRequestDict.md b/docs/v1/models/ValidateActionRequestDict.md deleted file mode 100644 index d3b8cd22..00000000 --- a/docs/v1/models/ValidateActionRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValidateActionRequestDict - -ValidateActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ValidateActionResponse.md b/docs/v1/models/ValidateActionResponse.md deleted file mode 100644 index ff0ed9ce..00000000 --- a/docs/v1/models/ValidateActionResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# ValidateActionResponse - -ValidateActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**submission_criteria** | List[SubmissionCriteriaEvaluation] | Yes | | -**parameters** | Dict[ParameterId, ParameterEvaluationResult] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ValidateActionResponseDict.md b/docs/v1/models/ValidateActionResponseDict.md deleted file mode 100644 index c41ce6f9..00000000 --- a/docs/v1/models/ValidateActionResponseDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ValidateActionResponseDict - -ValidateActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**submissionCriteria** | List[SubmissionCriteriaEvaluationDict] | Yes | | -**parameters** | Dict[ParameterId, ParameterEvaluationResultDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ValidateActionResponseV2.md b/docs/v1/models/ValidateActionResponseV2.md deleted file mode 100644 index 91a4ec9f..00000000 --- a/docs/v1/models/ValidateActionResponseV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# ValidateActionResponseV2 - -ValidateActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**submission_criteria** | List[SubmissionCriteriaEvaluation] | Yes | | -**parameters** | Dict[ParameterId, ParameterEvaluationResult] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ValidateActionResponseV2Dict.md b/docs/v1/models/ValidateActionResponseV2Dict.md deleted file mode 100644 index fa6a7dc0..00000000 --- a/docs/v1/models/ValidateActionResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ValidateActionResponseV2Dict - -ValidateActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**submissionCriteria** | List[SubmissionCriteriaEvaluationDict] | Yes | | -**parameters** | Dict[ParameterId, ParameterEvaluationResultDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ValidationResult.md b/docs/v1/models/ValidationResult.md deleted file mode 100644 index 3736e817..00000000 --- a/docs/v1/models/ValidationResult.md +++ /dev/null @@ -1,12 +0,0 @@ -# ValidationResult - -Represents the state of a validation. - - -| **Value** | -| --------- | -| `"VALID"` | -| `"INVALID"` | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/ValueType.md b/docs/v1/models/ValueType.md deleted file mode 100644 index 427bcc1e..00000000 --- a/docs/v1/models/ValueType.md +++ /dev/null @@ -1,33 +0,0 @@ -# ValueType - -A string indicating the type of each data value. Note that these types can be nested, for example an array of -structs. - -| Type | JSON value | -|---------------------|-------------------------------------------------------------------------------------------------------------------| -| Array | `Array`, where `T` is the type of the array elements, e.g. `Array`. | -| Attachment | `Attachment` | -| Boolean | `Boolean` | -| Byte | `Byte` | -| Date | `LocalDate` | -| Decimal | `Decimal` | -| Double | `Double` | -| Float | `Float` | -| Integer | `Integer` | -| Long | `Long` | -| Marking | `Marking` | -| OntologyObject | `OntologyObject` where `T` is the API name of the referenced object type. | -| Short | `Short` | -| String | `String` | -| Struct | `Struct` where `T` contains field name and type pairs, e.g. `Struct<{ firstName: String, lastName: string }>` | -| Timeseries | `TimeSeries` where `T` is either `String` for an enum series or `Double` for a numeric series. | -| Timestamp | `Timestamp` | - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/WithinBoundingBoxPoint.md b/docs/v1/models/WithinBoundingBoxPoint.md deleted file mode 100644 index 589d87e5..00000000 --- a/docs/v1/models/WithinBoundingBoxPoint.md +++ /dev/null @@ -1,11 +0,0 @@ -# WithinBoundingBoxPoint - -WithinBoundingBoxPoint - -## Type -```python -GeoPoint -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/WithinBoundingBoxPointDict.md b/docs/v1/models/WithinBoundingBoxPointDict.md deleted file mode 100644 index 8eecf0da..00000000 --- a/docs/v1/models/WithinBoundingBoxPointDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# WithinBoundingBoxPointDict - -WithinBoundingBoxPoint - -## Type -```python -GeoPointDict -``` - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/WithinBoundingBoxQuery.md b/docs/v1/models/WithinBoundingBoxQuery.md deleted file mode 100644 index 98535846..00000000 --- a/docs/v1/models/WithinBoundingBoxQuery.md +++ /dev/null @@ -1,14 +0,0 @@ -# WithinBoundingBoxQuery - -Returns objects where the specified field contains a point within the bounding box provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | BoundingBoxValue | Yes | | -**type** | Literal["withinBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/WithinBoundingBoxQueryDict.md b/docs/v1/models/WithinBoundingBoxQueryDict.md deleted file mode 100644 index 41aabd10..00000000 --- a/docs/v1/models/WithinBoundingBoxQueryDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# WithinBoundingBoxQueryDict - -Returns objects where the specified field contains a point within the bounding box provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | BoundingBoxValueDict | Yes | | -**type** | Literal["withinBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/WithinDistanceOfQuery.md b/docs/v1/models/WithinDistanceOfQuery.md deleted file mode 100644 index dbdbed5b..00000000 --- a/docs/v1/models/WithinDistanceOfQuery.md +++ /dev/null @@ -1,14 +0,0 @@ -# WithinDistanceOfQuery - -Returns objects where the specified field contains a point within the distance provided of the center point. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | CenterPoint | Yes | | -**type** | Literal["withinDistanceOf"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/WithinDistanceOfQueryDict.md b/docs/v1/models/WithinDistanceOfQueryDict.md deleted file mode 100644 index 8d12d573..00000000 --- a/docs/v1/models/WithinDistanceOfQueryDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# WithinDistanceOfQueryDict - -Returns objects where the specified field contains a point within the distance provided of the center point. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | CenterPointDict | Yes | | -**type** | Literal["withinDistanceOf"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/WithinPolygonQuery.md b/docs/v1/models/WithinPolygonQuery.md deleted file mode 100644 index 0fa817f0..00000000 --- a/docs/v1/models/WithinPolygonQuery.md +++ /dev/null @@ -1,14 +0,0 @@ -# WithinPolygonQuery - -Returns objects where the specified field contains a point within the polygon provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PolygonValue | Yes | | -**type** | Literal["withinPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/models/WithinPolygonQueryDict.md b/docs/v1/models/WithinPolygonQueryDict.md deleted file mode 100644 index fa83a5e3..00000000 --- a/docs/v1/models/WithinPolygonQueryDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# WithinPolygonQueryDict - -Returns objects where the specified field contains a point within the polygon provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PolygonValueDict | Yes | | -**type** | Literal["withinPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v1-link) [[Back to API list]](../../../README.md#apis-v1-link) [[Back to README]](../../../README.md) diff --git a/docs/v1/namespaces/Datasets/Branch.md b/docs/v1/namespaces/Datasets/Branch.md deleted file mode 100644 index 5d5bb35a..00000000 --- a/docs/v1/namespaces/Datasets/Branch.md +++ /dev/null @@ -1,309 +0,0 @@ -# Branch - -Method | HTTP request | -------------- | ------------- | -[**create**](#create) | **POST** /v1/datasets/{datasetRid}/branches | -[**delete**](#delete) | **DELETE** /v1/datasets/{datasetRid}/branches/{branchId} | -[**get**](#get) | **GET** /v1/datasets/{datasetRid}/branches/{branchId} | -[**list**](#list) | **GET** /v1/datasets/{datasetRid}/branches | -[**page**](#page) | **GET** /v1/datasets/{datasetRid}/branches | - -# **create** -Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**create_branch_request** | Union[CreateBranchRequest, CreateBranchRequestDict] | Body of the request | | - -### Return type -**Branch** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" - -# Union[CreateBranchRequest, CreateBranchRequestDict] | Body of the request -create_branch_request = {"branchId": "my-branch"} - - -try: - api_response = foundry_client.datasets.Dataset.Branch.create( - dataset_rid, - create_branch_request, - ) - print("The create response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Branch.create: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Branch | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **delete** -Deletes the Branch with the given BranchId. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**branch_id** | BranchId | branchId | | - -### Return type -**None** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" - -# BranchId | branchId -branch_id = "my-branch" - - -try: - api_response = foundry_client.datasets.Dataset.Branch.delete( - dataset_rid, - branch_id, - ) - print("The delete response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Branch.delete: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**204** | None | Branch deleted. | None | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **get** -Get a Branch of a Dataset. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**branch_id** | BranchId | branchId | | - -### Return type -**Branch** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" - -# BranchId | branchId -branch_id = "master" - - -try: - api_response = foundry_client.datasets.Dataset.Branch.get( - dataset_rid, - branch_id, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Branch.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Branch | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **list** -Lists the Branches of a Dataset. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**page_size** | Optional[PageSize] | pageSize | [optional] | - -### Return type -**ResourceIterator[Branch]** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" - -# Optional[PageSize] | pageSize -page_size = None - - -try: - for branch in foundry_client.datasets.Dataset.Branch.list( - dataset_rid, - page_size=page_size, - ): - pprint(branch) -except PalantirRPCException as e: - print("HTTP error when calling Branch.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListBranchesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **page** -Lists the Branches of a Dataset. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | - -### Return type -**ListBranchesResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - - -try: - api_response = foundry_client.datasets.Dataset.Branch.page( - dataset_rid, - page_size=page_size, - page_token=page_token, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Branch.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListBranchesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v1/namespaces/Datasets/Dataset.md b/docs/v1/namespaces/Datasets/Dataset.md deleted file mode 100644 index 8ec0cbab..00000000 --- a/docs/v1/namespaces/Datasets/Dataset.md +++ /dev/null @@ -1,466 +0,0 @@ -# Dataset - -Method | HTTP request | -------------- | ------------- | -[**create**](#create) | **POST** /v1/datasets | -[**delete_schema**](#delete_schema) | **DELETE** /v1/datasets/{datasetRid}/schema | -[**get**](#get) | **GET** /v1/datasets/{datasetRid} | -[**get_schema**](#get_schema) | **GET** /v1/datasets/{datasetRid}/schema | -[**read**](#read) | **GET** /v1/datasets/{datasetRid}/readTable | -[**replace_schema**](#replace_schema) | **PUT** /v1/datasets/{datasetRid}/schema | - -# **create** -Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**create_dataset_request** | Union[CreateDatasetRequest, CreateDatasetRequestDict] | Body of the request | | - -### Return type -**Dataset** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# Union[CreateDatasetRequest, CreateDatasetRequestDict] | Body of the request -create_dataset_request = { - "name": "My Dataset", - "parentFolderRid": "ri.foundry.main.folder.bfe58487-4c56-4c58-aba7-25defd6163c4", -} - - -try: - api_response = foundry_client.datasets.Dataset.create( - create_dataset_request, - ) - print("The create response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Dataset.create: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Dataset | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **delete_schema** -Deletes the Schema from a Dataset and Branch. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**branch_id** | Optional[BranchId] | branchId | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | -**transaction_rid** | Optional[TransactionRid] | transactionRid | [optional] | - -### Return type -**None** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# Optional[BranchId] | branchId -branch_id = None - -# Optional[PreviewMode] | preview -preview = true - -# Optional[TransactionRid] | transactionRid -transaction_rid = None - - -try: - api_response = foundry_client.datasets.Dataset.delete_schema( - dataset_rid, - branch_id=branch_id, - preview=preview, - transaction_rid=transaction_rid, - ) - print("The delete_schema response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Dataset.delete_schema: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**204** | None | Schema deleted. | None | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **get** -Gets the Dataset with the given DatasetRid. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | - -### Return type -**Dataset** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" - - -try: - api_response = foundry_client.datasets.Dataset.get( - dataset_rid, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Dataset.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Dataset | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **get_schema** -Retrieves the Schema for a Dataset and Branch, if it exists. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**branch_id** | Optional[BranchId] | branchId | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | -**transaction_rid** | Optional[TransactionRid] | transactionRid | [optional] | - -### Return type -**Any** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# Optional[BranchId] | branchId -branch_id = None - -# Optional[PreviewMode] | preview -preview = true - -# Optional[TransactionRid] | transactionRid -transaction_rid = None - - -try: - api_response = foundry_client.datasets.Dataset.get_schema( - dataset_rid, - branch_id=branch_id, - preview=preview, - transaction_rid=transaction_rid, - ) - print("The get_schema response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Dataset.get_schema: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Any | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **read** -Gets the content of a dataset as a table in the specified format. - -This endpoint currently does not support views (Virtual datasets composed of other datasets). - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**format** | TableExportFormat | format | | -**branch_id** | Optional[BranchId] | branchId | [optional] | -**columns** | Optional[List[StrictStr]] | columns | [optional] | -**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | -**row_limit** | Optional[StrictInt] | rowLimit | [optional] | -**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | - -### Return type -**bytes** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# TableExportFormat | format -format = "CSV" - -# Optional[BranchId] | branchId -branch_id = None - -# Optional[List[StrictStr]] | columns -columns = None - -# Optional[TransactionRid] | endTransactionRid -end_transaction_rid = None - -# Optional[StrictInt] | rowLimit -row_limit = None - -# Optional[TransactionRid] | startTransactionRid -start_transaction_rid = None - - -try: - api_response = foundry_client.datasets.Dataset.read( - dataset_rid, - format=format, - branch_id=branch_id, - columns=columns, - end_transaction_rid=end_transaction_rid, - row_limit=row_limit, - start_transaction_rid=start_transaction_rid, - ) - print("The read response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Dataset.read: %s\n" % e) - -``` - -### Read a Foundry Dataset as a CSV - -```python -import foundry -from foundry.models import TableExportFormat -from foundry import PalantirRPCException - -foundry_client = foundry.FoundryV1Client(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -try: - api_response = foundry_client.datasets.Dataset.read( - dataset_rid="...", format="CSV", columns=[...] - ) - - with open("my_table.csv", "wb") as f: - f.write(api_response) -except PalantirRPCException as e: - print("PalantirRPCException when calling DatasetsApiServiceApi -> read: %s\n" % e) -``` - -### Read a Foundry Dataset into a Pandas DataFrame - -> [!IMPORTANT] -> For this example to work, you will need to have `pyarrow` installed in your Python environment. - -```python -import foundry -from foundry.models import TableExportFormat -from foundry import PalantirRPCException -import pyarrow as pa - -foundry_client = foundry.FoundryV1Client(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -try: - api_response = foundry_client.datasets.Dataset.read(dataset_rid="...", format="ARROW", columns=[...]) - df = pa.ipc.open_stream(api_response).read_all().to_pandas() - print(df) -except Exception as e: - print("Exception when calling DatasetsApiServiceApi -> read: %s\n" % e) -``` - -``` - id word length double boolean -0 0 A 1.0 11.878200 1 -1 1 a 1.0 11.578800 0 -2 2 aa 2.0 15.738500 1 -3 3 aal 3.0 6.643900 0 -4 4 aalii 5.0 2.017730 1 -... ... ... ... ... ... -235881 235881 zythem 6.0 19.427400 1 -235882 235882 Zythia 6.0 14.397100 1 -235883 235883 zythum 6.0 3.385820 0 -235884 235884 Zyzomys 7.0 6.208830 1 -235885 235885 Zyzzogeton 10.0 0.947821 0 - -[235886 rows x 5 columns] -``` - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | bytes | The content stream. | */* | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **replace_schema** -Puts a Schema on an existing Dataset and Branch. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**body** | Any | Body of the request | | -**branch_id** | Optional[BranchId] | branchId | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**None** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# Any | Body of the request -body = None - -# Optional[BranchId] | branchId -branch_id = None - -# Optional[PreviewMode] | preview -preview = true - - -try: - api_response = foundry_client.datasets.Dataset.replace_schema( - dataset_rid, - body, - branch_id=branch_id, - preview=preview, - ) - print("The replace_schema response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Dataset.replace_schema: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**204** | None | | None | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v1/namespaces/Datasets/File.md b/docs/v1/namespaces/Datasets/File.md deleted file mode 100644 index d7e067a1..00000000 --- a/docs/v1/namespaces/Datasets/File.md +++ /dev/null @@ -1,598 +0,0 @@ -# File - -Method | HTTP request | -------------- | ------------- | -[**delete**](#delete) | **DELETE** /v1/datasets/{datasetRid}/files/{filePath} | -[**get**](#get) | **GET** /v1/datasets/{datasetRid}/files/{filePath} | -[**list**](#list) | **GET** /v1/datasets/{datasetRid}/files | -[**page**](#page) | **GET** /v1/datasets/{datasetRid}/files | -[**read**](#read) | **GET** /v1/datasets/{datasetRid}/files/{filePath}/content | -[**upload**](#upload) | **POST** /v1/datasets/{datasetRid}/files:upload | - -# **delete** -Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default -branch - `master` for most enrollments. The file will still be visible on historical views. - -#### Advanced Usage - -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - -To **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction -will be created and committed on this branch. - -To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier -as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a -single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to -open a transaction. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**file_path** | FilePath | filePath | | -**branch_id** | Optional[BranchId] | branchId | [optional] | -**transaction_rid** | Optional[TransactionRid] | transactionRid | [optional] | - -### Return type -**None** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" - -# FilePath | filePath -file_path = "q3-data%2fmy-file.csv" - -# Optional[BranchId] | branchId -branch_id = None - -# Optional[TransactionRid] | transactionRid -transaction_rid = None - - -try: - api_response = foundry_client.datasets.Dataset.File.delete( - dataset_rid, - file_path, - branch_id=branch_id, - transaction_rid=transaction_rid, - ) - print("The delete response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling File.delete: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**204** | None | File deleted. | None | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **get** -Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest -view of the default branch - `master` for most enrollments. - -#### Advanced Usage - -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - -To **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will -retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest -ancestor transaction of the branch if there are no snapshot transactions. - -To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier -as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot -transaction, or the earliest ancestor transaction if there are no snapshot transactions. - -To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's -resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. -This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the -`endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path. - -To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the -`startTransactionRid` and `endTransactionRid`. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**file_path** | FilePath | filePath | | -**branch_id** | Optional[BranchId] | branchId | [optional] | -**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | -**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | - -### Return type -**File** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" - -# FilePath | filePath -file_path = "q3-data%2fmy-file.csv" - -# Optional[BranchId] | branchId -branch_id = None - -# Optional[TransactionRid] | endTransactionRid -end_transaction_rid = None - -# Optional[TransactionRid] | startTransactionRid -start_transaction_rid = None - - -try: - api_response = foundry_client.datasets.Dataset.File.get( - dataset_rid, - file_path, - branch_id=branch_id, - end_transaction_rid=end_transaction_rid, - start_transaction_rid=start_transaction_rid, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling File.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | File | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **list** -Lists Files contained in a Dataset. By default files are listed on the latest view of the default -branch - `master` for most enrollments. - -#### Advanced Usage - -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - -To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most -recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the -branch if there are no snapshot transactions. - -To **list files on the resolved view of a transaction** specify the Transaction's resource identifier -as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot -transaction, or the earliest ancestor transaction if there are no snapshot transactions. - -To **list files on the resolved view of a range of transactions** specify the the start transaction's resource -identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This -will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. -Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when -the start and end transactions do not belong to the same root-to-leaf path. - -To **list files on a specific transaction** specify the Transaction's resource identifier as both the -`startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that -Transaction. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**branch_id** | Optional[BranchId] | branchId | [optional] | -**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | - -### Return type -**ResourceIterator[File]** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# Optional[BranchId] | branchId -branch_id = None - -# Optional[TransactionRid] | endTransactionRid -end_transaction_rid = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[TransactionRid] | startTransactionRid -start_transaction_rid = None - - -try: - for file in foundry_client.datasets.Dataset.File.list( - dataset_rid, - branch_id=branch_id, - end_transaction_rid=end_transaction_rid, - page_size=page_size, - start_transaction_rid=start_transaction_rid, - ): - pprint(file) -except PalantirRPCException as e: - print("HTTP error when calling File.list: %s\n" % e) - -``` - -### Read the contents of a file from a dataset (by exploration / listing) - -```python -import foundry - -foundry_client = foundry.FoundryV1Client(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -result = foundry_client.datasets.Dataset.File.list(dataset_rid="...") - -if result.data: - file_path = result.data[0].path - - print(foundry_client.datasets.Dataset.File.read( - dataset_rid="...", file_path=file_path - )) -``` - -``` -b'Hello!' -``` - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListFilesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **page** -Lists Files contained in a Dataset. By default files are listed on the latest view of the default -branch - `master` for most enrollments. - -#### Advanced Usage - -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - -To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most -recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the -branch if there are no snapshot transactions. - -To **list files on the resolved view of a transaction** specify the Transaction's resource identifier -as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot -transaction, or the earliest ancestor transaction if there are no snapshot transactions. - -To **list files on the resolved view of a range of transactions** specify the the start transaction's resource -identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This -will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. -Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when -the start and end transactions do not belong to the same root-to-leaf path. - -To **list files on a specific transaction** specify the Transaction's resource identifier as both the -`startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that -Transaction. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**branch_id** | Optional[BranchId] | branchId | [optional] | -**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | -**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | - -### Return type -**ListFilesResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# Optional[BranchId] | branchId -branch_id = None - -# Optional[TransactionRid] | endTransactionRid -end_transaction_rid = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - -# Optional[TransactionRid] | startTransactionRid -start_transaction_rid = None - - -try: - api_response = foundry_client.datasets.Dataset.File.page( - dataset_rid, - branch_id=branch_id, - end_transaction_rid=end_transaction_rid, - page_size=page_size, - page_token=page_token, - start_transaction_rid=start_transaction_rid, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling File.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListFilesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **read** -Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest -view of the default branch - `master` for most enrollments. - -#### Advanced Usage - -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - -To **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will -retrieve the content for the most recent version of the file since the latest snapshot transaction, or the -earliest ancestor transaction of the branch if there are no snapshot transactions. - -To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier -as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest -snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions. - -To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's -resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. -This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the -`endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior -is undefined when the start and end transactions do not belong to the same root-to-leaf path. - -To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the -`startTransactionRid` and `endTransactionRid`. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**file_path** | FilePath | filePath | | -**branch_id** | Optional[BranchId] | branchId | [optional] | -**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | -**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | - -### Return type -**bytes** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# FilePath | filePath -file_path = "q3-data%2fmy-file.csv" - -# Optional[BranchId] | branchId -branch_id = None - -# Optional[TransactionRid] | endTransactionRid -end_transaction_rid = None - -# Optional[TransactionRid] | startTransactionRid -start_transaction_rid = None - - -try: - api_response = foundry_client.datasets.Dataset.File.read( - dataset_rid, - file_path, - branch_id=branch_id, - end_transaction_rid=end_transaction_rid, - start_transaction_rid=start_transaction_rid, - ) - print("The read response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling File.read: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | bytes | | */* | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **upload** -Uploads a File to an existing Dataset. -The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. - -By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments. -If the file already exists only the most recent version will be visible in the updated view. - -#### Advanced Usage - -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - -To **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will -be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this -default specify `transactionType` in addition to `branchId`. -See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. - -To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as -`transactionRid`. This is useful for uploading multiple files in a single transaction. -See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**body** | bytes | Body of the request | | -**file_path** | FilePath | filePath | | -**branch_id** | Optional[BranchId] | branchId | [optional] | -**transaction_rid** | Optional[TransactionRid] | transactionRid | [optional] | -**transaction_type** | Optional[TransactionType] | transactionType | [optional] | - -### Return type -**File** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# bytes | Body of the request -body = None - -# FilePath | filePath -file_path = "q3-data%2fmy-file.csv" - -# Optional[BranchId] | branchId -branch_id = None - -# Optional[TransactionRid] | transactionRid -transaction_rid = None - -# Optional[TransactionType] | transactionType -transaction_type = None - - -try: - api_response = foundry_client.datasets.Dataset.File.upload( - dataset_rid, - body, - file_path=file_path, - branch_id=branch_id, - transaction_rid=transaction_rid, - transaction_type=transaction_type, - ) - print("The upload response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling File.upload: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | File | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v1/namespaces/Datasets/Transaction.md b/docs/v1/namespaces/Datasets/Transaction.md deleted file mode 100644 index e93d5478..00000000 --- a/docs/v1/namespaces/Datasets/Transaction.md +++ /dev/null @@ -1,274 +0,0 @@ -# Transaction - -Method | HTTP request | -------------- | ------------- | -[**abort**](#abort) | **POST** /v1/datasets/{datasetRid}/transactions/{transactionRid}/abort | -[**commit**](#commit) | **POST** /v1/datasets/{datasetRid}/transactions/{transactionRid}/commit | -[**create**](#create) | **POST** /v1/datasets/{datasetRid}/transactions | -[**get**](#get) | **GET** /v1/datasets/{datasetRid}/transactions/{transactionRid} | - -# **abort** -Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is -not updated. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**transaction_rid** | TransactionRid | transactionRid | | - -### Return type -**Transaction** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" - -# TransactionRid | transactionRid -transaction_rid = "ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496" - - -try: - api_response = foundry_client.datasets.Dataset.Transaction.abort( - dataset_rid, - transaction_rid, - ) - print("The abort response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Transaction.abort: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Transaction | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **commit** -Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is -updated to point to the Transaction. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**transaction_rid** | TransactionRid | transactionRid | | - -### Return type -**Transaction** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" - -# TransactionRid | transactionRid -transaction_rid = "ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496" - - -try: - api_response = foundry_client.datasets.Dataset.Transaction.commit( - dataset_rid, - transaction_rid, - ) - print("The commit response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Transaction.commit: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Transaction | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **create** -Creates a Transaction on a Branch of a Dataset. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**create_transaction_request** | Union[CreateTransactionRequest, CreateTransactionRequestDict] | Body of the request | | -**branch_id** | Optional[BranchId] | branchId | [optional] | - -### Return type -**Transaction** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" - -# Union[CreateTransactionRequest, CreateTransactionRequestDict] | Body of the request -create_transaction_request = {"transactionType": "SNAPSHOT"} - -# Optional[BranchId] | branchId -branch_id = None - - -try: - api_response = foundry_client.datasets.Dataset.Transaction.create( - dataset_rid, - create_transaction_request, - branch_id=branch_id, - ) - print("The create response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Transaction.create: %s\n" % e) - -``` - -### Manipulate a Dataset within a Transaction - -```python -import foundry - -foundry_client = foundry.FoundryV1Client(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -transaction = foundry_client.datasets.Dataset.Transaction.create( - dataset_rid="...", - create_transaction_request={}, -) - -with open("my/path/to/file.txt", 'rb') as f: - foundry_client.datasets.Dataset.File.upload( - body=f.read(), - dataset_rid="....", - file_path="...", - transaction_rid=transaction.rid, - ) - -foundry_client.datasets.Dataset.Transaction.commit(dataset_rid="...", transaction_rid=transaction.rid) -``` - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Transaction | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **get** -Gets a Transaction of a Dataset. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**transaction_rid** | TransactionRid | transactionRid | | - -### Return type -**Transaction** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" - -# TransactionRid | transactionRid -transaction_rid = "ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496" - - -try: - api_response = foundry_client.datasets.Dataset.Transaction.get( - dataset_rid, - transaction_rid, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Transaction.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Transaction | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v1/namespaces/Ontologies/Action.md b/docs/v1/namespaces/Ontologies/Action.md deleted file mode 100644 index ca0229ce..00000000 --- a/docs/v1/namespaces/Ontologies/Action.md +++ /dev/null @@ -1,239 +0,0 @@ -# Action - -Method | HTTP request | -------------- | ------------- | -[**apply**](#apply) | **POST** /v1/ontologies/{ontologyRid}/actions/{actionType}/apply | -[**apply_batch**](#apply_batch) | **POST** /v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch | -[**validate**](#validate) | **POST** /v1/ontologies/{ontologyRid}/actions/{actionType}/validate | - -# **apply** -Applies an action using the given parameters. Changes to the Ontology are eventually consistent and may take -some time to be visible. - -Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by -this endpoint. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read api:ontologies-write`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**action_type** | ActionTypeApiName | actionType | | -**apply_action_request** | Union[ApplyActionRequest, ApplyActionRequestDict] | Body of the request | | - -### Return type -**ApplyActionResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ActionTypeApiName | actionType -action_type = "rename-employee" - -# Union[ApplyActionRequest, ApplyActionRequestDict] | Body of the request -apply_action_request = {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}} - - -try: - api_response = foundry_client.ontologies.Action.apply( - ontology_rid, - action_type, - apply_action_request, - ) - print("The apply response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Action.apply: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ApplyActionResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **apply_batch** -Applies multiple actions (of the same Action Type) using the given parameters. -Changes to the Ontology are eventually consistent and may take some time to be visible. - -Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not -call Functions may receive a higher limit. - -Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) and -[notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read api:ontologies-write`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**action_type** | ActionTypeApiName | actionType | | -**batch_apply_action_request** | Union[BatchApplyActionRequest, BatchApplyActionRequestDict] | Body of the request | | - -### Return type -**BatchApplyActionResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ActionTypeApiName | actionType -action_type = "rename-employee" - -# Union[BatchApplyActionRequest, BatchApplyActionRequestDict] | Body of the request -batch_apply_action_request = { - "requests": [ - {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}}, - {"parameters": {"id": 80061, "newName": "Joe Bloggs"}}, - ] -} - - -try: - api_response = foundry_client.ontologies.Action.apply_batch( - ontology_rid, - action_type, - batch_apply_action_request, - ) - print("The apply_batch response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Action.apply_batch: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | BatchApplyActionResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **validate** -Validates if an action can be run with the given set of parameters. -The response contains the evaluation of parameters and **submission criteria** -that determine if the request is `VALID` or `INVALID`. -For performance reasons, validations will not consider existing objects or other data in Foundry. -For example, the uniqueness of a primary key or the existence of a user ID will not be checked. -Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by -this endpoint. Unspecified parameters will be given a default value of `null`. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**action_type** | ActionTypeApiName | actionType | | -**validate_action_request** | Union[ValidateActionRequest, ValidateActionRequestDict] | Body of the request | | - -### Return type -**ValidateActionResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ActionTypeApiName | actionType -action_type = "rename-employee" - -# Union[ValidateActionRequest, ValidateActionRequestDict] | Body of the request -validate_action_request = { - "parameters": { - "id": "2", - "firstName": "Chuck", - "lastName": "Jones", - "age": 17, - "date": "2021-05-01", - "numbers": [1, 2, 3], - "hasObjectSet": true, - "objectSet": "ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623", - "reference": "Chuck", - "percentage": 41.3, - "differentObjectId": "2", - } -} - - -try: - api_response = foundry_client.ontologies.Action.validate( - ontology_rid, - action_type, - validate_action_request, - ) - print("The validate response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Action.validate: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ValidateActionResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v1/namespaces/Ontologies/ActionType.md b/docs/v1/namespaces/Ontologies/ActionType.md deleted file mode 100644 index 4998bbef..00000000 --- a/docs/v1/namespaces/Ontologies/ActionType.md +++ /dev/null @@ -1,195 +0,0 @@ -# ActionType - -Method | HTTP request | -------------- | ------------- | -[**get**](#get) | **GET** /v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName} | -[**list**](#list) | **GET** /v1/ontologies/{ontologyRid}/actionTypes | -[**page**](#page) | **GET** /v1/ontologies/{ontologyRid}/actionTypes | - -# **get** -Gets a specific action type with the given API name. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**action_type_api_name** | ActionTypeApiName | actionTypeApiName | | - -### Return type -**ActionType** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ActionTypeApiName | actionTypeApiName -action_type_api_name = "promote-employee" - - -try: - api_response = foundry_client.ontologies.Ontology.ActionType.get( - ontology_rid, - action_type_api_name, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling ActionType.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ActionType | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **list** -Lists the action types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**page_size** | Optional[PageSize] | pageSize | [optional] | - -### Return type -**ResourceIterator[ActionType]** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# Optional[PageSize] | pageSize -page_size = None - - -try: - for action_type in foundry_client.ontologies.Ontology.ActionType.list( - ontology_rid, - page_size=page_size, - ): - pprint(action_type) -except PalantirRPCException as e: - print("HTTP error when calling ActionType.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListActionTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **page** -Lists the action types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | - -### Return type -**ListActionTypesResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.ActionType.page( - ontology_rid, - page_size=page_size, - page_token=page_token, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling ActionType.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListActionTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v1/namespaces/Ontologies/ObjectType.md b/docs/v1/namespaces/Ontologies/ObjectType.md deleted file mode 100644 index 0e526ca3..00000000 --- a/docs/v1/namespaces/Ontologies/ObjectType.md +++ /dev/null @@ -1,399 +0,0 @@ -# ObjectType - -Method | HTTP request | -------------- | ------------- | -[**get**](#get) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType} | -[**get_outgoing_link_type**](#get_outgoing_link_type) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} | -[**list**](#list) | **GET** /v1/ontologies/{ontologyRid}/objectTypes | -[**list_outgoing_link_types**](#list_outgoing_link_types) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes | -[**page**](#page) | **GET** /v1/ontologies/{ontologyRid}/objectTypes | -[**page_outgoing_link_types**](#page_outgoing_link_types) | **GET** /v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes | - -# **get** -Gets a specific object type with the given API name. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**object_type** | ObjectTypeApiName | objectType | | - -### Return type -**ObjectType** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ObjectTypeApiName | objectType -object_type = "employee" - - -try: - api_response = foundry_client.ontologies.Ontology.ObjectType.get( - ontology_rid, - object_type, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling ObjectType.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ObjectType | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **get_outgoing_link_type** -Get an outgoing link for an object type. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**object_type** | ObjectTypeApiName | objectType | | -**link_type** | LinkTypeApiName | linkType | | - -### Return type -**LinkTypeSide** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ObjectTypeApiName | objectType -object_type = "Employee" - -# LinkTypeApiName | linkType -link_type = "directReport" - - -try: - api_response = foundry_client.ontologies.Ontology.ObjectType.get_outgoing_link_type( - ontology_rid, - object_type, - link_type, - ) - print("The get_outgoing_link_type response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling ObjectType.get_outgoing_link_type: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | LinkTypeSide | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **list** -Lists the object types for the given Ontology. - -Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are -more results available, at least one result will be present in the -response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**page_size** | Optional[PageSize] | pageSize | [optional] | - -### Return type -**ResourceIterator[ObjectType]** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# Optional[PageSize] | pageSize -page_size = None - - -try: - for object_type in foundry_client.ontologies.Ontology.ObjectType.list( - ontology_rid, - page_size=page_size, - ): - pprint(object_type) -except PalantirRPCException as e: - print("HTTP error when calling ObjectType.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListObjectTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **list_outgoing_link_types** -List the outgoing links for an object type. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**object_type** | ObjectTypeApiName | objectType | | -**page_size** | Optional[PageSize] | pageSize | [optional] | - -### Return type -**ResourceIterator[LinkTypeSide]** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ObjectTypeApiName | objectType -object_type = "Flight" - -# Optional[PageSize] | pageSize -page_size = None - - -try: - for object_type in foundry_client.ontologies.Ontology.ObjectType.list_outgoing_link_types( - ontology_rid, - object_type, - page_size=page_size, - ): - pprint(object_type) -except PalantirRPCException as e: - print("HTTP error when calling ObjectType.list_outgoing_link_types: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListOutgoingLinkTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **page** -Lists the object types for the given Ontology. - -Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are -more results available, at least one result will be present in the -response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | - -### Return type -**ListObjectTypesResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.ObjectType.page( - ontology_rid, - page_size=page_size, - page_token=page_token, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling ObjectType.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListObjectTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **page_outgoing_link_types** -List the outgoing links for an object type. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**object_type** | ObjectTypeApiName | objectType | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | - -### Return type -**ListOutgoingLinkTypesResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ObjectTypeApiName | objectType -object_type = "Flight" - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.ObjectType.page_outgoing_link_types( - ontology_rid, - object_type, - page_size=page_size, - page_token=page_token, - ) - print("The page_outgoing_link_types response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling ObjectType.page_outgoing_link_types: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListOutgoingLinkTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v1/namespaces/Ontologies/Ontology.md b/docs/v1/namespaces/Ontologies/Ontology.md deleted file mode 100644 index d21a18f5..00000000 --- a/docs/v1/namespaces/Ontologies/Ontology.md +++ /dev/null @@ -1,109 +0,0 @@ -# Ontology - -Method | HTTP request | -------------- | ------------- | -[**get**](#get) | **GET** /v1/ontologies/{ontologyRid} | -[**list**](#list) | **GET** /v1/ontologies | - -# **get** -Gets a specific ontology with the given Ontology RID. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | - -### Return type -**Ontology** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - - -try: - api_response = foundry_client.ontologies.Ontology.get( - ontology_rid, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Ontology.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Ontology | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **list** -Lists the Ontologies visible to the current user. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | - -### Return type -**ListOntologiesResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - - -try: - api_response = foundry_client.ontologies.Ontology.list() - print("The list response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Ontology.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListOntologiesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v1/namespaces/Ontologies/OntologyObject.md b/docs/v1/namespaces/Ontologies/OntologyObject.md deleted file mode 100644 index c9711dc2..00000000 --- a/docs/v1/namespaces/Ontologies/OntologyObject.md +++ /dev/null @@ -1,706 +0,0 @@ -# OntologyObject - -Method | HTTP request | -------------- | ------------- | -[**aggregate**](#aggregate) | **POST** /v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate | -[**get**](#get) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey} | -[**get_linked_object**](#get_linked_object) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} | -[**list**](#list) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType} | -[**list_linked_objects**](#list_linked_objects) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType} | -[**page**](#page) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType} | -[**page_linked_objects**](#page_linked_objects) | **GET** /v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType} | -[**search**](#search) | **POST** /v1/ontologies/{ontologyRid}/objects/{objectType}/search | - -# **aggregate** -Perform functions on object fields in the specified ontology and object type. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**object_type** | ObjectTypeApiName | objectType | | -**aggregate_objects_request** | Union[AggregateObjectsRequest, AggregateObjectsRequestDict] | Body of the request | | - -### Return type -**AggregateObjectsResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# Union[AggregateObjectsRequest, AggregateObjectsRequestDict] | Body of the request -aggregate_objects_request = { - "aggregation": [ - {"type": "min", "field": "properties.tenure", "name": "min_tenure"}, - {"type": "avg", "field": "properties.tenure", "name": "avg_tenure"}, - ], - "query": {"not": {"field": "properties.name", "eq": "john"}}, - "groupBy": [ - { - "field": "properties.startDate", - "type": "range", - "ranges": [{"gte": "2020-01-01", "lt": "2020-06-01"}], - }, - {"field": "properties.city", "type": "exact"}, - ], -} - - -try: - api_response = foundry_client.ontologies.OntologyObject.aggregate( - ontology_rid, - object_type, - aggregate_objects_request, - ) - print("The aggregate response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObject.aggregate: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | AggregateObjectsResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **get** -Gets a specific object with the given primary key. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**object_type** | ObjectTypeApiName | objectType | | -**primary_key** | PropertyValueEscapedString | primaryKey | | -**properties** | Optional[List[SelectedPropertyApiName]] | properties | [optional] | - -### Return type -**OntologyObject** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# PropertyValueEscapedString | primaryKey -primary_key = 50030 - -# Optional[List[SelectedPropertyApiName]] | properties -properties = None - - -try: - api_response = foundry_client.ontologies.OntologyObject.get( - ontology_rid, - object_type, - primary_key, - properties=properties, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObject.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | OntologyObject | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **get_linked_object** -Get a specific linked object that originates from another object. If there is no link between the two objects, -LinkedObjectNotFound is thrown. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**object_type** | ObjectTypeApiName | objectType | | -**primary_key** | PropertyValueEscapedString | primaryKey | | -**link_type** | LinkTypeApiName | linkType | | -**linked_object_primary_key** | PropertyValueEscapedString | linkedObjectPrimaryKey | | -**properties** | Optional[List[SelectedPropertyApiName]] | properties | [optional] | - -### Return type -**OntologyObject** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# PropertyValueEscapedString | primaryKey -primary_key = 50030 - -# LinkTypeApiName | linkType -link_type = "directReport" - -# PropertyValueEscapedString | linkedObjectPrimaryKey -linked_object_primary_key = 80060 - -# Optional[List[SelectedPropertyApiName]] | properties -properties = None - - -try: - api_response = foundry_client.ontologies.OntologyObject.get_linked_object( - ontology_rid, - object_type, - primary_key, - link_type, - linked_object_primary_key, - properties=properties, - ) - print("The get_linked_object response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObject.get_linked_object: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | OntologyObject | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **list** -Lists the objects for the given Ontology and object type. - -This endpoint supports filtering objects. -See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. - -Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or -repeated objects in the response pages. - -For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects -are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - -Each page may be smaller or larger than the requested page size. However, it -is guaranteed that if there are more results available, at least one result will be present -in the response. - -Note that null value properties will not be returned. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**object_type** | ObjectTypeApiName | objectType | | -**order_by** | Optional[OrderBy] | orderBy | [optional] | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**properties** | Optional[List[SelectedPropertyApiName]] | properties | [optional] | - -### Return type -**ResourceIterator[OntologyObject]** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# Optional[OrderBy] | orderBy -order_by = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[List[SelectedPropertyApiName]] | properties -properties = None - - -try: - for ontology_object in foundry_client.ontologies.OntologyObject.list( - ontology_rid, - object_type, - order_by=order_by, - page_size=page_size, - properties=properties, - ): - pprint(ontology_object) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObject.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListObjectsResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **list_linked_objects** -Lists the linked objects for a specific object and the given link type. - -This endpoint supports filtering objects. -See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. - -Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or -repeated objects in the response pages. - -For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects -are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - -Each page may be smaller or larger than the requested page size. However, it -is guaranteed that if there are more results available, at least one result will be present -in the response. - -Note that null value properties will not be returned. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**object_type** | ObjectTypeApiName | objectType | | -**primary_key** | PropertyValueEscapedString | primaryKey | | -**link_type** | LinkTypeApiName | linkType | | -**order_by** | Optional[OrderBy] | orderBy | [optional] | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**properties** | Optional[List[SelectedPropertyApiName]] | properties | [optional] | - -### Return type -**ResourceIterator[OntologyObject]** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# PropertyValueEscapedString | primaryKey -primary_key = 50030 - -# LinkTypeApiName | linkType -link_type = "directReport" - -# Optional[OrderBy] | orderBy -order_by = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[List[SelectedPropertyApiName]] | properties -properties = None - - -try: - for ontology_object in foundry_client.ontologies.OntologyObject.list_linked_objects( - ontology_rid, - object_type, - primary_key, - link_type, - order_by=order_by, - page_size=page_size, - properties=properties, - ): - pprint(ontology_object) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObject.list_linked_objects: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListLinkedObjectsResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **page** -Lists the objects for the given Ontology and object type. - -This endpoint supports filtering objects. -See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. - -Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or -repeated objects in the response pages. - -For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects -are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - -Each page may be smaller or larger than the requested page size. However, it -is guaranteed that if there are more results available, at least one result will be present -in the response. - -Note that null value properties will not be returned. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**object_type** | ObjectTypeApiName | objectType | | -**order_by** | Optional[OrderBy] | orderBy | [optional] | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | -**properties** | Optional[List[SelectedPropertyApiName]] | properties | [optional] | - -### Return type -**ListObjectsResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# Optional[OrderBy] | orderBy -order_by = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - -# Optional[List[SelectedPropertyApiName]] | properties -properties = None - - -try: - api_response = foundry_client.ontologies.OntologyObject.page( - ontology_rid, - object_type, - order_by=order_by, - page_size=page_size, - page_token=page_token, - properties=properties, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObject.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListObjectsResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **page_linked_objects** -Lists the linked objects for a specific object and the given link type. - -This endpoint supports filtering objects. -See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. - -Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or -repeated objects in the response pages. - -For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects -are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - -Each page may be smaller or larger than the requested page size. However, it -is guaranteed that if there are more results available, at least one result will be present -in the response. - -Note that null value properties will not be returned. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**object_type** | ObjectTypeApiName | objectType | | -**primary_key** | PropertyValueEscapedString | primaryKey | | -**link_type** | LinkTypeApiName | linkType | | -**order_by** | Optional[OrderBy] | orderBy | [optional] | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | -**properties** | Optional[List[SelectedPropertyApiName]] | properties | [optional] | - -### Return type -**ListLinkedObjectsResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# PropertyValueEscapedString | primaryKey -primary_key = 50030 - -# LinkTypeApiName | linkType -link_type = "directReport" - -# Optional[OrderBy] | orderBy -order_by = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - -# Optional[List[SelectedPropertyApiName]] | properties -properties = None - - -try: - api_response = foundry_client.ontologies.OntologyObject.page_linked_objects( - ontology_rid, - object_type, - primary_key, - link_type, - order_by=order_by, - page_size=page_size, - page_token=page_token, - properties=properties, - ) - print("The page_linked_objects response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObject.page_linked_objects: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListLinkedObjectsResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **search** -Search for objects in the specified ontology and object type. The request body is used -to filter objects based on the specified query. The supported queries are: - -| Query type | Description | Supported Types | -|----------|-----------------------------------------------------------------------------------|---------------------------------| -| lt | The provided property is less than the provided value. | number, string, date, timestamp | -| gt | The provided property is greater than the provided value. | number, string, date, timestamp | -| lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp | -| gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp | -| eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp | -| isNull | The provided property is (or is not) null. | all | -| contains | The provided property contains the provided value. | array | -| not | The sub-query does not match. | N/A (applied on a query) | -| and | All the sub-queries match. | N/A (applied on queries) | -| or | At least one of the sub-queries match. | N/A (applied on queries) | -| prefix | The provided property starts with the provided value. | string | -| phrase | The provided property contains the provided value as a substring. | string | -| anyTerm | The provided property contains at least one of the terms separated by whitespace. | string | -| allTerms | The provided property contains all the terms separated by whitespace. | string | | - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**object_type** | ObjectTypeApiName | objectType | | -**search_objects_request** | Union[SearchObjectsRequest, SearchObjectsRequestDict] | Body of the request | | - -### Return type -**SearchObjectsResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# Union[SearchObjectsRequest, SearchObjectsRequestDict] | Body of the request -search_objects_request = {"query": {"not": {"field": "properties.age", "eq": 21}}} - - -try: - api_response = foundry_client.ontologies.OntologyObject.search( - ontology_rid, - object_type, - search_objects_request, - ) - print("The search response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObject.search: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | SearchObjectsResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v1/namespaces/Ontologies/Query.md b/docs/v1/namespaces/Ontologies/Query.md deleted file mode 100644 index 93c2e4de..00000000 --- a/docs/v1/namespaces/Ontologies/Query.md +++ /dev/null @@ -1,70 +0,0 @@ -# Query - -Method | HTTP request | -------------- | ------------- | -[**execute**](#execute) | **POST** /v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute | - -# **execute** -Executes a Query using the given parameters. Optional parameters do not need to be supplied. -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**query_api_name** | QueryApiName | queryApiName | | -**execute_query_request** | Union[ExecuteQueryRequest, ExecuteQueryRequestDict] | Body of the request | | - -### Return type -**ExecuteQueryResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# QueryApiName | queryApiName -query_api_name = "getEmployeesInCity" - -# Union[ExecuteQueryRequest, ExecuteQueryRequestDict] | Body of the request -execute_query_request = {"parameters": {"city": "New York"}} - - -try: - api_response = foundry_client.ontologies.Query.execute( - ontology_rid, - query_api_name, - execute_query_request, - ) - print("The execute response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Query.execute: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ExecuteQueryResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v1/namespaces/Ontologies/QueryType.md b/docs/v1/namespaces/Ontologies/QueryType.md deleted file mode 100644 index d2f396de..00000000 --- a/docs/v1/namespaces/Ontologies/QueryType.md +++ /dev/null @@ -1,195 +0,0 @@ -# QueryType - -Method | HTTP request | -------------- | ------------- | -[**get**](#get) | **GET** /v1/ontologies/{ontologyRid}/queryTypes/{queryApiName} | -[**list**](#list) | **GET** /v1/ontologies/{ontologyRid}/queryTypes | -[**page**](#page) | **GET** /v1/ontologies/{ontologyRid}/queryTypes | - -# **get** -Gets a specific query type with the given API name. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**query_api_name** | QueryApiName | queryApiName | | - -### Return type -**QueryType** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# QueryApiName | queryApiName -query_api_name = "getEmployeesInCity" - - -try: - api_response = foundry_client.ontologies.Ontology.QueryType.get( - ontology_rid, - query_api_name, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling QueryType.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | QueryType | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **list** -Lists the query types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**page_size** | Optional[PageSize] | pageSize | [optional] | - -### Return type -**ResourceIterator[QueryType]** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# Optional[PageSize] | pageSize -page_size = None - - -try: - for query_type in foundry_client.ontologies.Ontology.QueryType.list( - ontology_rid, - page_size=page_size, - ): - pprint(query_type) -except PalantirRPCException as e: - print("HTTP error when calling QueryType.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListQueryTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - -# **page** -Lists the query types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology_rid** | OntologyRid | ontologyRid | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | - -### Return type -**ListQueryTypesResponse** - -### Example - -```python -from foundry.v1 import FoundryV1Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV1Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyRid | ontologyRid -ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.QueryType.page( - ontology_rid, - page_size=page_size, - page_token=page_token, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling QueryType.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListQueryTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v1-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v1/ontologies/models/ActionType.md b/docs/v1/ontologies/models/ActionType.md new file mode 100644 index 00000000..49218d7f --- /dev/null +++ b/docs/v1/ontologies/models/ActionType.md @@ -0,0 +1,17 @@ +# ActionType + +Represents an action type in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**api_name** | ActionTypeApiName | Yes | | +**description** | Optional[StrictStr] | No | | +**display_name** | Optional[DisplayName] | No | | +**status** | ReleaseStatus | Yes | | +**parameters** | Dict[ParameterId, Parameter] | Yes | | +**rid** | ActionTypeRid | Yes | | +**operations** | List[LogicRule] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ActionTypeApiName.md b/docs/v1/ontologies/models/ActionTypeApiName.md new file mode 100644 index 00000000..6cd19d8d --- /dev/null +++ b/docs/v1/ontologies/models/ActionTypeApiName.md @@ -0,0 +1,13 @@ +# ActionTypeApiName + +The name of the action type in the API. To find the API name for your Action Type, use the `List action types` +endpoint or check the **Ontology Manager**. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ActionTypeDict.md b/docs/v1/ontologies/models/ActionTypeDict.md new file mode 100644 index 00000000..a1374444 --- /dev/null +++ b/docs/v1/ontologies/models/ActionTypeDict.md @@ -0,0 +1,17 @@ +# ActionTypeDict + +Represents an action type in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**apiName** | ActionTypeApiName | Yes | | +**description** | NotRequired[StrictStr] | No | | +**displayName** | NotRequired[DisplayName] | No | | +**status** | ReleaseStatus | Yes | | +**parameters** | Dict[ParameterId, ParameterDict] | Yes | | +**rid** | ActionTypeRid | Yes | | +**operations** | List[LogicRuleDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ActionTypeRid.md b/docs/v1/ontologies/models/ActionTypeRid.md new file mode 100644 index 00000000..b91f5fcb --- /dev/null +++ b/docs/v1/ontologies/models/ActionTypeRid.md @@ -0,0 +1,12 @@ +# ActionTypeRid + +The unique resource identifier of an action type, useful for interacting with other Foundry APIs. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregateObjectsResponse.md b/docs/v1/ontologies/models/AggregateObjectsResponse.md new file mode 100644 index 00000000..7f9f5ea2 --- /dev/null +++ b/docs/v1/ontologies/models/AggregateObjectsResponse.md @@ -0,0 +1,13 @@ +# AggregateObjectsResponse + +AggregateObjectsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**excluded_items** | Optional[StrictInt] | No | | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[AggregateObjectsResponseItem] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregateObjectsResponseDict.md b/docs/v1/ontologies/models/AggregateObjectsResponseDict.md new file mode 100644 index 00000000..2759bc0c --- /dev/null +++ b/docs/v1/ontologies/models/AggregateObjectsResponseDict.md @@ -0,0 +1,13 @@ +# AggregateObjectsResponseDict + +AggregateObjectsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**excludedItems** | NotRequired[StrictInt] | No | | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[AggregateObjectsResponseItemDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregateObjectsResponseItem.md b/docs/v1/ontologies/models/AggregateObjectsResponseItem.md new file mode 100644 index 00000000..939396dc --- /dev/null +++ b/docs/v1/ontologies/models/AggregateObjectsResponseItem.md @@ -0,0 +1,12 @@ +# AggregateObjectsResponseItem + +AggregateObjectsResponseItem + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**group** | Dict[AggregationGroupKey, AggregationGroupValue] | Yes | | +**metrics** | List[AggregationMetricResult] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregateObjectsResponseItemDict.md b/docs/v1/ontologies/models/AggregateObjectsResponseItemDict.md new file mode 100644 index 00000000..f9e0f401 --- /dev/null +++ b/docs/v1/ontologies/models/AggregateObjectsResponseItemDict.md @@ -0,0 +1,12 @@ +# AggregateObjectsResponseItemDict + +AggregateObjectsResponseItem + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**group** | Dict[AggregationGroupKey, AggregationGroupValue] | Yes | | +**metrics** | List[AggregationMetricResultDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregationDict.md b/docs/v1/ontologies/models/AggregationDict.md new file mode 100644 index 00000000..f4d38430 --- /dev/null +++ b/docs/v1/ontologies/models/AggregationDict.md @@ -0,0 +1,20 @@ +# AggregationDict + +Specifies an aggregation function. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ApproximateDistinctAggregationDict | approximateDistinct +MinAggregationDict | min +AvgAggregationDict | avg +MaxAggregationDict | max +CountAggregationDict | count +SumAggregationDict | sum + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregationDurationGroupingDict.md b/docs/v1/ontologies/models/AggregationDurationGroupingDict.md new file mode 100644 index 00000000..41cc5fdd --- /dev/null +++ b/docs/v1/ontologies/models/AggregationDurationGroupingDict.md @@ -0,0 +1,15 @@ +# AggregationDurationGroupingDict + +Divides objects into groups according to an interval. Note that this grouping applies only on date types. +The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**duration** | Duration | Yes | | +**type** | Literal["duration"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregationExactGroupingDict.md b/docs/v1/ontologies/models/AggregationExactGroupingDict.md new file mode 100644 index 00000000..b9b83eca --- /dev/null +++ b/docs/v1/ontologies/models/AggregationExactGroupingDict.md @@ -0,0 +1,13 @@ +# AggregationExactGroupingDict + +Divides objects into groups according to an exact value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**maxGroupCount** | NotRequired[StrictInt] | No | | +**type** | Literal["exact"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregationFixedWidthGroupingDict.md b/docs/v1/ontologies/models/AggregationFixedWidthGroupingDict.md new file mode 100644 index 00000000..463ba534 --- /dev/null +++ b/docs/v1/ontologies/models/AggregationFixedWidthGroupingDict.md @@ -0,0 +1,13 @@ +# AggregationFixedWidthGroupingDict + +Divides objects into groups with the specified width. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**fixedWidth** | StrictInt | Yes | | +**type** | Literal["fixedWidth"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregationGroupByDict.md b/docs/v1/ontologies/models/AggregationGroupByDict.md new file mode 100644 index 00000000..936d2b76 --- /dev/null +++ b/docs/v1/ontologies/models/AggregationGroupByDict.md @@ -0,0 +1,18 @@ +# AggregationGroupByDict + +Specifies a grouping for aggregation results. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +AggregationDurationGroupingDict | duration +AggregationFixedWidthGroupingDict | fixedWidth +AggregationRangesGroupingDict | ranges +AggregationExactGroupingDict | exact + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregationGroupKey.md b/docs/v1/ontologies/models/AggregationGroupKey.md new file mode 100644 index 00000000..ac79ac00 --- /dev/null +++ b/docs/v1/ontologies/models/AggregationGroupKey.md @@ -0,0 +1,11 @@ +# AggregationGroupKey + +AggregationGroupKey + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregationGroupValue.md b/docs/v1/ontologies/models/AggregationGroupValue.md new file mode 100644 index 00000000..193574c5 --- /dev/null +++ b/docs/v1/ontologies/models/AggregationGroupValue.md @@ -0,0 +1,11 @@ +# AggregationGroupValue + +AggregationGroupValue + +## Type +```python +Any +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregationMetricName.md b/docs/v1/ontologies/models/AggregationMetricName.md new file mode 100644 index 00000000..3f06c53a --- /dev/null +++ b/docs/v1/ontologies/models/AggregationMetricName.md @@ -0,0 +1,11 @@ +# AggregationMetricName + +A user-specified alias for an aggregation metric name. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregationMetricResult.md b/docs/v1/ontologies/models/AggregationMetricResult.md new file mode 100644 index 00000000..7b032447 --- /dev/null +++ b/docs/v1/ontologies/models/AggregationMetricResult.md @@ -0,0 +1,12 @@ +# AggregationMetricResult + +AggregationMetricResult + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**name** | StrictStr | Yes | | +**value** | Optional[StrictFloat] | No | TBD | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregationMetricResultDict.md b/docs/v1/ontologies/models/AggregationMetricResultDict.md new file mode 100644 index 00000000..63fef105 --- /dev/null +++ b/docs/v1/ontologies/models/AggregationMetricResultDict.md @@ -0,0 +1,12 @@ +# AggregationMetricResultDict + +AggregationMetricResult + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**name** | StrictStr | Yes | | +**value** | NotRequired[StrictFloat] | No | TBD | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregationRangeDict.md b/docs/v1/ontologies/models/AggregationRangeDict.md new file mode 100644 index 00000000..a4ef264d --- /dev/null +++ b/docs/v1/ontologies/models/AggregationRangeDict.md @@ -0,0 +1,14 @@ +# AggregationRangeDict + +Specifies a date range from an inclusive start date to an exclusive end date. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**lt** | NotRequired[Any] | No | Exclusive end date. | +**lte** | NotRequired[Any] | No | Inclusive end date. | +**gt** | NotRequired[Any] | No | Exclusive start date. | +**gte** | NotRequired[Any] | No | Inclusive start date. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AggregationRangesGroupingDict.md b/docs/v1/ontologies/models/AggregationRangesGroupingDict.md new file mode 100644 index 00000000..4b9d9a6d --- /dev/null +++ b/docs/v1/ontologies/models/AggregationRangesGroupingDict.md @@ -0,0 +1,13 @@ +# AggregationRangesGroupingDict + +Divides objects into groups according to specified ranges. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**ranges** | List[AggregationRangeDict] | Yes | | +**type** | Literal["ranges"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AllTermsQueryDict.md b/docs/v1/ontologies/models/AllTermsQueryDict.md new file mode 100644 index 00000000..1d7a15a1 --- /dev/null +++ b/docs/v1/ontologies/models/AllTermsQueryDict.md @@ -0,0 +1,16 @@ +# AllTermsQueryDict + +Returns objects where the specified field contains all of the whitespace separated words in any +order in the provided value. This query supports fuzzy matching. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**value** | StrictStr | Yes | | +**fuzzy** | NotRequired[Fuzzy] | No | | +**type** | Literal["allTerms"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AndQueryDict.md b/docs/v1/ontologies/models/AndQueryDict.md new file mode 100644 index 00000000..c4498ac6 --- /dev/null +++ b/docs/v1/ontologies/models/AndQueryDict.md @@ -0,0 +1,12 @@ +# AndQueryDict + +Returns objects where every query is satisfied. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | List[SearchJsonQueryDict] | Yes | | +**type** | Literal["and"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AnyTermQueryDict.md b/docs/v1/ontologies/models/AnyTermQueryDict.md new file mode 100644 index 00000000..6a38c94c --- /dev/null +++ b/docs/v1/ontologies/models/AnyTermQueryDict.md @@ -0,0 +1,16 @@ +# AnyTermQueryDict + +Returns objects where the specified field contains any of the whitespace separated words in any +order in the provided value. This query supports fuzzy matching. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**value** | StrictStr | Yes | | +**fuzzy** | NotRequired[Fuzzy] | No | | +**type** | Literal["anyTerm"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ApplyActionRequestDict.md b/docs/v1/ontologies/models/ApplyActionRequestDict.md new file mode 100644 index 00000000..e69533f3 --- /dev/null +++ b/docs/v1/ontologies/models/ApplyActionRequestDict.md @@ -0,0 +1,11 @@ +# ApplyActionRequestDict + +ApplyActionRequest + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ApplyActionResponse.md b/docs/v1/ontologies/models/ApplyActionResponse.md new file mode 100644 index 00000000..b46432b1 --- /dev/null +++ b/docs/v1/ontologies/models/ApplyActionResponse.md @@ -0,0 +1,10 @@ +# ApplyActionResponse + +ApplyActionResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ApplyActionResponseDict.md b/docs/v1/ontologies/models/ApplyActionResponseDict.md new file mode 100644 index 00000000..1df22c0d --- /dev/null +++ b/docs/v1/ontologies/models/ApplyActionResponseDict.md @@ -0,0 +1,10 @@ +# ApplyActionResponseDict + +ApplyActionResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ApproximateDistinctAggregationDict.md b/docs/v1/ontologies/models/ApproximateDistinctAggregationDict.md new file mode 100644 index 00000000..ea8a5504 --- /dev/null +++ b/docs/v1/ontologies/models/ApproximateDistinctAggregationDict.md @@ -0,0 +1,13 @@ +# ApproximateDistinctAggregationDict + +Computes an approximate number of distinct values for the provided field. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**name** | NotRequired[AggregationMetricName] | No | | +**type** | Literal["approximateDistinct"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ArraySizeConstraint.md b/docs/v1/ontologies/models/ArraySizeConstraint.md new file mode 100644 index 00000000..d3b8d587 --- /dev/null +++ b/docs/v1/ontologies/models/ArraySizeConstraint.md @@ -0,0 +1,16 @@ +# ArraySizeConstraint + +The parameter expects an array of values and the size of the array must fall within the defined range. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**lt** | Optional[Any] | No | Less than | +**lte** | Optional[Any] | No | Less than or equal | +**gt** | Optional[Any] | No | Greater than | +**gte** | Optional[Any] | No | Greater than or equal | +**type** | Literal["arraySize"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ArraySizeConstraintDict.md b/docs/v1/ontologies/models/ArraySizeConstraintDict.md new file mode 100644 index 00000000..5df42cef --- /dev/null +++ b/docs/v1/ontologies/models/ArraySizeConstraintDict.md @@ -0,0 +1,16 @@ +# ArraySizeConstraintDict + +The parameter expects an array of values and the size of the array must fall within the defined range. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**lt** | NotRequired[Any] | No | Less than | +**lte** | NotRequired[Any] | No | Less than or equal | +**gt** | NotRequired[Any] | No | Greater than | +**gte** | NotRequired[Any] | No | Greater than or equal | +**type** | Literal["arraySize"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/AvgAggregationDict.md b/docs/v1/ontologies/models/AvgAggregationDict.md new file mode 100644 index 00000000..114a1e0a --- /dev/null +++ b/docs/v1/ontologies/models/AvgAggregationDict.md @@ -0,0 +1,13 @@ +# AvgAggregationDict + +Computes the average value for the provided field. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**name** | NotRequired[AggregationMetricName] | No | | +**type** | Literal["avg"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/BatchApplyActionResponse.md b/docs/v1/ontologies/models/BatchApplyActionResponse.md new file mode 100644 index 00000000..674ddf7b --- /dev/null +++ b/docs/v1/ontologies/models/BatchApplyActionResponse.md @@ -0,0 +1,10 @@ +# BatchApplyActionResponse + +BatchApplyActionResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/BatchApplyActionResponseDict.md b/docs/v1/ontologies/models/BatchApplyActionResponseDict.md new file mode 100644 index 00000000..49a411da --- /dev/null +++ b/docs/v1/ontologies/models/BatchApplyActionResponseDict.md @@ -0,0 +1,10 @@ +# BatchApplyActionResponseDict + +BatchApplyActionResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ContainsQueryDict.md b/docs/v1/ontologies/models/ContainsQueryDict.md new file mode 100644 index 00000000..c2ef9055 --- /dev/null +++ b/docs/v1/ontologies/models/ContainsQueryDict.md @@ -0,0 +1,13 @@ +# ContainsQueryDict + +Returns objects where the specified array contains a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["contains"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/CountAggregationDict.md b/docs/v1/ontologies/models/CountAggregationDict.md new file mode 100644 index 00000000..6cdc50dc --- /dev/null +++ b/docs/v1/ontologies/models/CountAggregationDict.md @@ -0,0 +1,12 @@ +# CountAggregationDict + +Computes the total count of objects. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**name** | NotRequired[AggregationMetricName] | No | | +**type** | Literal["count"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/CreateInterfaceObjectRule.md b/docs/v1/ontologies/models/CreateInterfaceObjectRule.md new file mode 100644 index 00000000..4c39427e --- /dev/null +++ b/docs/v1/ontologies/models/CreateInterfaceObjectRule.md @@ -0,0 +1,11 @@ +# CreateInterfaceObjectRule + +CreateInterfaceObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["createInterfaceObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/CreateInterfaceObjectRuleDict.md b/docs/v1/ontologies/models/CreateInterfaceObjectRuleDict.md new file mode 100644 index 00000000..72af968e --- /dev/null +++ b/docs/v1/ontologies/models/CreateInterfaceObjectRuleDict.md @@ -0,0 +1,11 @@ +# CreateInterfaceObjectRuleDict + +CreateInterfaceObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["createInterfaceObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/CreateLinkRule.md b/docs/v1/ontologies/models/CreateLinkRule.md new file mode 100644 index 00000000..aabcaee4 --- /dev/null +++ b/docs/v1/ontologies/models/CreateLinkRule.md @@ -0,0 +1,15 @@ +# CreateLinkRule + +CreateLinkRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**link_type_api_name_ato_b** | LinkTypeApiName | Yes | | +**link_type_api_name_bto_a** | LinkTypeApiName | Yes | | +**a_side_object_type_api_name** | ObjectTypeApiName | Yes | | +**b_side_object_type_api_name** | ObjectTypeApiName | Yes | | +**type** | Literal["createLink"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/CreateLinkRuleDict.md b/docs/v1/ontologies/models/CreateLinkRuleDict.md new file mode 100644 index 00000000..88d90090 --- /dev/null +++ b/docs/v1/ontologies/models/CreateLinkRuleDict.md @@ -0,0 +1,15 @@ +# CreateLinkRuleDict + +CreateLinkRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | +**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | +**aSideObjectTypeApiName** | ObjectTypeApiName | Yes | | +**bSideObjectTypeApiName** | ObjectTypeApiName | Yes | | +**type** | Literal["createLink"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/CreateObjectRule.md b/docs/v1/ontologies/models/CreateObjectRule.md new file mode 100644 index 00000000..f1d3cd27 --- /dev/null +++ b/docs/v1/ontologies/models/CreateObjectRule.md @@ -0,0 +1,12 @@ +# CreateObjectRule + +CreateObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_type_api_name** | ObjectTypeApiName | Yes | | +**type** | Literal["createObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/CreateObjectRuleDict.md b/docs/v1/ontologies/models/CreateObjectRuleDict.md new file mode 100644 index 00000000..22b84247 --- /dev/null +++ b/docs/v1/ontologies/models/CreateObjectRuleDict.md @@ -0,0 +1,12 @@ +# CreateObjectRuleDict + +CreateObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectTypeApiName** | ObjectTypeApiName | Yes | | +**type** | Literal["createObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/DataValue.md b/docs/v1/ontologies/models/DataValue.md new file mode 100644 index 00000000..24c52c6a --- /dev/null +++ b/docs/v1/ontologies/models/DataValue.md @@ -0,0 +1,35 @@ +# DataValue + +Represents the value of data in the following format. Note that these values can be nested, for example an array of structs. +| Type | JSON encoding | Example | +|-----------------------------|-------------------------------------------------------|-------------------------------------------------------------------------------| +| Array | array | `["alpha", "bravo", "charlie"]` | +| Attachment | string | `"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"` | +| Boolean | boolean | `true` | +| Byte | number | `31` | +| Date | ISO 8601 extended local date string | `"2021-05-01"` | +| Decimal | string | `"2.718281828"` | +| Float | number | `3.14159265` | +| Double | number | `3.14159265` | +| Integer | number | `238940` | +| Long | string | `"58319870951433"` | +| Marking | string | `"MU"` | +| Null | null | `null` | +| Object Set | string OR the object set definition | `ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z`| +| Ontology Object Reference | JSON encoding of the object's primary key | `10033123` or `"EMP1234"` | +| Set | array | `["alpha", "bravo", "charlie"]` | +| Short | number | `8739` | +| String | string | `"Call me Ishmael"` | +| Struct | JSON object | `{"name": "John Doe", "age": 42}` | +| TwoDimensionalAggregation | JSON object | `{"groups": [{"key": "alpha", "value": 100}, {"key": "beta", "value": 101}]}` | +| ThreeDimensionalAggregation | JSON object | `{"groups": [{"key": "NYC", "groups": [{"key": "Engineer", "value" : 100}]}]}`| +| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | + + +## Type +```python +Any +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/DeleteLinkRule.md b/docs/v1/ontologies/models/DeleteLinkRule.md new file mode 100644 index 00000000..ff18c2b1 --- /dev/null +++ b/docs/v1/ontologies/models/DeleteLinkRule.md @@ -0,0 +1,15 @@ +# DeleteLinkRule + +DeleteLinkRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**link_type_api_name_ato_b** | LinkTypeApiName | Yes | | +**link_type_api_name_bto_a** | LinkTypeApiName | Yes | | +**a_side_object_type_api_name** | ObjectTypeApiName | Yes | | +**b_side_object_type_api_name** | ObjectTypeApiName | Yes | | +**type** | Literal["deleteLink"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/DeleteLinkRuleDict.md b/docs/v1/ontologies/models/DeleteLinkRuleDict.md new file mode 100644 index 00000000..4f5d0c7c --- /dev/null +++ b/docs/v1/ontologies/models/DeleteLinkRuleDict.md @@ -0,0 +1,15 @@ +# DeleteLinkRuleDict + +DeleteLinkRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | +**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | +**aSideObjectTypeApiName** | ObjectTypeApiName | Yes | | +**bSideObjectTypeApiName** | ObjectTypeApiName | Yes | | +**type** | Literal["deleteLink"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/DeleteObjectRule.md b/docs/v1/ontologies/models/DeleteObjectRule.md new file mode 100644 index 00000000..a220f750 --- /dev/null +++ b/docs/v1/ontologies/models/DeleteObjectRule.md @@ -0,0 +1,12 @@ +# DeleteObjectRule + +DeleteObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_type_api_name** | ObjectTypeApiName | Yes | | +**type** | Literal["deleteObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/DeleteObjectRuleDict.md b/docs/v1/ontologies/models/DeleteObjectRuleDict.md new file mode 100644 index 00000000..3ea3e784 --- /dev/null +++ b/docs/v1/ontologies/models/DeleteObjectRuleDict.md @@ -0,0 +1,12 @@ +# DeleteObjectRuleDict + +DeleteObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectTypeApiName** | ObjectTypeApiName | Yes | | +**type** | Literal["deleteObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/EqualsQueryDict.md b/docs/v1/ontologies/models/EqualsQueryDict.md new file mode 100644 index 00000000..375c6ed5 --- /dev/null +++ b/docs/v1/ontologies/models/EqualsQueryDict.md @@ -0,0 +1,13 @@ +# EqualsQueryDict + +Returns objects where the specified field is equal to a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["eq"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ExecuteQueryResponse.md b/docs/v1/ontologies/models/ExecuteQueryResponse.md new file mode 100644 index 00000000..8238931f --- /dev/null +++ b/docs/v1/ontologies/models/ExecuteQueryResponse.md @@ -0,0 +1,11 @@ +# ExecuteQueryResponse + +ExecuteQueryResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | DataValue | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ExecuteQueryResponseDict.md b/docs/v1/ontologies/models/ExecuteQueryResponseDict.md new file mode 100644 index 00000000..318b26d8 --- /dev/null +++ b/docs/v1/ontologies/models/ExecuteQueryResponseDict.md @@ -0,0 +1,11 @@ +# ExecuteQueryResponseDict + +ExecuteQueryResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | DataValue | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/FieldNameV1.md b/docs/v1/ontologies/models/FieldNameV1.md new file mode 100644 index 00000000..72624537 --- /dev/null +++ b/docs/v1/ontologies/models/FieldNameV1.md @@ -0,0 +1,11 @@ +# FieldNameV1 + +A reference to an Ontology object property with the form `properties.{propertyApiName}`. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/FunctionRid.md b/docs/v1/ontologies/models/FunctionRid.md new file mode 100644 index 00000000..204e7e77 --- /dev/null +++ b/docs/v1/ontologies/models/FunctionRid.md @@ -0,0 +1,12 @@ +# FunctionRid + +The unique resource identifier of a Function, useful for interacting with other Foundry APIs. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/FunctionVersion.md b/docs/v1/ontologies/models/FunctionVersion.md new file mode 100644 index 00000000..9c4c51de --- /dev/null +++ b/docs/v1/ontologies/models/FunctionVersion.md @@ -0,0 +1,13 @@ +# FunctionVersion + +The version of the given Function, written `..-`, where `-` is optional. +Examples: `1.2.3`, `1.2.3-rc1`. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/Fuzzy.md b/docs/v1/ontologies/models/Fuzzy.md new file mode 100644 index 00000000..bca4dbf3 --- /dev/null +++ b/docs/v1/ontologies/models/Fuzzy.md @@ -0,0 +1,11 @@ +# Fuzzy + +Setting fuzzy to `true` allows approximate matching in search queries that support it. + +## Type +```python +StrictBool +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/GroupMemberConstraint.md b/docs/v1/ontologies/models/GroupMemberConstraint.md new file mode 100644 index 00000000..73d2ebca --- /dev/null +++ b/docs/v1/ontologies/models/GroupMemberConstraint.md @@ -0,0 +1,12 @@ +# GroupMemberConstraint + +The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["groupMember"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/GroupMemberConstraintDict.md b/docs/v1/ontologies/models/GroupMemberConstraintDict.md new file mode 100644 index 00000000..6d4cdad9 --- /dev/null +++ b/docs/v1/ontologies/models/GroupMemberConstraintDict.md @@ -0,0 +1,12 @@ +# GroupMemberConstraintDict + +The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["groupMember"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/GtQueryDict.md b/docs/v1/ontologies/models/GtQueryDict.md new file mode 100644 index 00000000..4f028028 --- /dev/null +++ b/docs/v1/ontologies/models/GtQueryDict.md @@ -0,0 +1,13 @@ +# GtQueryDict + +Returns objects where the specified field is greater than a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["gt"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/GteQueryDict.md b/docs/v1/ontologies/models/GteQueryDict.md new file mode 100644 index 00000000..61a326e2 --- /dev/null +++ b/docs/v1/ontologies/models/GteQueryDict.md @@ -0,0 +1,13 @@ +# GteQueryDict + +Returns objects where the specified field is greater than or equal to a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["gte"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/IsNullQueryDict.md b/docs/v1/ontologies/models/IsNullQueryDict.md new file mode 100644 index 00000000..2ab10eb6 --- /dev/null +++ b/docs/v1/ontologies/models/IsNullQueryDict.md @@ -0,0 +1,13 @@ +# IsNullQueryDict + +Returns objects based on the existence of the specified field. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**value** | StrictBool | Yes | | +**type** | Literal["isNull"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/LinkTypeApiName.md b/docs/v1/ontologies/models/LinkTypeApiName.md new file mode 100644 index 00000000..56541d62 --- /dev/null +++ b/docs/v1/ontologies/models/LinkTypeApiName.md @@ -0,0 +1,13 @@ +# LinkTypeApiName + +The name of the link type in the API. To find the API name for your Link Type, check the **Ontology Manager** +application. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/LinkTypeSide.md b/docs/v1/ontologies/models/LinkTypeSide.md new file mode 100644 index 00000000..20bc7d10 --- /dev/null +++ b/docs/v1/ontologies/models/LinkTypeSide.md @@ -0,0 +1,16 @@ +# LinkTypeSide + +LinkTypeSide + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**api_name** | LinkTypeApiName | Yes | | +**display_name** | DisplayName | Yes | | +**status** | ReleaseStatus | Yes | | +**object_type_api_name** | ObjectTypeApiName | Yes | | +**cardinality** | LinkTypeSideCardinality | Yes | | +**foreign_key_property_api_name** | Optional[PropertyApiName] | No | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/LinkTypeSideCardinality.md b/docs/v1/ontologies/models/LinkTypeSideCardinality.md new file mode 100644 index 00000000..5287f18e --- /dev/null +++ b/docs/v1/ontologies/models/LinkTypeSideCardinality.md @@ -0,0 +1,11 @@ +# LinkTypeSideCardinality + +LinkTypeSideCardinality + +| **Value** | +| --------- | +| `"ONE"` | +| `"MANY"` | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/LinkTypeSideDict.md b/docs/v1/ontologies/models/LinkTypeSideDict.md new file mode 100644 index 00000000..2c119031 --- /dev/null +++ b/docs/v1/ontologies/models/LinkTypeSideDict.md @@ -0,0 +1,16 @@ +# LinkTypeSideDict + +LinkTypeSide + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**apiName** | LinkTypeApiName | Yes | | +**displayName** | DisplayName | Yes | | +**status** | ReleaseStatus | Yes | | +**objectTypeApiName** | ObjectTypeApiName | Yes | | +**cardinality** | LinkTypeSideCardinality | Yes | | +**foreignKeyPropertyApiName** | NotRequired[PropertyApiName] | No | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ListActionTypesResponse.md b/docs/v1/ontologies/models/ListActionTypesResponse.md new file mode 100644 index 00000000..902d173f --- /dev/null +++ b/docs/v1/ontologies/models/ListActionTypesResponse.md @@ -0,0 +1,12 @@ +# ListActionTypesResponse + +ListActionTypesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[ActionType] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ListActionTypesResponseDict.md b/docs/v1/ontologies/models/ListActionTypesResponseDict.md new file mode 100644 index 00000000..68e6b8b3 --- /dev/null +++ b/docs/v1/ontologies/models/ListActionTypesResponseDict.md @@ -0,0 +1,12 @@ +# ListActionTypesResponseDict + +ListActionTypesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[ActionTypeDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ListLinkedObjectsResponse.md b/docs/v1/ontologies/models/ListLinkedObjectsResponse.md new file mode 100644 index 00000000..873c95d9 --- /dev/null +++ b/docs/v1/ontologies/models/ListLinkedObjectsResponse.md @@ -0,0 +1,12 @@ +# ListLinkedObjectsResponse + +ListLinkedObjectsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[OntologyObject] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ListLinkedObjectsResponseDict.md b/docs/v1/ontologies/models/ListLinkedObjectsResponseDict.md new file mode 100644 index 00000000..c8f24600 --- /dev/null +++ b/docs/v1/ontologies/models/ListLinkedObjectsResponseDict.md @@ -0,0 +1,12 @@ +# ListLinkedObjectsResponseDict + +ListLinkedObjectsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[OntologyObjectDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ListObjectTypesResponse.md b/docs/v1/ontologies/models/ListObjectTypesResponse.md new file mode 100644 index 00000000..013faf7c --- /dev/null +++ b/docs/v1/ontologies/models/ListObjectTypesResponse.md @@ -0,0 +1,12 @@ +# ListObjectTypesResponse + +ListObjectTypesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[ObjectType] | Yes | The list of object types in the current page. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ListObjectTypesResponseDict.md b/docs/v1/ontologies/models/ListObjectTypesResponseDict.md new file mode 100644 index 00000000..abd5db7d --- /dev/null +++ b/docs/v1/ontologies/models/ListObjectTypesResponseDict.md @@ -0,0 +1,12 @@ +# ListObjectTypesResponseDict + +ListObjectTypesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[ObjectTypeDict] | Yes | The list of object types in the current page. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ListObjectsResponse.md b/docs/v1/ontologies/models/ListObjectsResponse.md new file mode 100644 index 00000000..be2e92a0 --- /dev/null +++ b/docs/v1/ontologies/models/ListObjectsResponse.md @@ -0,0 +1,13 @@ +# ListObjectsResponse + +ListObjectsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[OntologyObject] | Yes | The list of objects in the current page. | +**total_count** | TotalCount | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ListObjectsResponseDict.md b/docs/v1/ontologies/models/ListObjectsResponseDict.md new file mode 100644 index 00000000..7292e630 --- /dev/null +++ b/docs/v1/ontologies/models/ListObjectsResponseDict.md @@ -0,0 +1,13 @@ +# ListObjectsResponseDict + +ListObjectsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[OntologyObjectDict] | Yes | The list of objects in the current page. | +**totalCount** | TotalCount | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ListOntologiesResponse.md b/docs/v1/ontologies/models/ListOntologiesResponse.md new file mode 100644 index 00000000..35cd401f --- /dev/null +++ b/docs/v1/ontologies/models/ListOntologiesResponse.md @@ -0,0 +1,11 @@ +# ListOntologiesResponse + +ListOntologiesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[Ontology] | Yes | The list of Ontologies the user has access to. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ListOntologiesResponseDict.md b/docs/v1/ontologies/models/ListOntologiesResponseDict.md new file mode 100644 index 00000000..92c331bc --- /dev/null +++ b/docs/v1/ontologies/models/ListOntologiesResponseDict.md @@ -0,0 +1,11 @@ +# ListOntologiesResponseDict + +ListOntologiesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[OntologyDict] | Yes | The list of Ontologies the user has access to. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ListOutgoingLinkTypesResponse.md b/docs/v1/ontologies/models/ListOutgoingLinkTypesResponse.md new file mode 100644 index 00000000..57ebcedc --- /dev/null +++ b/docs/v1/ontologies/models/ListOutgoingLinkTypesResponse.md @@ -0,0 +1,12 @@ +# ListOutgoingLinkTypesResponse + +ListOutgoingLinkTypesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[LinkTypeSide] | Yes | The list of link type sides in the current page. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ListOutgoingLinkTypesResponseDict.md b/docs/v1/ontologies/models/ListOutgoingLinkTypesResponseDict.md new file mode 100644 index 00000000..6d0bfc84 --- /dev/null +++ b/docs/v1/ontologies/models/ListOutgoingLinkTypesResponseDict.md @@ -0,0 +1,12 @@ +# ListOutgoingLinkTypesResponseDict + +ListOutgoingLinkTypesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[LinkTypeSideDict] | Yes | The list of link type sides in the current page. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ListQueryTypesResponse.md b/docs/v1/ontologies/models/ListQueryTypesResponse.md new file mode 100644 index 00000000..55083734 --- /dev/null +++ b/docs/v1/ontologies/models/ListQueryTypesResponse.md @@ -0,0 +1,12 @@ +# ListQueryTypesResponse + +ListQueryTypesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[QueryType] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ListQueryTypesResponseDict.md b/docs/v1/ontologies/models/ListQueryTypesResponseDict.md new file mode 100644 index 00000000..152884fb --- /dev/null +++ b/docs/v1/ontologies/models/ListQueryTypesResponseDict.md @@ -0,0 +1,12 @@ +# ListQueryTypesResponseDict + +ListQueryTypesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[QueryTypeDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/LogicRule.md b/docs/v1/ontologies/models/LogicRule.md new file mode 100644 index 00000000..17ac5a63 --- /dev/null +++ b/docs/v1/ontologies/models/LogicRule.md @@ -0,0 +1,21 @@ +# LogicRule + +LogicRule + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ModifyInterfaceObjectRule | modifyInterfaceObject +ModifyObjectRule | modifyObject +DeleteObjectRule | deleteObject +CreateInterfaceObjectRule | createInterfaceObject +DeleteLinkRule | deleteLink +CreateObjectRule | createObject +CreateLinkRule | createLink + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/LogicRuleDict.md b/docs/v1/ontologies/models/LogicRuleDict.md new file mode 100644 index 00000000..489b47e3 --- /dev/null +++ b/docs/v1/ontologies/models/LogicRuleDict.md @@ -0,0 +1,21 @@ +# LogicRuleDict + +LogicRule + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ModifyInterfaceObjectRuleDict | modifyInterfaceObject +ModifyObjectRuleDict | modifyObject +DeleteObjectRuleDict | deleteObject +CreateInterfaceObjectRuleDict | createInterfaceObject +DeleteLinkRuleDict | deleteLink +CreateObjectRuleDict | createObject +CreateLinkRuleDict | createLink + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/LtQueryDict.md b/docs/v1/ontologies/models/LtQueryDict.md new file mode 100644 index 00000000..ddcc10bc --- /dev/null +++ b/docs/v1/ontologies/models/LtQueryDict.md @@ -0,0 +1,13 @@ +# LtQueryDict + +Returns objects where the specified field is less than a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["lt"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/LteQueryDict.md b/docs/v1/ontologies/models/LteQueryDict.md new file mode 100644 index 00000000..cc77757a --- /dev/null +++ b/docs/v1/ontologies/models/LteQueryDict.md @@ -0,0 +1,13 @@ +# LteQueryDict + +Returns objects where the specified field is less than or equal to a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["lte"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/MaxAggregationDict.md b/docs/v1/ontologies/models/MaxAggregationDict.md new file mode 100644 index 00000000..acd7404e --- /dev/null +++ b/docs/v1/ontologies/models/MaxAggregationDict.md @@ -0,0 +1,13 @@ +# MaxAggregationDict + +Computes the maximum value for the provided field. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**name** | NotRequired[AggregationMetricName] | No | | +**type** | Literal["max"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/MinAggregationDict.md b/docs/v1/ontologies/models/MinAggregationDict.md new file mode 100644 index 00000000..aef1d4a1 --- /dev/null +++ b/docs/v1/ontologies/models/MinAggregationDict.md @@ -0,0 +1,13 @@ +# MinAggregationDict + +Computes the minimum value for the provided field. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**name** | NotRequired[AggregationMetricName] | No | | +**type** | Literal["min"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ModifyInterfaceObjectRule.md b/docs/v1/ontologies/models/ModifyInterfaceObjectRule.md new file mode 100644 index 00000000..44181958 --- /dev/null +++ b/docs/v1/ontologies/models/ModifyInterfaceObjectRule.md @@ -0,0 +1,11 @@ +# ModifyInterfaceObjectRule + +ModifyInterfaceObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["modifyInterfaceObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ModifyInterfaceObjectRuleDict.md b/docs/v1/ontologies/models/ModifyInterfaceObjectRuleDict.md new file mode 100644 index 00000000..280bcf51 --- /dev/null +++ b/docs/v1/ontologies/models/ModifyInterfaceObjectRuleDict.md @@ -0,0 +1,11 @@ +# ModifyInterfaceObjectRuleDict + +ModifyInterfaceObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["modifyInterfaceObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ModifyObjectRule.md b/docs/v1/ontologies/models/ModifyObjectRule.md new file mode 100644 index 00000000..d6bd9d0c --- /dev/null +++ b/docs/v1/ontologies/models/ModifyObjectRule.md @@ -0,0 +1,12 @@ +# ModifyObjectRule + +ModifyObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_type_api_name** | ObjectTypeApiName | Yes | | +**type** | Literal["modifyObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ModifyObjectRuleDict.md b/docs/v1/ontologies/models/ModifyObjectRuleDict.md new file mode 100644 index 00000000..f15d647c --- /dev/null +++ b/docs/v1/ontologies/models/ModifyObjectRuleDict.md @@ -0,0 +1,12 @@ +# ModifyObjectRuleDict + +ModifyObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectTypeApiName** | ObjectTypeApiName | Yes | | +**type** | Literal["modifyObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/NotQueryDict.md b/docs/v1/ontologies/models/NotQueryDict.md new file mode 100644 index 00000000..1db793a0 --- /dev/null +++ b/docs/v1/ontologies/models/NotQueryDict.md @@ -0,0 +1,12 @@ +# NotQueryDict + +Returns objects where the query is not satisfied. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | SearchJsonQueryDict | Yes | | +**type** | Literal["not"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ObjectPropertyValueConstraint.md b/docs/v1/ontologies/models/ObjectPropertyValueConstraint.md new file mode 100644 index 00000000..18624923 --- /dev/null +++ b/docs/v1/ontologies/models/ObjectPropertyValueConstraint.md @@ -0,0 +1,12 @@ +# ObjectPropertyValueConstraint + +The parameter value must be a property value of an object found within an object set. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["objectPropertyValue"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ObjectPropertyValueConstraintDict.md b/docs/v1/ontologies/models/ObjectPropertyValueConstraintDict.md new file mode 100644 index 00000000..7efe0e4b --- /dev/null +++ b/docs/v1/ontologies/models/ObjectPropertyValueConstraintDict.md @@ -0,0 +1,12 @@ +# ObjectPropertyValueConstraintDict + +The parameter value must be a property value of an object found within an object set. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["objectPropertyValue"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ObjectQueryResultConstraint.md b/docs/v1/ontologies/models/ObjectQueryResultConstraint.md new file mode 100644 index 00000000..cea087ff --- /dev/null +++ b/docs/v1/ontologies/models/ObjectQueryResultConstraint.md @@ -0,0 +1,12 @@ +# ObjectQueryResultConstraint + +The parameter value must be the primary key of an object found within an object set. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["objectQueryResult"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ObjectQueryResultConstraintDict.md b/docs/v1/ontologies/models/ObjectQueryResultConstraintDict.md new file mode 100644 index 00000000..32ae5768 --- /dev/null +++ b/docs/v1/ontologies/models/ObjectQueryResultConstraintDict.md @@ -0,0 +1,12 @@ +# ObjectQueryResultConstraintDict + +The parameter value must be the primary key of an object found within an object set. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["objectQueryResult"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ObjectRid.md b/docs/v1/ontologies/models/ObjectRid.md new file mode 100644 index 00000000..ab4049c8 --- /dev/null +++ b/docs/v1/ontologies/models/ObjectRid.md @@ -0,0 +1,12 @@ +# ObjectRid + +The unique resource identifier of an object, useful for interacting with other Foundry APIs. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ObjectType.md b/docs/v1/ontologies/models/ObjectType.md new file mode 100644 index 00000000..4ec966ec --- /dev/null +++ b/docs/v1/ontologies/models/ObjectType.md @@ -0,0 +1,18 @@ +# ObjectType + +Represents an object type in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**api_name** | ObjectTypeApiName | Yes | | +**display_name** | Optional[DisplayName] | No | | +**status** | ReleaseStatus | Yes | | +**description** | Optional[StrictStr] | No | The description of the object type. | +**visibility** | Optional[ObjectTypeVisibility] | No | | +**primary_key** | List[PropertyApiName] | Yes | The primary key of the object. This is a list of properties that can be used to uniquely identify the object. | +**properties** | Dict[PropertyApiName, Property] | Yes | A map of the properties of the object type. | +**rid** | ObjectTypeRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ObjectTypeApiName.md b/docs/v1/ontologies/models/ObjectTypeApiName.md new file mode 100644 index 00000000..0cac1f23 --- /dev/null +++ b/docs/v1/ontologies/models/ObjectTypeApiName.md @@ -0,0 +1,13 @@ +# ObjectTypeApiName + +The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the +`List object types` endpoint or check the **Ontology Manager**. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ObjectTypeDict.md b/docs/v1/ontologies/models/ObjectTypeDict.md new file mode 100644 index 00000000..8afd3437 --- /dev/null +++ b/docs/v1/ontologies/models/ObjectTypeDict.md @@ -0,0 +1,18 @@ +# ObjectTypeDict + +Represents an object type in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**apiName** | ObjectTypeApiName | Yes | | +**displayName** | NotRequired[DisplayName] | No | | +**status** | ReleaseStatus | Yes | | +**description** | NotRequired[StrictStr] | No | The description of the object type. | +**visibility** | NotRequired[ObjectTypeVisibility] | No | | +**primaryKey** | List[PropertyApiName] | Yes | The primary key of the object. This is a list of properties that can be used to uniquely identify the object. | +**properties** | Dict[PropertyApiName, PropertyDict] | Yes | A map of the properties of the object type. | +**rid** | ObjectTypeRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ObjectTypeRid.md b/docs/v1/ontologies/models/ObjectTypeRid.md new file mode 100644 index 00000000..856cc803 --- /dev/null +++ b/docs/v1/ontologies/models/ObjectTypeRid.md @@ -0,0 +1,11 @@ +# ObjectTypeRid + +The unique resource identifier of an object type, useful for interacting with other Foundry APIs. + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ObjectTypeVisibility.md b/docs/v1/ontologies/models/ObjectTypeVisibility.md new file mode 100644 index 00000000..3d6da6b1 --- /dev/null +++ b/docs/v1/ontologies/models/ObjectTypeVisibility.md @@ -0,0 +1,12 @@ +# ObjectTypeVisibility + +The suggested visibility of the object type. + +| **Value** | +| --------- | +| `"NORMAL"` | +| `"PROMINENT"` | +| `"HIDDEN"` | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OneOfConstraint.md b/docs/v1/ontologies/models/OneOfConstraint.md new file mode 100644 index 00000000..93664aad --- /dev/null +++ b/docs/v1/ontologies/models/OneOfConstraint.md @@ -0,0 +1,14 @@ +# OneOfConstraint + +The parameter has a manually predefined set of options. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**options** | List[ParameterOption] | Yes | | +**other_values_allowed** | StrictBool | Yes | A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**. | +**type** | Literal["oneOf"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OneOfConstraintDict.md b/docs/v1/ontologies/models/OneOfConstraintDict.md new file mode 100644 index 00000000..917f435f --- /dev/null +++ b/docs/v1/ontologies/models/OneOfConstraintDict.md @@ -0,0 +1,14 @@ +# OneOfConstraintDict + +The parameter has a manually predefined set of options. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**options** | List[ParameterOptionDict] | Yes | | +**otherValuesAllowed** | StrictBool | Yes | A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**. | +**type** | Literal["oneOf"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/Ontology.md b/docs/v1/ontologies/models/Ontology.md new file mode 100644 index 00000000..8f505f8b --- /dev/null +++ b/docs/v1/ontologies/models/Ontology.md @@ -0,0 +1,14 @@ +# Ontology + +Metadata about an Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**api_name** | OntologyApiName | Yes | | +**display_name** | DisplayName | Yes | | +**description** | StrictStr | Yes | | +**rid** | OntologyRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyApiName.md b/docs/v1/ontologies/models/OntologyApiName.md new file mode 100644 index 00000000..c7ef6b1e --- /dev/null +++ b/docs/v1/ontologies/models/OntologyApiName.md @@ -0,0 +1,11 @@ +# OntologyApiName + +OntologyApiName + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyArrayType.md b/docs/v1/ontologies/models/OntologyArrayType.md new file mode 100644 index 00000000..fc859789 --- /dev/null +++ b/docs/v1/ontologies/models/OntologyArrayType.md @@ -0,0 +1,12 @@ +# OntologyArrayType + +OntologyArrayType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**item_type** | OntologyDataType | Yes | | +**type** | Literal["array"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyArrayTypeDict.md b/docs/v1/ontologies/models/OntologyArrayTypeDict.md new file mode 100644 index 00000000..23bb2537 --- /dev/null +++ b/docs/v1/ontologies/models/OntologyArrayTypeDict.md @@ -0,0 +1,12 @@ +# OntologyArrayTypeDict + +OntologyArrayType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**itemType** | OntologyDataTypeDict | Yes | | +**type** | Literal["array"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyDataType.md b/docs/v1/ontologies/models/OntologyDataType.md new file mode 100644 index 00000000..f7eadec2 --- /dev/null +++ b/docs/v1/ontologies/models/OntologyDataType.md @@ -0,0 +1,36 @@ +# OntologyDataType + +A union of all the primitive types used by Palantir's Ontology-based products. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateType | date +OntologyStructType | struct +OntologySetType | set +StringType | string +ByteType | byte +DoubleType | double +IntegerType | integer +FloatType | float +AnyType | any +LongType | long +BooleanType | boolean +MarkingType | marking +UnsupportedType | unsupported +OntologyArrayType | array +OntologyObjectSetType | objectSet +BinaryType | binary +ShortType | short +DecimalType | decimal +OntologyMapType | map +TimestampType | timestamp +OntologyObjectType | object + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyDataTypeDict.md b/docs/v1/ontologies/models/OntologyDataTypeDict.md new file mode 100644 index 00000000..d335e6fe --- /dev/null +++ b/docs/v1/ontologies/models/OntologyDataTypeDict.md @@ -0,0 +1,36 @@ +# OntologyDataTypeDict + +A union of all the primitive types used by Palantir's Ontology-based products. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateTypeDict | date +OntologyStructTypeDict | struct +OntologySetTypeDict | set +StringTypeDict | string +ByteTypeDict | byte +DoubleTypeDict | double +IntegerTypeDict | integer +FloatTypeDict | float +AnyTypeDict | any +LongTypeDict | long +BooleanTypeDict | boolean +MarkingTypeDict | marking +UnsupportedTypeDict | unsupported +OntologyArrayTypeDict | array +OntologyObjectSetTypeDict | objectSet +BinaryTypeDict | binary +ShortTypeDict | short +DecimalTypeDict | decimal +OntologyMapTypeDict | map +TimestampTypeDict | timestamp +OntologyObjectTypeDict | object + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyDict.md b/docs/v1/ontologies/models/OntologyDict.md new file mode 100644 index 00000000..972b1fd9 --- /dev/null +++ b/docs/v1/ontologies/models/OntologyDict.md @@ -0,0 +1,14 @@ +# OntologyDict + +Metadata about an Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**apiName** | OntologyApiName | Yes | | +**displayName** | DisplayName | Yes | | +**description** | StrictStr | Yes | | +**rid** | OntologyRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyMapType.md b/docs/v1/ontologies/models/OntologyMapType.md new file mode 100644 index 00000000..e407de46 --- /dev/null +++ b/docs/v1/ontologies/models/OntologyMapType.md @@ -0,0 +1,13 @@ +# OntologyMapType + +OntologyMapType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**key_type** | OntologyDataType | Yes | | +**value_type** | OntologyDataType | Yes | | +**type** | Literal["map"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyMapTypeDict.md b/docs/v1/ontologies/models/OntologyMapTypeDict.md new file mode 100644 index 00000000..b6b8dd52 --- /dev/null +++ b/docs/v1/ontologies/models/OntologyMapTypeDict.md @@ -0,0 +1,13 @@ +# OntologyMapTypeDict + +OntologyMapType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**keyType** | OntologyDataTypeDict | Yes | | +**valueType** | OntologyDataTypeDict | Yes | | +**type** | Literal["map"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyObject.md b/docs/v1/ontologies/models/OntologyObject.md new file mode 100644 index 00000000..441362cf --- /dev/null +++ b/docs/v1/ontologies/models/OntologyObject.md @@ -0,0 +1,12 @@ +# OntologyObject + +Represents an object in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**properties** | Dict[PropertyApiName, Optional[PropertyValue]] | Yes | A map of the property values of the object. | +**rid** | ObjectRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyObjectDict.md b/docs/v1/ontologies/models/OntologyObjectDict.md new file mode 100644 index 00000000..5be1bc45 --- /dev/null +++ b/docs/v1/ontologies/models/OntologyObjectDict.md @@ -0,0 +1,12 @@ +# OntologyObjectDict + +Represents an object in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**properties** | Dict[PropertyApiName, Optional[PropertyValue]] | Yes | A map of the property values of the object. | +**rid** | ObjectRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyObjectSetType.md b/docs/v1/ontologies/models/OntologyObjectSetType.md new file mode 100644 index 00000000..df56f6e6 --- /dev/null +++ b/docs/v1/ontologies/models/OntologyObjectSetType.md @@ -0,0 +1,13 @@ +# OntologyObjectSetType + +OntologyObjectSetType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_api_name** | Optional[ObjectTypeApiName] | No | | +**object_type_api_name** | Optional[ObjectTypeApiName] | No | | +**type** | Literal["objectSet"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyObjectSetTypeDict.md b/docs/v1/ontologies/models/OntologyObjectSetTypeDict.md new file mode 100644 index 00000000..c1dacb25 --- /dev/null +++ b/docs/v1/ontologies/models/OntologyObjectSetTypeDict.md @@ -0,0 +1,13 @@ +# OntologyObjectSetTypeDict + +OntologyObjectSetType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectApiName** | NotRequired[ObjectTypeApiName] | No | | +**objectTypeApiName** | NotRequired[ObjectTypeApiName] | No | | +**type** | Literal["objectSet"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyObjectType.md b/docs/v1/ontologies/models/OntologyObjectType.md new file mode 100644 index 00000000..c2c89353 --- /dev/null +++ b/docs/v1/ontologies/models/OntologyObjectType.md @@ -0,0 +1,13 @@ +# OntologyObjectType + +OntologyObjectType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_api_name** | ObjectTypeApiName | Yes | | +**object_type_api_name** | ObjectTypeApiName | Yes | | +**type** | Literal["object"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyObjectTypeDict.md b/docs/v1/ontologies/models/OntologyObjectTypeDict.md new file mode 100644 index 00000000..8aa3349e --- /dev/null +++ b/docs/v1/ontologies/models/OntologyObjectTypeDict.md @@ -0,0 +1,13 @@ +# OntologyObjectTypeDict + +OntologyObjectType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectApiName** | ObjectTypeApiName | Yes | | +**objectTypeApiName** | ObjectTypeApiName | Yes | | +**type** | Literal["object"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyRid.md b/docs/v1/ontologies/models/OntologyRid.md new file mode 100644 index 00000000..d8e557df --- /dev/null +++ b/docs/v1/ontologies/models/OntologyRid.md @@ -0,0 +1,13 @@ +# OntologyRid + +The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the +`List ontologies` endpoint or check the **Ontology Manager**. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologySetType.md b/docs/v1/ontologies/models/OntologySetType.md new file mode 100644 index 00000000..f5f9a701 --- /dev/null +++ b/docs/v1/ontologies/models/OntologySetType.md @@ -0,0 +1,12 @@ +# OntologySetType + +OntologySetType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**item_type** | OntologyDataType | Yes | | +**type** | Literal["set"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologySetTypeDict.md b/docs/v1/ontologies/models/OntologySetTypeDict.md new file mode 100644 index 00000000..02446408 --- /dev/null +++ b/docs/v1/ontologies/models/OntologySetTypeDict.md @@ -0,0 +1,12 @@ +# OntologySetTypeDict + +OntologySetType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**itemType** | OntologyDataTypeDict | Yes | | +**type** | Literal["set"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyStructField.md b/docs/v1/ontologies/models/OntologyStructField.md new file mode 100644 index 00000000..9f595837 --- /dev/null +++ b/docs/v1/ontologies/models/OntologyStructField.md @@ -0,0 +1,13 @@ +# OntologyStructField + +OntologyStructField + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**name** | StructFieldName | Yes | | +**field_type** | OntologyDataType | Yes | | +**required** | StrictBool | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyStructFieldDict.md b/docs/v1/ontologies/models/OntologyStructFieldDict.md new file mode 100644 index 00000000..07e25431 --- /dev/null +++ b/docs/v1/ontologies/models/OntologyStructFieldDict.md @@ -0,0 +1,13 @@ +# OntologyStructFieldDict + +OntologyStructField + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**name** | StructFieldName | Yes | | +**fieldType** | OntologyDataTypeDict | Yes | | +**required** | StrictBool | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyStructType.md b/docs/v1/ontologies/models/OntologyStructType.md new file mode 100644 index 00000000..7e9675dd --- /dev/null +++ b/docs/v1/ontologies/models/OntologyStructType.md @@ -0,0 +1,12 @@ +# OntologyStructType + +OntologyStructType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**fields** | List[OntologyStructField] | Yes | | +**type** | Literal["struct"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OntologyStructTypeDict.md b/docs/v1/ontologies/models/OntologyStructTypeDict.md new file mode 100644 index 00000000..c50cb9bb --- /dev/null +++ b/docs/v1/ontologies/models/OntologyStructTypeDict.md @@ -0,0 +1,12 @@ +# OntologyStructTypeDict + +OntologyStructType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**fields** | List[OntologyStructFieldDict] | Yes | | +**type** | Literal["struct"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OrQueryDict.md b/docs/v1/ontologies/models/OrQueryDict.md new file mode 100644 index 00000000..b309ee76 --- /dev/null +++ b/docs/v1/ontologies/models/OrQueryDict.md @@ -0,0 +1,12 @@ +# OrQueryDict + +Returns objects where at least 1 query is satisfied. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | List[SearchJsonQueryDict] | Yes | | +**type** | Literal["or"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/OrderBy.md b/docs/v1/ontologies/models/OrderBy.md new file mode 100644 index 00000000..7c0c8dfc --- /dev/null +++ b/docs/v1/ontologies/models/OrderBy.md @@ -0,0 +1,21 @@ +# OrderBy + +A command representing the list of properties to order by. Properties should be delimited by commas and +prefixed by `p` or `properties`. The format expected format is +`orderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...` + +By default, the ordering for a property is ascending, and this can be explicitly specified by appending +`:asc` (for ascending) or `:desc` (for descending). + +Example: use `orderBy=properties.lastName:asc` to order by a single property, +`orderBy=properties.lastName,properties.firstName,properties.age:desc` to order by multiple properties. +You may also use the shorthand `p` instead of `properties` such as `orderBy=p.lastName:asc`. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/Parameter.md b/docs/v1/ontologies/models/Parameter.md new file mode 100644 index 00000000..014811a6 --- /dev/null +++ b/docs/v1/ontologies/models/Parameter.md @@ -0,0 +1,14 @@ +# Parameter + +Details about a parameter of an action or query. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**description** | Optional[StrictStr] | No | | +**base_type** | ValueType | Yes | | +**data_type** | Optional[OntologyDataType] | No | | +**required** | StrictBool | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ParameterDict.md b/docs/v1/ontologies/models/ParameterDict.md new file mode 100644 index 00000000..ab979ef0 --- /dev/null +++ b/docs/v1/ontologies/models/ParameterDict.md @@ -0,0 +1,14 @@ +# ParameterDict + +Details about a parameter of an action or query. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**description** | NotRequired[StrictStr] | No | | +**baseType** | ValueType | Yes | | +**dataType** | NotRequired[OntologyDataTypeDict] | No | | +**required** | StrictBool | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ParameterEvaluatedConstraint.md b/docs/v1/ontologies/models/ParameterEvaluatedConstraint.md new file mode 100644 index 00000000..4b4a90d5 --- /dev/null +++ b/docs/v1/ontologies/models/ParameterEvaluatedConstraint.md @@ -0,0 +1,40 @@ +# ParameterEvaluatedConstraint + +A constraint that an action parameter value must satisfy in order to be considered valid. +Constraints can be configured on action parameters in the **Ontology Manager**. +Applicable constraints are determined dynamically based on parameter inputs. +Parameter values are evaluated against the final set of constraints. + +The type of the constraint. +| Type | Description | +|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | +| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | +| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | +| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | +| `oneOf` | The parameter has a manually predefined set of options. | +| `range` | The parameter value must be within the defined range. | +| `stringLength` | The parameter value must have a length within the defined range. | +| `stringRegexMatch` | The parameter value must match a predefined regular expression. | +| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +OneOfConstraint | oneOf +GroupMemberConstraint | groupMember +ObjectPropertyValueConstraint | objectPropertyValue +RangeConstraint | range +ArraySizeConstraint | arraySize +ObjectQueryResultConstraint | objectQueryResult +StringLengthConstraint | stringLength +StringRegexMatchConstraint | stringRegexMatch +UnevaluableConstraint | unevaluable + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ParameterEvaluatedConstraintDict.md b/docs/v1/ontologies/models/ParameterEvaluatedConstraintDict.md new file mode 100644 index 00000000..f4aa7d6c --- /dev/null +++ b/docs/v1/ontologies/models/ParameterEvaluatedConstraintDict.md @@ -0,0 +1,40 @@ +# ParameterEvaluatedConstraintDict + +A constraint that an action parameter value must satisfy in order to be considered valid. +Constraints can be configured on action parameters in the **Ontology Manager**. +Applicable constraints are determined dynamically based on parameter inputs. +Parameter values are evaluated against the final set of constraints. + +The type of the constraint. +| Type | Description | +|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | +| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | +| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | +| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | +| `oneOf` | The parameter has a manually predefined set of options. | +| `range` | The parameter value must be within the defined range. | +| `stringLength` | The parameter value must have a length within the defined range. | +| `stringRegexMatch` | The parameter value must match a predefined regular expression. | +| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +OneOfConstraintDict | oneOf +GroupMemberConstraintDict | groupMember +ObjectPropertyValueConstraintDict | objectPropertyValue +RangeConstraintDict | range +ArraySizeConstraintDict | arraySize +ObjectQueryResultConstraintDict | objectQueryResult +StringLengthConstraintDict | stringLength +StringRegexMatchConstraintDict | stringRegexMatch +UnevaluableConstraintDict | unevaluable + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ParameterEvaluationResult.md b/docs/v1/ontologies/models/ParameterEvaluationResult.md new file mode 100644 index 00000000..4abe6a7f --- /dev/null +++ b/docs/v1/ontologies/models/ParameterEvaluationResult.md @@ -0,0 +1,13 @@ +# ParameterEvaluationResult + +Represents the validity of a parameter against the configured constraints. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**result** | ValidationResult | Yes | | +**evaluated_constraints** | List[ParameterEvaluatedConstraint] | Yes | | +**required** | StrictBool | Yes | Represents whether the parameter is a required input to the action. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ParameterEvaluationResultDict.md b/docs/v1/ontologies/models/ParameterEvaluationResultDict.md new file mode 100644 index 00000000..608cc41e --- /dev/null +++ b/docs/v1/ontologies/models/ParameterEvaluationResultDict.md @@ -0,0 +1,13 @@ +# ParameterEvaluationResultDict + +Represents the validity of a parameter against the configured constraints. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**result** | ValidationResult | Yes | | +**evaluatedConstraints** | List[ParameterEvaluatedConstraintDict] | Yes | | +**required** | StrictBool | Yes | Represents whether the parameter is a required input to the action. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ParameterId.md b/docs/v1/ontologies/models/ParameterId.md new file mode 100644 index 00000000..a34f69c8 --- /dev/null +++ b/docs/v1/ontologies/models/ParameterId.md @@ -0,0 +1,13 @@ +# ParameterId + +The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied. +Parameters can be viewed and managed in the **Ontology Manager**. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ParameterOption.md b/docs/v1/ontologies/models/ParameterOption.md new file mode 100644 index 00000000..f7abdd48 --- /dev/null +++ b/docs/v1/ontologies/models/ParameterOption.md @@ -0,0 +1,13 @@ +# ParameterOption + +A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**display_name** | Optional[DisplayName] | No | | +**value** | Optional[Any] | No | An allowed configured value for a parameter within an action. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ParameterOptionDict.md b/docs/v1/ontologies/models/ParameterOptionDict.md new file mode 100644 index 00000000..a5d12f43 --- /dev/null +++ b/docs/v1/ontologies/models/ParameterOptionDict.md @@ -0,0 +1,13 @@ +# ParameterOptionDict + +A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**displayName** | NotRequired[DisplayName] | No | | +**value** | NotRequired[Any] | No | An allowed configured value for a parameter within an action. | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/PhraseQueryDict.md b/docs/v1/ontologies/models/PhraseQueryDict.md new file mode 100644 index 00000000..16981d4d --- /dev/null +++ b/docs/v1/ontologies/models/PhraseQueryDict.md @@ -0,0 +1,13 @@ +# PhraseQueryDict + +Returns objects where the specified field contains the provided value as a substring. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**value** | StrictStr | Yes | | +**type** | Literal["phrase"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/PrefixQueryDict.md b/docs/v1/ontologies/models/PrefixQueryDict.md new file mode 100644 index 00000000..dbfdec28 --- /dev/null +++ b/docs/v1/ontologies/models/PrefixQueryDict.md @@ -0,0 +1,13 @@ +# PrefixQueryDict + +Returns objects where the specified field starts with the provided value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**value** | StrictStr | Yes | | +**type** | Literal["prefix"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/Property.md b/docs/v1/ontologies/models/Property.md new file mode 100644 index 00000000..a5ee864b --- /dev/null +++ b/docs/v1/ontologies/models/Property.md @@ -0,0 +1,13 @@ +# Property + +Details about some property of an object. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**description** | Optional[StrictStr] | No | | +**display_name** | Optional[DisplayName] | No | | +**base_type** | ValueType | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/PropertyApiName.md b/docs/v1/ontologies/models/PropertyApiName.md new file mode 100644 index 00000000..b2d19d85 --- /dev/null +++ b/docs/v1/ontologies/models/PropertyApiName.md @@ -0,0 +1,13 @@ +# PropertyApiName + +The name of the property in the API. To find the API name for your property, use the `Get object type` +endpoint or check the **Ontology Manager**. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/PropertyDict.md b/docs/v1/ontologies/models/PropertyDict.md new file mode 100644 index 00000000..090f12f1 --- /dev/null +++ b/docs/v1/ontologies/models/PropertyDict.md @@ -0,0 +1,13 @@ +# PropertyDict + +Details about some property of an object. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**description** | NotRequired[StrictStr] | No | | +**displayName** | NotRequired[DisplayName] | No | | +**baseType** | ValueType | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/PropertyValue.md b/docs/v1/ontologies/models/PropertyValue.md new file mode 100644 index 00000000..1a7faf42 --- /dev/null +++ b/docs/v1/ontologies/models/PropertyValue.md @@ -0,0 +1,32 @@ +# PropertyValue + +Represents the value of a property in the following format. + +| Type | JSON encoding | Example | +|----------- |-------------------------------------------------------|----------------------------------------------------------------------------------------------------| +| Array | array | `["alpha", "bravo", "charlie"]` | +| Attachment | JSON encoded `AttachmentProperty` object | `{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}` | +| Boolean | boolean | `true` | +| Byte | number | `31` | +| Date | ISO 8601 extended local date string | `"2021-05-01"` | +| Decimal | string | `"2.718281828"` | +| Double | number | `3.14159265` | +| Float | number | `3.14159265` | +| GeoPoint | geojson | `{"type":"Point","coordinates":[102.0,0.5]}` | +| GeoShape | geojson | `{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` | +| Integer | number | `238940` | +| Long | string | `"58319870951433"` | +| Short | number | `8739` | +| String | string | `"Call me Ishmael"` | +| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | + +Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings. + + +## Type +```python +Any +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/PropertyValueEscapedString.md b/docs/v1/ontologies/models/PropertyValueEscapedString.md new file mode 100644 index 00000000..7875d960 --- /dev/null +++ b/docs/v1/ontologies/models/PropertyValueEscapedString.md @@ -0,0 +1,11 @@ +# PropertyValueEscapedString + +Represents the value of a property in string format. This is used in URL parameters. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/QueryApiName.md b/docs/v1/ontologies/models/QueryApiName.md new file mode 100644 index 00000000..a3005f73 --- /dev/null +++ b/docs/v1/ontologies/models/QueryApiName.md @@ -0,0 +1,12 @@ +# QueryApiName + +The name of the Query in the API. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/QueryType.md b/docs/v1/ontologies/models/QueryType.md new file mode 100644 index 00000000..43e9b27e --- /dev/null +++ b/docs/v1/ontologies/models/QueryType.md @@ -0,0 +1,17 @@ +# QueryType + +Represents a query type in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**api_name** | QueryApiName | Yes | | +**description** | Optional[StrictStr] | No | | +**display_name** | Optional[DisplayName] | No | | +**parameters** | Dict[ParameterId, Parameter] | Yes | | +**output** | Optional[OntologyDataType] | No | | +**rid** | FunctionRid | Yes | | +**version** | FunctionVersion | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/QueryTypeDict.md b/docs/v1/ontologies/models/QueryTypeDict.md new file mode 100644 index 00000000..5d84b429 --- /dev/null +++ b/docs/v1/ontologies/models/QueryTypeDict.md @@ -0,0 +1,17 @@ +# QueryTypeDict + +Represents a query type in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**apiName** | QueryApiName | Yes | | +**description** | NotRequired[StrictStr] | No | | +**displayName** | NotRequired[DisplayName] | No | | +**parameters** | Dict[ParameterId, ParameterDict] | Yes | | +**output** | NotRequired[OntologyDataTypeDict] | No | | +**rid** | FunctionRid | Yes | | +**version** | FunctionVersion | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/RangeConstraint.md b/docs/v1/ontologies/models/RangeConstraint.md new file mode 100644 index 00000000..65026017 --- /dev/null +++ b/docs/v1/ontologies/models/RangeConstraint.md @@ -0,0 +1,16 @@ +# RangeConstraint + +The parameter value must be within the defined range. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**lt** | Optional[Any] | No | Less than | +**lte** | Optional[Any] | No | Less than or equal | +**gt** | Optional[Any] | No | Greater than | +**gte** | Optional[Any] | No | Greater than or equal | +**type** | Literal["range"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/RangeConstraintDict.md b/docs/v1/ontologies/models/RangeConstraintDict.md new file mode 100644 index 00000000..e38be501 --- /dev/null +++ b/docs/v1/ontologies/models/RangeConstraintDict.md @@ -0,0 +1,16 @@ +# RangeConstraintDict + +The parameter value must be within the defined range. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**lt** | NotRequired[Any] | No | Less than | +**lte** | NotRequired[Any] | No | Less than or equal | +**gt** | NotRequired[Any] | No | Greater than | +**gte** | NotRequired[Any] | No | Greater than or equal | +**type** | Literal["range"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/SearchJsonQueryDict.md b/docs/v1/ontologies/models/SearchJsonQueryDict.md new file mode 100644 index 00000000..8c66ce6a --- /dev/null +++ b/docs/v1/ontologies/models/SearchJsonQueryDict.md @@ -0,0 +1,28 @@ +# SearchJsonQueryDict + +SearchJsonQuery + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +OrQueryDict | or +PrefixQueryDict | prefix +LtQueryDict | lt +AllTermsQueryDict | allTerms +EqualsQueryDict | eq +GtQueryDict | gt +ContainsQueryDict | contains +NotQueryDict | not +PhraseQueryDict | phrase +AndQueryDict | and +IsNullQueryDict | isNull +GteQueryDict | gte +AnyTermQueryDict | anyTerm +LteQueryDict | lte + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/SearchObjectsResponse.md b/docs/v1/ontologies/models/SearchObjectsResponse.md new file mode 100644 index 00000000..58c2996e --- /dev/null +++ b/docs/v1/ontologies/models/SearchObjectsResponse.md @@ -0,0 +1,13 @@ +# SearchObjectsResponse + +SearchObjectsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[OntologyObject] | Yes | | +**next_page_token** | Optional[PageToken] | No | | +**total_count** | TotalCount | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/SearchObjectsResponseDict.md b/docs/v1/ontologies/models/SearchObjectsResponseDict.md new file mode 100644 index 00000000..200c4bdc --- /dev/null +++ b/docs/v1/ontologies/models/SearchObjectsResponseDict.md @@ -0,0 +1,13 @@ +# SearchObjectsResponseDict + +SearchObjectsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[OntologyObjectDict] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | +**totalCount** | TotalCount | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/SearchOrderByDict.md b/docs/v1/ontologies/models/SearchOrderByDict.md new file mode 100644 index 00000000..2c52b8b1 --- /dev/null +++ b/docs/v1/ontologies/models/SearchOrderByDict.md @@ -0,0 +1,11 @@ +# SearchOrderByDict + +Specifies the ordering of search results by a field and an ordering direction. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**fields** | List[SearchOrderingDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/SearchOrderingDict.md b/docs/v1/ontologies/models/SearchOrderingDict.md new file mode 100644 index 00000000..588316c4 --- /dev/null +++ b/docs/v1/ontologies/models/SearchOrderingDict.md @@ -0,0 +1,12 @@ +# SearchOrderingDict + +SearchOrdering + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**direction** | NotRequired[StrictStr] | No | Specifies the ordering direction (can be either `asc` or `desc`) | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/SelectedPropertyApiName.md b/docs/v1/ontologies/models/SelectedPropertyApiName.md new file mode 100644 index 00000000..f83fdf5b --- /dev/null +++ b/docs/v1/ontologies/models/SelectedPropertyApiName.md @@ -0,0 +1,26 @@ +# SelectedPropertyApiName + +By default, anytime an object is requested, every property belonging to that object is returned. +The response can be filtered to only include certain properties using the `properties` query parameter. + +Properties to include can be specified in one of two ways. + +- A comma delimited list as the value for the `properties` query parameter + `properties={property1ApiName},{property2ApiName}` +- Multiple `properties` query parameters. + `properties={property1ApiName}&properties={property2ApiName}` + +The primary key of the object will always be returned even if it wasn't specified in the `properties` values. + +Unknown properties specified in the `properties` list will result in a `PropertiesNotFound` error. + +To find the API name for your property, use the `Get object type` endpoint or check the **Ontology Manager**. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/StringLengthConstraint.md b/docs/v1/ontologies/models/StringLengthConstraint.md new file mode 100644 index 00000000..89081a91 --- /dev/null +++ b/docs/v1/ontologies/models/StringLengthConstraint.md @@ -0,0 +1,17 @@ +# StringLengthConstraint + +The parameter value must have a length within the defined range. +*This range is always inclusive.* + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**lt** | Optional[Any] | No | Less than | +**lte** | Optional[Any] | No | Less than or equal | +**gt** | Optional[Any] | No | Greater than | +**gte** | Optional[Any] | No | Greater than or equal | +**type** | Literal["stringLength"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/StringLengthConstraintDict.md b/docs/v1/ontologies/models/StringLengthConstraintDict.md new file mode 100644 index 00000000..d6c76119 --- /dev/null +++ b/docs/v1/ontologies/models/StringLengthConstraintDict.md @@ -0,0 +1,17 @@ +# StringLengthConstraintDict + +The parameter value must have a length within the defined range. +*This range is always inclusive.* + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**lt** | NotRequired[Any] | No | Less than | +**lte** | NotRequired[Any] | No | Less than or equal | +**gt** | NotRequired[Any] | No | Greater than | +**gte** | NotRequired[Any] | No | Greater than or equal | +**type** | Literal["stringLength"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/StringRegexMatchConstraint.md b/docs/v1/ontologies/models/StringRegexMatchConstraint.md new file mode 100644 index 00000000..f6d9e669 --- /dev/null +++ b/docs/v1/ontologies/models/StringRegexMatchConstraint.md @@ -0,0 +1,14 @@ +# StringRegexMatchConstraint + +The parameter value must match a predefined regular expression. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**regex** | StrictStr | Yes | The regular expression configured in the **Ontology Manager**. | +**configured_failure_message** | Optional[StrictStr] | No | The message indicating that the regular expression was not matched. This is configured per parameter in the **Ontology Manager**. | +**type** | Literal["stringRegexMatch"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/StringRegexMatchConstraintDict.md b/docs/v1/ontologies/models/StringRegexMatchConstraintDict.md new file mode 100644 index 00000000..489a7259 --- /dev/null +++ b/docs/v1/ontologies/models/StringRegexMatchConstraintDict.md @@ -0,0 +1,14 @@ +# StringRegexMatchConstraintDict + +The parameter value must match a predefined regular expression. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**regex** | StrictStr | Yes | The regular expression configured in the **Ontology Manager**. | +**configuredFailureMessage** | NotRequired[StrictStr] | No | The message indicating that the regular expression was not matched. This is configured per parameter in the **Ontology Manager**. | +**type** | Literal["stringRegexMatch"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/SubmissionCriteriaEvaluation.md b/docs/v1/ontologies/models/SubmissionCriteriaEvaluation.md new file mode 100644 index 00000000..dea81eb8 --- /dev/null +++ b/docs/v1/ontologies/models/SubmissionCriteriaEvaluation.md @@ -0,0 +1,15 @@ +# SubmissionCriteriaEvaluation + +Contains the status of the **submission criteria**. +**Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. +These are configured in the **Ontology Manager**. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**configured_failure_message** | Optional[StrictStr] | No | The message indicating one of the **submission criteria** was not satisfied. This is configured per **submission criteria** in the **Ontology Manager**. | +**result** | ValidationResult | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/SubmissionCriteriaEvaluationDict.md b/docs/v1/ontologies/models/SubmissionCriteriaEvaluationDict.md new file mode 100644 index 00000000..89110ece --- /dev/null +++ b/docs/v1/ontologies/models/SubmissionCriteriaEvaluationDict.md @@ -0,0 +1,15 @@ +# SubmissionCriteriaEvaluationDict + +Contains the status of the **submission criteria**. +**Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. +These are configured in the **Ontology Manager**. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**configuredFailureMessage** | NotRequired[StrictStr] | No | The message indicating one of the **submission criteria** was not satisfied. This is configured per **submission criteria** in the **Ontology Manager**. | +**result** | ValidationResult | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/SumAggregationDict.md b/docs/v1/ontologies/models/SumAggregationDict.md new file mode 100644 index 00000000..004cb613 --- /dev/null +++ b/docs/v1/ontologies/models/SumAggregationDict.md @@ -0,0 +1,13 @@ +# SumAggregationDict + +Computes the sum of values for the provided field. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | FieldNameV1 | Yes | | +**name** | NotRequired[AggregationMetricName] | No | | +**type** | Literal["sum"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/UnevaluableConstraint.md b/docs/v1/ontologies/models/UnevaluableConstraint.md new file mode 100644 index 00000000..d155f31f --- /dev/null +++ b/docs/v1/ontologies/models/UnevaluableConstraint.md @@ -0,0 +1,13 @@ +# UnevaluableConstraint + +The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. +This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["unevaluable"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/UnevaluableConstraintDict.md b/docs/v1/ontologies/models/UnevaluableConstraintDict.md new file mode 100644 index 00000000..8676ae72 --- /dev/null +++ b/docs/v1/ontologies/models/UnevaluableConstraintDict.md @@ -0,0 +1,13 @@ +# UnevaluableConstraintDict + +The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. +This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["unevaluable"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ValidateActionResponse.md b/docs/v1/ontologies/models/ValidateActionResponse.md new file mode 100644 index 00000000..fbb0e911 --- /dev/null +++ b/docs/v1/ontologies/models/ValidateActionResponse.md @@ -0,0 +1,13 @@ +# ValidateActionResponse + +ValidateActionResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**result** | ValidationResult | Yes | | +**submission_criteria** | List[SubmissionCriteriaEvaluation] | Yes | | +**parameters** | Dict[ParameterId, ParameterEvaluationResult] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ValidateActionResponseDict.md b/docs/v1/ontologies/models/ValidateActionResponseDict.md new file mode 100644 index 00000000..5b69791c --- /dev/null +++ b/docs/v1/ontologies/models/ValidateActionResponseDict.md @@ -0,0 +1,13 @@ +# ValidateActionResponseDict + +ValidateActionResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**result** | ValidationResult | Yes | | +**submissionCriteria** | List[SubmissionCriteriaEvaluationDict] | Yes | | +**parameters** | Dict[ParameterId, ParameterEvaluationResultDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ValidationResult.md b/docs/v1/ontologies/models/ValidationResult.md new file mode 100644 index 00000000..bf5f86d0 --- /dev/null +++ b/docs/v1/ontologies/models/ValidationResult.md @@ -0,0 +1,12 @@ +# ValidationResult + +Represents the state of a validation. + + +| **Value** | +| --------- | +| `"VALID"` | +| `"INVALID"` | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/ValueType.md b/docs/v1/ontologies/models/ValueType.md new file mode 100644 index 00000000..ce8c5601 --- /dev/null +++ b/docs/v1/ontologies/models/ValueType.md @@ -0,0 +1,33 @@ +# ValueType + +A string indicating the type of each data value. Note that these types can be nested, for example an array of +structs. + +| Type | JSON value | +|---------------------|-------------------------------------------------------------------------------------------------------------------| +| Array | `Array`, where `T` is the type of the array elements, e.g. `Array`. | +| Attachment | `Attachment` | +| Boolean | `Boolean` | +| Byte | `Byte` | +| Date | `LocalDate` | +| Decimal | `Decimal` | +| Double | `Double` | +| Float | `Float` | +| Integer | `Integer` | +| Long | `Long` | +| Marking | `Marking` | +| OntologyObject | `OntologyObject` where `T` is the API name of the referenced object type. | +| Short | `Short` | +| String | `String` | +| Struct | `Struct` where `T` contains field name and type pairs, e.g. `Struct<{ firstName: String, lastName: string }>` | +| Timeseries | `TimeSeries` where `T` is either `String` for an enum series or `Double` for a numeric series. | +| Timestamp | `Timestamp` | + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/Admin/Group.md b/docs/v2/Admin/Group.md new file mode 100644 index 00000000..3f8f1946 --- /dev/null +++ b/docs/v2/Admin/Group.md @@ -0,0 +1,426 @@ +# Group + +Method | HTTP request | +------------- | ------------- | +[**create**](#create) | **POST** /v2/admin/groups | +[**delete**](#delete) | **DELETE** /v2/admin/groups/{groupId} | +[**get**](#get) | **GET** /v2/admin/groups/{groupId} | +[**get_batch**](#get_batch) | **POST** /v2/admin/groups/getBatch | +[**list**](#list) | **GET** /v2/admin/groups | +[**page**](#page) | **GET** /v2/admin/groups | +[**search**](#search) | **POST** /v2/admin/groups/search | + +# **create** +Creates a new Group. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**attributes** | Dict[AttributeName, AttributeValues] | A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. | | +**name** | GroupName | The name of the Group. | | +**organizations** | List[OrganizationRid] | The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed. | | +**description** | Optional[StrictStr] | A description of the Group. | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Group** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# Dict[AttributeName, AttributeValues] | A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. +attributes = None +# GroupName | The name of the Group. +name = "Data Source Admins" +# List[OrganizationRid] | The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed. +organizations = ["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"] +# Optional[StrictStr] | A description of the Group. +description = "Create and modify data sources in the platform" +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.Group.create( + attributes=attributes, + name=name, + organizations=organizations, + description=description, + preview=preview, + ) + print("The create response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Group.create: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Group | The created Group | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **delete** +Delete the Group with the specified id. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**group_id** | PrincipalId | groupId | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# PrincipalId | groupId +group_id = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.Group.delete( + group_id, + preview=preview, + ) + print("The delete response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Group.delete: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get** +Get the Group with the specified id. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**group_id** | PrincipalId | groupId | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Group** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# PrincipalId | groupId +group_id = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.Group.get( + group_id, + preview=preview, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Group.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Group | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get_batch** +Execute multiple get requests on Group. + +The maximum batch size for this endpoint is 500. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**body** | List[GetGroupsBatchRequestElementDict] | Body of the request | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**GetGroupsBatchResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# List[GetGroupsBatchRequestElementDict] | Body of the request +body = {"groupId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"} +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.Group.get_batch( + body, + preview=preview, + ) + print("The get_batch response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Group.get_batch: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | GetGroupsBatchResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **list** +Lists all Groups. + +This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ResourceIterator[Group]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# Optional[PageSize] | pageSize +page_size = None +# Optional[PreviewMode] | preview +preview = None + + +try: + for group in foundry_client.admin.Group.list( + page_size=page_size, + preview=preview, + ): + pprint(group) +except PalantirRPCException as e: + print("HTTP error when calling Group.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListGroupsResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **page** +Lists all Groups. + +This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ListGroupsResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.Group.page( + page_size=page_size, + page_token=page_token, + preview=preview, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Group.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListGroupsResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **search** + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**where** | GroupSearchFilterDict | | | +**page_size** | Optional[PageSize] | | [optional] | +**page_token** | Optional[PageToken] | | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**SearchGroupsResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# GroupSearchFilterDict | +where = {"type": "queryString"} +# Optional[PageSize] | +page_size = 100 +# Optional[PageToken] | +page_token = "v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv" +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.Group.search( + where=where, + page_size=page_size, + page_token=page_token, + preview=preview, + ) + print("The search response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Group.search: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | SearchGroupsResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/Admin/GroupMember.md b/docs/v2/Admin/GroupMember.md new file mode 100644 index 00000000..1a1a17ea --- /dev/null +++ b/docs/v2/Admin/GroupMember.md @@ -0,0 +1,264 @@ +# GroupMember + +Method | HTTP request | +------------- | ------------- | +[**add**](#add) | **POST** /v2/admin/groups/{groupId}/groupMembers/add | +[**list**](#list) | **GET** /v2/admin/groups/{groupId}/groupMembers | +[**page**](#page) | **GET** /v2/admin/groups/{groupId}/groupMembers | +[**remove**](#remove) | **POST** /v2/admin/groups/{groupId}/groupMembers/remove | + +# **add** + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**group_id** | PrincipalId | groupId | | +**principal_ids** | List[PrincipalId] | | | +**expiration** | Optional[GroupMembershipExpiration] | | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# PrincipalId | groupId +group_id = None +# List[PrincipalId] | +principal_ids = ["f05f8da4-b84c-4fca-9c77-8af0b13d11de"] +# Optional[GroupMembershipExpiration] | +expiration = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.Group.GroupMember.add( + group_id, + principal_ids=principal_ids, + expiration=expiration, + preview=preview, + ) + print("The add response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling GroupMember.add: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **list** +Lists all GroupMembers. + +This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**group_id** | PrincipalId | groupId | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**transitive** | Optional[StrictBool] | transitive | [optional] | + +### Return type +**ResourceIterator[GroupMember]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# PrincipalId | groupId +group_id = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[PreviewMode] | preview +preview = None +# Optional[StrictBool] | transitive +transitive = None + + +try: + for group_member in foundry_client.admin.Group.GroupMember.list( + group_id, + page_size=page_size, + preview=preview, + transitive=transitive, + ): + pprint(group_member) +except PalantirRPCException as e: + print("HTTP error when calling GroupMember.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListGroupMembersResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **page** +Lists all GroupMembers. + +This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**group_id** | PrincipalId | groupId | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**transitive** | Optional[StrictBool] | transitive | [optional] | + +### Return type +**ListGroupMembersResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# PrincipalId | groupId +group_id = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[PreviewMode] | preview +preview = None +# Optional[StrictBool] | transitive +transitive = None + + +try: + api_response = foundry_client.admin.Group.GroupMember.page( + group_id, + page_size=page_size, + page_token=page_token, + preview=preview, + transitive=transitive, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling GroupMember.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListGroupMembersResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **remove** + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**group_id** | PrincipalId | groupId | | +**principal_ids** | List[PrincipalId] | | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# PrincipalId | groupId +group_id = None +# List[PrincipalId] | +principal_ids = ["f05f8da4-b84c-4fca-9c77-8af0b13d11de"] +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.Group.GroupMember.remove( + group_id, + principal_ids=principal_ids, + preview=preview, + ) + print("The remove response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling GroupMember.remove: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/Admin/GroupMembership.md b/docs/v2/Admin/GroupMembership.md new file mode 100644 index 00000000..ec0fb4c9 --- /dev/null +++ b/docs/v2/Admin/GroupMembership.md @@ -0,0 +1,140 @@ +# GroupMembership + +Method | HTTP request | +------------- | ------------- | +[**list**](#list) | **GET** /v2/admin/users/{userId}/groupMemberships | +[**page**](#page) | **GET** /v2/admin/users/{userId}/groupMemberships | + +# **list** +Lists all GroupMemberships. + +This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**user_id** | PrincipalId | userId | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**transitive** | Optional[StrictBool] | transitive | [optional] | + +### Return type +**ResourceIterator[GroupMembership]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# PrincipalId | userId +user_id = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[PreviewMode] | preview +preview = None +# Optional[StrictBool] | transitive +transitive = None + + +try: + for group_membership in foundry_client.admin.User.GroupMembership.list( + user_id, + page_size=page_size, + preview=preview, + transitive=transitive, + ): + pprint(group_membership) +except PalantirRPCException as e: + print("HTTP error when calling GroupMembership.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListGroupMembershipsResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **page** +Lists all GroupMemberships. + +This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**user_id** | PrincipalId | userId | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**transitive** | Optional[StrictBool] | transitive | [optional] | + +### Return type +**ListGroupMembershipsResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# PrincipalId | userId +user_id = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[PreviewMode] | preview +preview = None +# Optional[StrictBool] | transitive +transitive = None + + +try: + api_response = foundry_client.admin.User.GroupMembership.page( + user_id, + page_size=page_size, + page_token=page_token, + preview=preview, + transitive=transitive, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling GroupMembership.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListGroupMembershipsResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/Admin/Marking.md b/docs/v2/Admin/Marking.md new file mode 100644 index 00000000..f1fb439e --- /dev/null +++ b/docs/v2/Admin/Marking.md @@ -0,0 +1,170 @@ +# Marking + +Method | HTTP request | +------------- | ------------- | + +Get the Marking with the specified id. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**marking_id** | MarkingId | markingId | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Marking** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# MarkingId | markingId +marking_id = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.Marking.get( + marking_id, + preview=preview, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Marking.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Marking | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +Maximum page size 100. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ResourceIterator[Marking]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# Optional[PageSize] | pageSize +page_size = None +# Optional[PreviewMode] | preview +preview = None + + +try: + for marking in foundry_client.admin.Marking.list( + page_size=page_size, + preview=preview, + ): + pprint(marking) +except PalantirRPCException as e: + print("HTTP error when calling Marking.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListMarkingsResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +Maximum page size 100. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ListMarkingsResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.Marking.page( + page_size=page_size, + page_token=page_token, + preview=preview, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Marking.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListMarkingsResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/Admin/MarkingCategory.md b/docs/v2/Admin/MarkingCategory.md new file mode 100644 index 00000000..a510be77 --- /dev/null +++ b/docs/v2/Admin/MarkingCategory.md @@ -0,0 +1,170 @@ +# MarkingCategory + +Method | HTTP request | +------------- | ------------- | + +Get the MarkingCategory with the specified id. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**marking_category_id** | MarkingCategoryId | markingCategoryId | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**MarkingCategory** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# MarkingCategoryId | markingCategoryId +marking_category_id = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.MarkingCategory.get( + marking_category_id, + preview=preview, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling MarkingCategory.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | MarkingCategory | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +Maximum page size 100. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ResourceIterator[MarkingCategory]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# Optional[PageSize] | pageSize +page_size = None +# Optional[PreviewMode] | preview +preview = None + + +try: + for marking_category in foundry_client.admin.MarkingCategory.list( + page_size=page_size, + preview=preview, + ): + pprint(marking_category) +except PalantirRPCException as e: + print("HTTP error when calling MarkingCategory.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListMarkingCategoriesResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +Maximum page size 100. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ListMarkingCategoriesResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.MarkingCategory.page( + page_size=page_size, + page_token=page_token, + preview=preview, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling MarkingCategory.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListMarkingCategoriesResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/Admin/User.md b/docs/v2/Admin/User.md new file mode 100644 index 00000000..2a3d0b7c --- /dev/null +++ b/docs/v2/Admin/User.md @@ -0,0 +1,520 @@ +# User + +Method | HTTP request | +------------- | ------------- | +[**delete**](#delete) | **DELETE** /v2/admin/users/{userId} | +[**get**](#get) | **GET** /v2/admin/users/{userId} | +[**get_batch**](#get_batch) | **POST** /v2/admin/users/getBatch | +[**get_current**](#get_current) | **GET** /v2/admin/users/getCurrent | +[**list**](#list) | **GET** /v2/admin/users | +[**page**](#page) | **GET** /v2/admin/users | +[**profile_picture**](#profile_picture) | **GET** /v2/admin/users/{userId}/profilePicture | +[**search**](#search) | **POST** /v2/admin/users/search | + +# **delete** +Delete the User with the specified id. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**user_id** | PrincipalId | userId | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# PrincipalId | userId +user_id = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.User.delete( + user_id, + preview=preview, + ) + print("The delete response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling User.delete: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get** +Get the User with the specified id. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**user_id** | PrincipalId | userId | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**User** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# PrincipalId | userId +user_id = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.User.get( + user_id, + preview=preview, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling User.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | User | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get_batch** +Execute multiple get requests on User. + +The maximum batch size for this endpoint is 500. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**body** | List[GetUsersBatchRequestElementDict] | Body of the request | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**GetUsersBatchResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# List[GetUsersBatchRequestElementDict] | Body of the request +body = {"userId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"} +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.User.get_batch( + body, + preview=preview, + ) + print("The get_batch response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling User.get_batch: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | GetUsersBatchResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get_current** + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**User** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.User.get_current( + preview=preview, + ) + print("The get_current response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling User.get_current: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | User | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +Retrieve Markings that the user is currently a member of. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**user_id** | PrincipalId | userId | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**GetUserMarkingsResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# PrincipalId | userId +user_id = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.User.get_markings( + user_id, + preview=preview, + ) + print("The get_markings response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling User.get_markings: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | GetUserMarkingsResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **list** +Lists all Users. + +This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ResourceIterator[User]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# Optional[PageSize] | pageSize +page_size = None +# Optional[PreviewMode] | preview +preview = None + + +try: + for user in foundry_client.admin.User.list( + page_size=page_size, + preview=preview, + ): + pprint(user) +except PalantirRPCException as e: + print("HTTP error when calling User.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListUsersResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **page** +Lists all Users. + +This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ListUsersResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.User.page( + page_size=page_size, + page_token=page_token, + preview=preview, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling User.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListUsersResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **profile_picture** + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**user_id** | PrincipalId | userId | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**bytes** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# PrincipalId | userId +user_id = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.User.profile_picture( + user_id, + preview=preview, + ) + print("The profile_picture response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling User.profile_picture: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | bytes | The user's profile picture in binary format. The format is the original format uploaded by the user. The response will contain a `Content-Type` header that can be used to identify the media type. | application/octet-stream | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **search** + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**where** | UserSearchFilterDict | | | +**page_size** | Optional[PageSize] | | [optional] | +**page_token** | Optional[PageToken] | | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**SearchUsersResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# UserSearchFilterDict | +where = {"type": "queryString"} +# Optional[PageSize] | +page_size = 100 +# Optional[PageToken] | +page_token = "v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv" +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.admin.User.search( + where=where, + page_size=page_size, + page_token=page_token, + preview=preview, + ) + print("The search response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling User.search: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | SearchUsersResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/Datasets/Branch.md b/docs/v2/Datasets/Branch.md new file mode 100644 index 00000000..648e0693 --- /dev/null +++ b/docs/v2/Datasets/Branch.md @@ -0,0 +1,317 @@ +# Branch + +Method | HTTP request | +------------- | ------------- | +[**create**](#create) | **POST** /v2/datasets/{datasetRid}/branches | +[**delete**](#delete) | **DELETE** /v2/datasets/{datasetRid}/branches/{branchName} | +[**get**](#get) | **GET** /v2/datasets/{datasetRid}/branches/{branchName} | +[**list**](#list) | **GET** /v2/datasets/{datasetRid}/branches | +[**page**](#page) | **GET** /v2/datasets/{datasetRid}/branches | + +# **create** +Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**name** | BranchName | | | +**preview** | Optional[PreviewMode] | preview | [optional] | +**transaction_rid** | Optional[TransactionRid] | | [optional] | + +### Return type +**Branch** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# BranchName | +name = "master" +# Optional[PreviewMode] | preview +preview = None +# Optional[TransactionRid] | +transaction_rid = "ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4" + + +try: + api_response = foundry_client.datasets.Dataset.Branch.create( + dataset_rid, + name=name, + preview=preview, + transaction_rid=transaction_rid, + ) + print("The create response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Branch.create: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Branch | The created Branch | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **delete** +Deletes the Branch with the given BranchName. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**branch_name** | BranchName | branchName | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# BranchName | branchName +branch_name = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.datasets.Dataset.Branch.delete( + dataset_rid, + branch_name, + preview=preview, + ) + print("The delete response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Branch.delete: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get** +Get a Branch of a Dataset. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**branch_name** | BranchName | branchName | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Branch** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# BranchName | branchName +branch_name = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.datasets.Dataset.Branch.get( + dataset_rid, + branch_name, + preview=preview, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Branch.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Branch | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **list** +Lists the Branches of a Dataset. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ResourceIterator[Branch]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[PreviewMode] | preview +preview = None + + +try: + for branch in foundry_client.datasets.Dataset.Branch.list( + dataset_rid, + page_size=page_size, + preview=preview, + ): + pprint(branch) +except PalantirRPCException as e: + print("HTTP error when calling Branch.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListBranchesResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **page** +Lists the Branches of a Dataset. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ListBranchesResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.datasets.Dataset.Branch.page( + dataset_rid, + page_size=page_size, + page_token=page_token, + preview=preview, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Branch.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListBranchesResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/Datasets/Dataset.md b/docs/v2/Datasets/Dataset.md new file mode 100644 index 00000000..3c9369e6 --- /dev/null +++ b/docs/v2/Datasets/Dataset.md @@ -0,0 +1,205 @@ +# Dataset + +Method | HTTP request | +------------- | ------------- | +[**create**](#create) | **POST** /v2/datasets | +[**get**](#get) | **GET** /v2/datasets/{datasetRid} | +[**read_table**](#read_table) | **GET** /v2/datasets/{datasetRid}/readTable | + +# **create** +Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**name** | DatasetName | | | +**parent_folder_rid** | FolderRid | | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Dataset** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetName | +name = None +# FolderRid | +parent_folder_rid = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.datasets.Dataset.create( + name=name, + parent_folder_rid=parent_folder_rid, + preview=preview, + ) + print("The create response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Dataset.create: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Dataset | The created Dataset | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get** +Get the Dataset with the specified rid. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Dataset** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.datasets.Dataset.get( + dataset_rid, + preview=preview, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Dataset.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Dataset | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **read_table** +Gets the content of a dataset as a table in the specified format. + +This endpoint currently does not support views (Virtual datasets composed of other datasets). + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**format** | TableExportFormat | format | | +**branch_name** | Optional[BranchName] | branchName | [optional] | +**columns** | Optional[List[StrictStr]] | columns | [optional] | +**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**row_limit** | Optional[StrictInt] | rowLimit | [optional] | +**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | + +### Return type +**bytes** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# TableExportFormat | format +format = None +# Optional[BranchName] | branchName +branch_name = None +# Optional[List[StrictStr]] | columns +columns = None +# Optional[TransactionRid] | endTransactionRid +end_transaction_rid = None +# Optional[PreviewMode] | preview +preview = None +# Optional[StrictInt] | rowLimit +row_limit = None +# Optional[TransactionRid] | startTransactionRid +start_transaction_rid = None + + +try: + api_response = foundry_client.datasets.Dataset.read_table( + dataset_rid, + format=format, + branch_name=branch_name, + columns=columns, + end_transaction_rid=end_transaction_rid, + preview=preview, + row_limit=row_limit, + start_transaction_rid=start_transaction_rid, + ) + print("The read_table response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Dataset.read_table: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | bytes | | application/octet-stream | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/Datasets/File.md b/docs/v2/Datasets/File.md new file mode 100644 index 00000000..5120f868 --- /dev/null +++ b/docs/v2/Datasets/File.md @@ -0,0 +1,532 @@ +# File + +Method | HTTP request | +------------- | ------------- | +[**content**](#content) | **GET** /v2/datasets/{datasetRid}/files/{filePath}/content | +[**delete**](#delete) | **DELETE** /v2/datasets/{datasetRid}/files/{filePath} | +[**get**](#get) | **GET** /v2/datasets/{datasetRid}/files/{filePath} | +[**list**](#list) | **GET** /v2/datasets/{datasetRid}/files | +[**page**](#page) | **GET** /v2/datasets/{datasetRid}/files | +[**upload**](#upload) | **POST** /v2/datasets/{datasetRid}/files/{filePath}/upload | + +# **content** +Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest +view of the default branch - `master` for most enrollments. +#### Advanced Usage +See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +To **get a file's content from a specific Branch** specify the Branch's name as `branchName`. This will +retrieve the content for the most recent version of the file since the latest snapshot transaction, or the +earliest ancestor transaction of the branch if there are no snapshot transactions. +To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier +as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest +snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions. +To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's +resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. +This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the +`endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior +is undefined when the start and end transactions do not belong to the same root-to-leaf path. +To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the +`startTransactionRid` and `endTransactionRid`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**file_path** | FilePath | filePath | | +**branch_name** | Optional[BranchName] | branchName | [optional] | +**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | + +### Return type +**bytes** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# FilePath | filePath +file_path = None +# Optional[BranchName] | branchName +branch_name = None +# Optional[TransactionRid] | endTransactionRid +end_transaction_rid = None +# Optional[PreviewMode] | preview +preview = None +# Optional[TransactionRid] | startTransactionRid +start_transaction_rid = None + + +try: + api_response = foundry_client.datasets.Dataset.File.content( + dataset_rid, + file_path, + branch_name=branch_name, + end_transaction_rid=end_transaction_rid, + preview=preview, + start_transaction_rid=start_transaction_rid, + ) + print("The content response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling File.content: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | bytes | | application/octet-stream | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **delete** +Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default +branch - `master` for most enrollments. The file will still be visible on historical views. +#### Advanced Usage +See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +To **delete a File from a specific Branch** specify the Branch's name as `branchName`. A new delete Transaction +will be created and committed on this branch. +To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier +as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a +single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to +open a transaction. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**file_path** | FilePath | filePath | | +**branch_name** | Optional[BranchName] | branchName | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**transaction_rid** | Optional[TransactionRid] | transactionRid | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# FilePath | filePath +file_path = None +# Optional[BranchName] | branchName +branch_name = None +# Optional[PreviewMode] | preview +preview = None +# Optional[TransactionRid] | transactionRid +transaction_rid = None + + +try: + api_response = foundry_client.datasets.Dataset.File.delete( + dataset_rid, + file_path, + branch_name=branch_name, + preview=preview, + transaction_rid=transaction_rid, + ) + print("The delete response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling File.delete: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get** +Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest +view of the default branch - `master` for most enrollments. +#### Advanced Usage +See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +To **get a file's metadata from a specific Branch** specify the Branch's name as `branchName`. This will +retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest +ancestor transaction of the branch if there are no snapshot transactions. +To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier +as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot +transaction, or the earliest ancestor transaction if there are no snapshot transactions. +To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's +resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. +This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the +`endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path. +To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the +`startTransactionRid` and `endTransactionRid`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**file_path** | FilePath | filePath | | +**branch_name** | Optional[BranchName] | branchName | [optional] | +**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | + +### Return type +**File** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# FilePath | filePath +file_path = None +# Optional[BranchName] | branchName +branch_name = None +# Optional[TransactionRid] | endTransactionRid +end_transaction_rid = None +# Optional[PreviewMode] | preview +preview = None +# Optional[TransactionRid] | startTransactionRid +start_transaction_rid = None + + +try: + api_response = foundry_client.datasets.Dataset.File.get( + dataset_rid, + file_path, + branch_name=branch_name, + end_transaction_rid=end_transaction_rid, + preview=preview, + start_transaction_rid=start_transaction_rid, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling File.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | File | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **list** +Lists Files contained in a Dataset. By default files are listed on the latest view of the default +branch - `master` for most enrollments. +#### Advanced Usage +See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most +recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the +branch if there are no snapshot transactions. +To **list files on the resolved view of a transaction** specify the Transaction's resource identifier +as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot +transaction, or the earliest ancestor transaction if there are no snapshot transactions. +To **list files on the resolved view of a range of transactions** specify the the start transaction's resource +identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This +will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. +Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when +the start and end transactions do not belong to the same root-to-leaf path. +To **list files on a specific transaction** specify the Transaction's resource identifier as both the +`startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that +Transaction. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**branch_name** | Optional[BranchName] | branchName | [optional] | +**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | + +### Return type +**ResourceIterator[File]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# Optional[BranchName] | branchName +branch_name = None +# Optional[TransactionRid] | endTransactionRid +end_transaction_rid = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[PreviewMode] | preview +preview = None +# Optional[TransactionRid] | startTransactionRid +start_transaction_rid = None + + +try: + for file in foundry_client.datasets.Dataset.File.list( + dataset_rid, + branch_name=branch_name, + end_transaction_rid=end_transaction_rid, + page_size=page_size, + preview=preview, + start_transaction_rid=start_transaction_rid, + ): + pprint(file) +except PalantirRPCException as e: + print("HTTP error when calling File.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListFilesResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **page** +Lists Files contained in a Dataset. By default files are listed on the latest view of the default +branch - `master` for most enrollments. +#### Advanced Usage +See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most +recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the +branch if there are no snapshot transactions. +To **list files on the resolved view of a transaction** specify the Transaction's resource identifier +as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot +transaction, or the earliest ancestor transaction if there are no snapshot transactions. +To **list files on the resolved view of a range of transactions** specify the the start transaction's resource +identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This +will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. +Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when +the start and end transactions do not belong to the same root-to-leaf path. +To **list files on a specific transaction** specify the Transaction's resource identifier as both the +`startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that +Transaction. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**branch_name** | Optional[BranchName] | branchName | [optional] | +**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | + +### Return type +**ListFilesResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# Optional[BranchName] | branchName +branch_name = None +# Optional[TransactionRid] | endTransactionRid +end_transaction_rid = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[PreviewMode] | preview +preview = None +# Optional[TransactionRid] | startTransactionRid +start_transaction_rid = None + + +try: + api_response = foundry_client.datasets.Dataset.File.page( + dataset_rid, + branch_name=branch_name, + end_transaction_rid=end_transaction_rid, + page_size=page_size, + page_token=page_token, + preview=preview, + start_transaction_rid=start_transaction_rid, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling File.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListFilesResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **upload** +Uploads a File to an existing Dataset. +The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. +By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments. +If the file already exists only the most recent version will be visible in the updated view. +#### Advanced Usage +See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. +To **upload a file to a specific Branch** specify the Branch's name as `branchName`. A new transaction will +be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this +default specify `transactionType` in addition to `branchName`. +See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. +To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as +`transactionRid`. This is useful for uploading multiple files in a single transaction. +See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**file_path** | FilePath | filePath | | +**body** | bytes | Body of the request | | +**branch_name** | Optional[BranchName] | branchName | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**transaction_rid** | Optional[TransactionRid] | transactionRid | [optional] | +**transaction_type** | Optional[TransactionType] | transactionType | [optional] | + +### Return type +**File** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# FilePath | filePath +file_path = None +# bytes | Body of the request +body = None +# Optional[BranchName] | branchName +branch_name = None +# Optional[PreviewMode] | preview +preview = None +# Optional[TransactionRid] | transactionRid +transaction_rid = None +# Optional[TransactionType] | transactionType +transaction_type = None + + +try: + api_response = foundry_client.datasets.Dataset.File.upload( + dataset_rid, + file_path, + body, + branch_name=branch_name, + preview=preview, + transaction_rid=transaction_rid, + transaction_type=transaction_type, + ) + print("The upload response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling File.upload: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | File | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/Datasets/Transaction.md b/docs/v2/Datasets/Transaction.md new file mode 100644 index 00000000..94101533 --- /dev/null +++ b/docs/v2/Datasets/Transaction.md @@ -0,0 +1,277 @@ +# Transaction + +Method | HTTP request | +------------- | ------------- | +[**abort**](#abort) | **POST** /v2/datasets/{datasetRid}/transactions/{transactionRid}/abort | +[**commit**](#commit) | **POST** /v2/datasets/{datasetRid}/transactions/{transactionRid}/commit | +[**create**](#create) | **POST** /v2/datasets/{datasetRid}/transactions | +[**get**](#get) | **GET** /v2/datasets/{datasetRid}/transactions/{transactionRid} | + +# **abort** +Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is +not updated. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**transaction_rid** | TransactionRid | transactionRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Transaction** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# TransactionRid | transactionRid +transaction_rid = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.datasets.Dataset.Transaction.abort( + dataset_rid, + transaction_rid, + preview=preview, + ) + print("The abort response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Transaction.abort: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Transaction | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **commit** +Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is +updated to point to the Transaction. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**transaction_rid** | TransactionRid | transactionRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Transaction** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# TransactionRid | transactionRid +transaction_rid = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.datasets.Dataset.Transaction.commit( + dataset_rid, + transaction_rid, + preview=preview, + ) + print("The commit response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Transaction.commit: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Transaction | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **create** +Creates a Transaction on a Branch of a Dataset. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**transaction_type** | TransactionType | | | +**branch_name** | Optional[BranchName] | branchName | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Transaction** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# TransactionType | +transaction_type = "APPEND" +# Optional[BranchName] | branchName +branch_name = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.datasets.Dataset.Transaction.create( + dataset_rid, + transaction_type=transaction_type, + branch_name=branch_name, + preview=preview, + ) + print("The create response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Transaction.create: %s\n" % e) + +``` + +### Manipulate a Dataset within a Transaction + +```python +import foundry + +foundry_client = foundry.FoundryV2Client(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") + +transaction = foundry_client.datasets.Dataset.Transaction.create( + dataset_rid="...", + create_transaction_request={}, +) + +with open("my/path/to/file.txt", 'rb') as f: + foundry_client.datasets.Dataset.File.upload( + body=f.read(), + dataset_rid="....", + file_path="...", + transaction_rid=transaction.rid, + ) + +foundry_client.datasets.Dataset.Transaction.commit(dataset_rid="...", transaction_rid=transaction.rid) +``` + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Transaction | The created Transaction | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get** +Gets a Transaction of a Dataset. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | datasetRid | | +**transaction_rid** | TransactionRid | transactionRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Transaction** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# DatasetRid | datasetRid +dataset_rid = None +# TransactionRid | transactionRid +transaction_rid = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.datasets.Dataset.Transaction.get( + dataset_rid, + transaction_rid, + preview=preview, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Transaction.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Transaction | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/OntologiesV2/Action.md b/docs/v2/OntologiesV2/Action.md new file mode 100644 index 00000000..1c482f84 --- /dev/null +++ b/docs/v2/OntologiesV2/Action.md @@ -0,0 +1,171 @@ +# Action + +Method | HTTP request | +------------- | ------------- | +[**apply**](#apply) | **POST** /v2/ontologies/{ontology}/actions/{action}/apply | +[**apply_batch**](#apply_batch) | **POST** /v2/ontologies/{ontology}/actions/{action}/applyBatch | + +# **apply** +Applies an action using the given parameters. + +Changes to the Ontology are eventually consistent and may take some time to be visible. + +Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by +this endpoint. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read api:ontologies-write`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**action** | ActionTypeApiName | action | | +**parameters** | Dict[ParameterId, Optional[DataValue]] | | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**options** | Optional[ApplyActionRequestOptionsDict] | | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | + +### Return type +**SyncApplyActionResponseV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ActionTypeApiName | action +action = "rename-employee" +# Dict[ParameterId, Optional[DataValue]] | +parameters = {"id": 80060, "newName": "Anna Smith-Doe"} +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[ApplyActionRequestOptionsDict] | +options = None +# Optional[SdkPackageName] | packageName +package_name = None + + +try: + api_response = foundry_client.ontologies.Action.apply( + ontology, + action, + parameters=parameters, + artifact_repository=artifact_repository, + options=options, + package_name=package_name, + ) + print("The apply response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Action.apply: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | SyncApplyActionResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **apply_batch** +Applies multiple actions (of the same Action Type) using the given parameters. +Changes to the Ontology are eventually consistent and may take some time to be visible. + +Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not +call Functions may receive a higher limit. + +Note that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read api:ontologies-write`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**action** | ActionTypeApiName | action | | +**requests** | List[BatchApplyActionRequestItemDict] | | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**options** | Optional[BatchApplyActionRequestOptionsDict] | | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | + +### Return type +**BatchApplyActionResponseV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ActionTypeApiName | action +action = "rename-employee" +# List[BatchApplyActionRequestItemDict] | +requests = [ + {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}}, + {"parameters": {"id": 80061, "newName": "Joe Bloggs"}}, +] +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[BatchApplyActionRequestOptionsDict] | +options = None +# Optional[SdkPackageName] | packageName +package_name = None + + +try: + api_response = foundry_client.ontologies.Action.apply_batch( + ontology, + action, + requests=requests, + artifact_repository=artifact_repository, + options=options, + package_name=package_name, + ) + print("The apply_batch response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Action.apply_batch: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | BatchApplyActionResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/OntologiesV2/ActionTypeV2.md b/docs/v2/OntologiesV2/ActionTypeV2.md new file mode 100644 index 00000000..b29feca8 --- /dev/null +++ b/docs/v2/OntologiesV2/ActionTypeV2.md @@ -0,0 +1,191 @@ +# ActionTypeV2 + +Method | HTTP request | +------------- | ------------- | +[**get**](#get) | **GET** /v2/ontologies/{ontology}/actionTypes/{actionType} | +[**list**](#list) | **GET** /v2/ontologies/{ontology}/actionTypes | +[**page**](#page) | **GET** /v2/ontologies/{ontology}/actionTypes | + +# **get** +Gets a specific action type with the given API name. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**action_type** | ActionTypeApiName | actionType | | + +### Return type +**ActionTypeV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ActionTypeApiName | actionType +action_type = "promote-employee" + + +try: + api_response = foundry_client.ontologies.Ontology.ActionType.get( + ontology, + action_type, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling ActionType.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ActionTypeV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **list** +Lists the action types for the given Ontology. + +Each page may be smaller than the requested page size. However, it is guaranteed that if there are more +results available, at least one result will be present in the response. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**page_size** | Optional[PageSize] | pageSize | [optional] | + +### Return type +**ResourceIterator[ActionTypeV2]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# Optional[PageSize] | pageSize +page_size = None + + +try: + for action_type in foundry_client.ontologies.Ontology.ActionType.list( + ontology, + page_size=page_size, + ): + pprint(action_type) +except PalantirRPCException as e: + print("HTTP error when calling ActionType.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListActionTypesResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **page** +Lists the action types for the given Ontology. + +Each page may be smaller than the requested page size. However, it is guaranteed that if there are more +results available, at least one result will be present in the response. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | + +### Return type +**ListActionTypesResponseV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None + + +try: + api_response = foundry_client.ontologies.Ontology.ActionType.page( + ontology, + page_size=page_size, + page_token=page_token, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling ActionType.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListActionTypesResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/OntologiesV2/Attachment.md b/docs/v2/OntologiesV2/Attachment.md new file mode 100644 index 00000000..26c1b829 --- /dev/null +++ b/docs/v2/OntologiesV2/Attachment.md @@ -0,0 +1,133 @@ +# Attachment + +Method | HTTP request | +------------- | ------------- | +[**read**](#read) | **GET** /v2/ontologies/attachments/{attachmentRid}/content | +[**upload**](#upload) | **POST** /v2/ontologies/attachments/upload | + +# **read** +Get the content of an attachment. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**attachment_rid** | AttachmentRid | attachmentRid | | + +### Return type +**bytes** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# AttachmentRid | attachmentRid +attachment_rid = "ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f" + + +try: + api_response = foundry_client.ontologies.Attachment.read( + attachment_rid, + ) + print("The read response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Attachment.read: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | bytes | Success response. | */* | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **upload** +Upload an attachment to use in an action. Any attachment which has not been linked to an object via +an action within one hour after upload will be removed. +Previously mapped attachments which are not connected to any object anymore are also removed on +a biweekly basis. +The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-write`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**body** | bytes | Body of the request | | +**content_length** | ContentLength | Content-Length | | +**content_type** | ContentType | Content-Type | | +**filename** | Filename | filename | | + +### Return type +**AttachmentV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# bytes | Body of the request +body = None +# ContentLength | Content-Length +content_length = None +# ContentType | Content-Type +content_type = None +# Filename | filename +filename = "My Image.jpeg" + + +try: + api_response = foundry_client.ontologies.Attachment.upload( + body, + content_length=content_length, + content_type=content_type, + filename=filename, + ) + print("The upload response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Attachment.upload: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | AttachmentV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/OntologiesV2/AttachmentPropertyV2.md b/docs/v2/OntologiesV2/AttachmentPropertyV2.md new file mode 100644 index 00000000..f75cf999 --- /dev/null +++ b/docs/v2/OntologiesV2/AttachmentPropertyV2.md @@ -0,0 +1,319 @@ +# AttachmentPropertyV2 + +Method | HTTP request | +------------- | ------------- | +[**get_attachment**](#get_attachment) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property} | +[**get_attachment_by_rid**](#get_attachment_by_rid) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid} | +[**read_attachment**](#read_attachment) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content | +[**read_attachment_by_rid**](#read_attachment_by_rid) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content | + +# **get_attachment** +Get the metadata of attachments parented to the given object. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**primary_key** | PropertyValueEscapedString | primaryKey | | +**property** | PropertyApiName | property | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | + +### Return type +**AttachmentMetadataResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "employee" +# PropertyValueEscapedString | primaryKey +primary_key = 50030 +# PropertyApiName | property +property = "performance" +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[SdkPackageName] | packageName +package_name = None + + +try: + api_response = foundry_client.ontologies.AttachmentProperty.get_attachment( + ontology, + object_type, + primary_key, + property, + artifact_repository=artifact_repository, + package_name=package_name, + ) + print("The get_attachment response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling AttachmentProperty.get_attachment: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | AttachmentMetadataResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get_attachment_by_rid** +Get the metadata of a particular attachment in an attachment list. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**primary_key** | PropertyValueEscapedString | primaryKey | | +**property** | PropertyApiName | property | | +**attachment_rid** | AttachmentRid | attachmentRid | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | + +### Return type +**AttachmentV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "employee" +# PropertyValueEscapedString | primaryKey +primary_key = 50030 +# PropertyApiName | property +property = "performance" +# AttachmentRid | attachmentRid +attachment_rid = "ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f" +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[SdkPackageName] | packageName +package_name = None + + +try: + api_response = foundry_client.ontologies.AttachmentProperty.get_attachment_by_rid( + ontology, + object_type, + primary_key, + property, + attachment_rid, + artifact_repository=artifact_repository, + package_name=package_name, + ) + print("The get_attachment_by_rid response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling AttachmentProperty.get_attachment_by_rid: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | AttachmentV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **read_attachment** +Get the content of an attachment. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**primary_key** | PropertyValueEscapedString | primaryKey | | +**property** | PropertyApiName | property | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | + +### Return type +**bytes** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "employee" +# PropertyValueEscapedString | primaryKey +primary_key = 50030 +# PropertyApiName | property +property = "performance" +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[SdkPackageName] | packageName +package_name = None + + +try: + api_response = foundry_client.ontologies.AttachmentProperty.read_attachment( + ontology, + object_type, + primary_key, + property, + artifact_repository=artifact_repository, + package_name=package_name, + ) + print("The read_attachment response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling AttachmentProperty.read_attachment: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | bytes | Success response. | */* | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **read_attachment_by_rid** +Get the content of an attachment by its RID. + +The RID must exist in the attachment array of the property. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**primary_key** | PropertyValueEscapedString | primaryKey | | +**property** | PropertyApiName | property | | +**attachment_rid** | AttachmentRid | attachmentRid | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | + +### Return type +**bytes** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "employee" +# PropertyValueEscapedString | primaryKey +primary_key = 50030 +# PropertyApiName | property +property = "performance" +# AttachmentRid | attachmentRid +attachment_rid = "ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f" +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[SdkPackageName] | packageName +package_name = None + + +try: + api_response = foundry_client.ontologies.AttachmentProperty.read_attachment_by_rid( + ontology, + object_type, + primary_key, + property, + attachment_rid, + artifact_repository=artifact_repository, + package_name=package_name, + ) + print("The read_attachment_by_rid response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling AttachmentProperty.read_attachment_by_rid: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | bytes | Success response. | */* | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/OntologiesV2/LinkedObjectV2.md b/docs/v2/OntologiesV2/LinkedObjectV2.md new file mode 100644 index 00000000..054c7824 --- /dev/null +++ b/docs/v2/OntologiesV2/LinkedObjectV2.md @@ -0,0 +1,303 @@ +# LinkedObjectV2 + +Method | HTTP request | +------------- | ------------- | +[**get_linked_object**](#get_linked_object) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} | +[**list_linked_objects**](#list_linked_objects) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} | +[**page_linked_objects**](#page_linked_objects) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} | + +# **get_linked_object** +Get a specific linked object that originates from another object. + +If there is no link between the two objects, `LinkedObjectNotFound` is thrown. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**primary_key** | PropertyValueEscapedString | primaryKey | | +**link_type** | LinkTypeApiName | linkType | | +**linked_object_primary_key** | PropertyValueEscapedString | linkedObjectPrimaryKey | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**exclude_rid** | Optional[StrictBool] | excludeRid | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | +**select** | Optional[List[SelectedPropertyApiName]] | select | [optional] | + +### Return type +**OntologyObjectV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "employee" +# PropertyValueEscapedString | primaryKey +primary_key = 50030 +# LinkTypeApiName | linkType +link_type = "directReport" +# PropertyValueEscapedString | linkedObjectPrimaryKey +linked_object_primary_key = 80060 +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[StrictBool] | excludeRid +exclude_rid = None +# Optional[SdkPackageName] | packageName +package_name = None +# Optional[List[SelectedPropertyApiName]] | select +select = None + + +try: + api_response = foundry_client.ontologies.LinkedObject.get_linked_object( + ontology, + object_type, + primary_key, + link_type, + linked_object_primary_key, + artifact_repository=artifact_repository, + exclude_rid=exclude_rid, + package_name=package_name, + select=select, + ) + print("The get_linked_object response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling LinkedObject.get_linked_object: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | OntologyObjectV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **list_linked_objects** +Lists the linked objects for a specific object and the given link type. + +Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or +repeated objects in the response pages. + +For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects +are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + +Each page may be smaller or larger than the requested page size. However, it +is guaranteed that if there are more results available, at least one result will be present +in the response. + +Note that null value properties will not be returned. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**primary_key** | PropertyValueEscapedString | primaryKey | | +**link_type** | LinkTypeApiName | linkType | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**exclude_rid** | Optional[StrictBool] | excludeRid | [optional] | +**order_by** | Optional[OrderBy] | orderBy | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**select** | Optional[List[SelectedPropertyApiName]] | select | [optional] | + +### Return type +**ResourceIterator[OntologyObjectV2]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "employee" +# PropertyValueEscapedString | primaryKey +primary_key = 50030 +# LinkTypeApiName | linkType +link_type = "directReport" +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[StrictBool] | excludeRid +exclude_rid = None +# Optional[OrderBy] | orderBy +order_by = None +# Optional[SdkPackageName] | packageName +package_name = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[List[SelectedPropertyApiName]] | select +select = None + + +try: + for linked_object in foundry_client.ontologies.LinkedObject.list_linked_objects( + ontology, + object_type, + primary_key, + link_type, + artifact_repository=artifact_repository, + exclude_rid=exclude_rid, + order_by=order_by, + package_name=package_name, + page_size=page_size, + select=select, + ): + pprint(linked_object) +except PalantirRPCException as e: + print("HTTP error when calling LinkedObject.list_linked_objects: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListLinkedObjectsResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **page_linked_objects** +Lists the linked objects for a specific object and the given link type. + +Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or +repeated objects in the response pages. + +For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects +are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + +Each page may be smaller or larger than the requested page size. However, it +is guaranteed that if there are more results available, at least one result will be present +in the response. + +Note that null value properties will not be returned. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**primary_key** | PropertyValueEscapedString | primaryKey | | +**link_type** | LinkTypeApiName | linkType | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**exclude_rid** | Optional[StrictBool] | excludeRid | [optional] | +**order_by** | Optional[OrderBy] | orderBy | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**select** | Optional[List[SelectedPropertyApiName]] | select | [optional] | + +### Return type +**ListLinkedObjectsResponseV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "employee" +# PropertyValueEscapedString | primaryKey +primary_key = 50030 +# LinkTypeApiName | linkType +link_type = "directReport" +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[StrictBool] | excludeRid +exclude_rid = None +# Optional[OrderBy] | orderBy +order_by = None +# Optional[SdkPackageName] | packageName +package_name = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[List[SelectedPropertyApiName]] | select +select = None + + +try: + api_response = foundry_client.ontologies.LinkedObject.page_linked_objects( + ontology, + object_type, + primary_key, + link_type, + artifact_repository=artifact_repository, + exclude_rid=exclude_rid, + order_by=order_by, + package_name=package_name, + page_size=page_size, + page_token=page_token, + select=select, + ) + print("The page_linked_objects response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling LinkedObject.page_linked_objects: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListLinkedObjectsResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/OntologiesV2/ObjectTypeV2.md b/docs/v2/OntologiesV2/ObjectTypeV2.md new file mode 100644 index 00000000..1539b7b6 --- /dev/null +++ b/docs/v2/OntologiesV2/ObjectTypeV2.md @@ -0,0 +1,388 @@ +# ObjectTypeV2 + +Method | HTTP request | +------------- | ------------- | +[**get**](#get) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType} | +[**get_outgoing_link_type**](#get_outgoing_link_type) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} | +[**list**](#list) | **GET** /v2/ontologies/{ontology}/objectTypes | +[**list_outgoing_link_types**](#list_outgoing_link_types) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes | +[**page**](#page) | **GET** /v2/ontologies/{ontology}/objectTypes | +[**page_outgoing_link_types**](#page_outgoing_link_types) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes | + +# **get** +Gets a specific object type with the given API name. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | + +### Return type +**ObjectTypeV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "employee" + + +try: + api_response = foundry_client.ontologies.Ontology.ObjectType.get( + ontology, + object_type, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling ObjectType.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ObjectTypeV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get_outgoing_link_type** +Get an outgoing link for an object type. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**link_type** | LinkTypeApiName | linkType | | + +### Return type +**LinkTypeSideV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "Employee" +# LinkTypeApiName | linkType +link_type = "directReport" + + +try: + api_response = foundry_client.ontologies.Ontology.ObjectType.get_outgoing_link_type( + ontology, + object_type, + link_type, + ) + print("The get_outgoing_link_type response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling ObjectType.get_outgoing_link_type: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | LinkTypeSideV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **list** +Lists the object types for the given Ontology. + +Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are +more results available, at least one result will be present in the +response. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**page_size** | Optional[PageSize] | pageSize | [optional] | + +### Return type +**ResourceIterator[ObjectTypeV2]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# Optional[PageSize] | pageSize +page_size = None + + +try: + for object_type in foundry_client.ontologies.Ontology.ObjectType.list( + ontology, + page_size=page_size, + ): + pprint(object_type) +except PalantirRPCException as e: + print("HTTP error when calling ObjectType.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListObjectTypesV2Response | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **list_outgoing_link_types** +List the outgoing links for an object type. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**page_size** | Optional[PageSize] | pageSize | [optional] | + +### Return type +**ResourceIterator[LinkTypeSideV2]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "Flight" +# Optional[PageSize] | pageSize +page_size = None + + +try: + for object_type in foundry_client.ontologies.Ontology.ObjectType.list_outgoing_link_types( + ontology, + object_type, + page_size=page_size, + ): + pprint(object_type) +except PalantirRPCException as e: + print("HTTP error when calling ObjectType.list_outgoing_link_types: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListOutgoingLinkTypesResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **page** +Lists the object types for the given Ontology. + +Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are +more results available, at least one result will be present in the +response. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | + +### Return type +**ListObjectTypesV2Response** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None + + +try: + api_response = foundry_client.ontologies.Ontology.ObjectType.page( + ontology, + page_size=page_size, + page_token=page_token, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling ObjectType.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListObjectTypesV2Response | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **page_outgoing_link_types** +List the outgoing links for an object type. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | + +### Return type +**ListOutgoingLinkTypesResponseV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "Flight" +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None + + +try: + api_response = foundry_client.ontologies.Ontology.ObjectType.page_outgoing_link_types( + ontology, + object_type, + page_size=page_size, + page_token=page_token, + ) + print("The page_outgoing_link_types response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling ObjectType.page_outgoing_link_types: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListOutgoingLinkTypesResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/OntologiesV2/OntologyInterface.md b/docs/v2/OntologiesV2/OntologyInterface.md new file mode 100644 index 00000000..823d4d39 --- /dev/null +++ b/docs/v2/OntologiesV2/OntologyInterface.md @@ -0,0 +1,305 @@ +# OntologyInterface + +Method | HTTP request | +------------- | ------------- | + +:::callout{theme=warning title=Warning} + This endpoint is in preview and may be modified or removed at any time. + To use this endpoint, add `preview=true` to the request query parameters. +::: + +Perform functions on object fields in the specified ontology and of the specified interface type. Any +properties specified in the query must be shared property type API names defined on the interface. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**interface_type** | InterfaceTypeApiName | interfaceType | | +**aggregation** | List[AggregationV2Dict] | | | +**group_by** | List[AggregationGroupByV2Dict] | | | +**accuracy** | Optional[AggregationAccuracyRequest] | | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**where** | Optional[SearchJsonQueryV2Dict] | | [optional] | + +### Return type +**AggregateObjectsResponseV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# InterfaceTypeApiName | interfaceType +interface_type = "Employee" +# List[AggregationV2Dict] | +aggregation = [ + {"type": "min", "field": "properties.tenure", "name": "min_tenure"}, + {"type": "avg", "field": "properties.tenure", "name": "avg_tenure"}, +] +# List[AggregationGroupByV2Dict] | +group_by = [ + { + "field": "startDate", + "type": "range", + "ranges": [{"startValue": "2020-01-01", "endValue": "2020-06-01"}], + }, + {"field": "city", "type": "exact"}, +] +# Optional[AggregationAccuracyRequest] | +accuracy = None +# Optional[PreviewMode] | preview +preview = None +# Optional[SearchJsonQueryV2Dict] | +where = None + + +try: + api_response = foundry_client.ontologies.OntologyInterface.aggregate( + ontology, + interface_type, + aggregation=aggregation, + group_by=group_by, + accuracy=accuracy, + preview=preview, + where=where, + ) + print("The aggregate response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyInterface.aggregate: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | AggregateObjectsResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +:::callout{theme=warning title=Warning} + This endpoint is in preview and may be modified or removed at any time. + To use this endpoint, add `preview=true` to the request query parameters. +::: + +Gets a specific object type with the given API name. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**interface_type** | InterfaceTypeApiName | interfaceType | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**InterfaceType** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# InterfaceTypeApiName | interfaceType +interface_type = "Employee" +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.ontologies.OntologyInterface.get( + ontology, + interface_type, + preview=preview, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyInterface.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | InterfaceType | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +:::callout{theme=warning title=Warning} + This endpoint is in preview and may be modified or removed at any time. + To use this endpoint, add `preview=true` to the request query parameters. +::: + +Lists the interface types for the given Ontology. + +Each page may be smaller than the requested page size. However, it is guaranteed that if there are more +results available, at least one result will be present in the response. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ResourceIterator[InterfaceType]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# Optional[PageSize] | pageSize +page_size = None +# Optional[PreviewMode] | preview +preview = None + + +try: + for ontology_interface in foundry_client.ontologies.OntologyInterface.list( + ontology, + page_size=page_size, + preview=preview, + ): + pprint(ontology_interface) +except PalantirRPCException as e: + print("HTTP error when calling OntologyInterface.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListInterfaceTypesResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +:::callout{theme=warning title=Warning} + This endpoint is in preview and may be modified or removed at any time. + To use this endpoint, add `preview=true` to the request query parameters. +::: + +Lists the interface types for the given Ontology. + +Each page may be smaller than the requested page size. However, it is guaranteed that if there are more +results available, at least one result will be present in the response. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ListInterfaceTypesResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.ontologies.OntologyInterface.page( + ontology, + page_size=page_size, + page_token=page_token, + preview=preview, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyInterface.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListInterfaceTypesResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/OntologiesV2/OntologyObjectSet.md b/docs/v2/OntologiesV2/OntologyObjectSet.md new file mode 100644 index 00000000..f6aeaeda --- /dev/null +++ b/docs/v2/OntologiesV2/OntologyObjectSet.md @@ -0,0 +1,291 @@ +# OntologyObjectSet + +Method | HTTP request | +------------- | ------------- | +[**aggregate**](#aggregate) | **POST** /v2/ontologies/{ontology}/objectSets/aggregate | +[**load**](#load) | **POST** /v2/ontologies/{ontology}/objectSets/loadObjects | + +# **aggregate** +Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**aggregation** | List[AggregationV2Dict] | | | +**group_by** | List[AggregationGroupByV2Dict] | | | +**object_set** | ObjectSetDict | | | +**accuracy** | Optional[AggregationAccuracyRequest] | | [optional] | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | + +### Return type +**AggregateObjectsResponseV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# List[AggregationV2Dict] | +aggregation = None +# List[AggregationGroupByV2Dict] | +group_by = None +# ObjectSetDict | +object_set = None +# Optional[AggregationAccuracyRequest] | +accuracy = None +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[SdkPackageName] | packageName +package_name = None + + +try: + api_response = foundry_client.ontologies.OntologyObjectSet.aggregate( + ontology, + aggregation=aggregation, + group_by=group_by, + object_set=object_set, + accuracy=accuracy, + artifact_repository=artifact_repository, + package_name=package_name, + ) + print("The aggregate response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObjectSet.aggregate: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | AggregateObjectsResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +Creates a temporary `ObjectSet` from the given definition. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read api:ontologies-write`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_set** | ObjectSetDict | | | + +### Return type +**CreateTemporaryObjectSetResponseV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectSetDict | +object_set = {"type": "base", "objectType": "Employee"} + + +try: + api_response = foundry_client.ontologies.OntologyObjectSet.create_temporary( + ontology, + object_set=object_set, + ) + print("The create_temporary response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObjectSet.create_temporary: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | CreateTemporaryObjectSetResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +Gets the definition of the `ObjectSet` with the given RID. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_set_rid** | ObjectSetRid | objectSetRid | | + +### Return type +**ObjectSet** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectSetRid | objectSetRid +object_set_rid = "ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053" + + +try: + api_response = foundry_client.ontologies.OntologyObjectSet.get( + ontology, + object_set_rid, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObjectSet.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ObjectSet | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **load** +Load the ontology objects present in the `ObjectSet` from the provided object set definition. + +For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects +are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + +Note that null value properties will not be returned. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_set** | ObjectSetDict | | | +**select** | List[SelectedPropertyApiName] | | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**exclude_rid** | Optional[StrictBool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] | +**order_by** | Optional[SearchOrderByV2Dict] | | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | +**page_size** | Optional[PageSize] | | [optional] | +**page_token** | Optional[PageToken] | | [optional] | + +### Return type +**LoadObjectSetResponseV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectSetDict | +object_set = {"type": "base", "objectType": "Employee"} +# List[SelectedPropertyApiName] | +select = None +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[StrictBool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. +exclude_rid = None +# Optional[SearchOrderByV2Dict] | +order_by = None +# Optional[SdkPackageName] | packageName +package_name = None +# Optional[PageSize] | +page_size = 10000 +# Optional[PageToken] | +page_token = None + + +try: + api_response = foundry_client.ontologies.OntologyObjectSet.load( + ontology, + object_set=object_set, + select=select, + artifact_repository=artifact_repository, + exclude_rid=exclude_rid, + order_by=order_by, + package_name=package_name, + page_size=page_size, + page_token=page_token, + ) + print("The load response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObjectSet.load: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | LoadObjectSetResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/OntologiesV2/OntologyObjectV2.md b/docs/v2/OntologiesV2/OntologyObjectV2.md new file mode 100644 index 00000000..b1ed9de1 --- /dev/null +++ b/docs/v2/OntologiesV2/OntologyObjectV2.md @@ -0,0 +1,545 @@ +# OntologyObjectV2 + +Method | HTTP request | +------------- | ------------- | +[**aggregate**](#aggregate) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/aggregate | +[**get**](#get) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey} | +[**list**](#list) | **GET** /v2/ontologies/{ontology}/objects/{objectType} | +[**page**](#page) | **GET** /v2/ontologies/{ontology}/objects/{objectType} | +[**search**](#search) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/search | + +# **aggregate** +Perform functions on object fields in the specified ontology and object type. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**aggregation** | List[AggregationV2Dict] | | | +**group_by** | List[AggregationGroupByV2Dict] | | | +**accuracy** | Optional[AggregationAccuracyRequest] | | [optional] | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | +**where** | Optional[SearchJsonQueryV2Dict] | | [optional] | + +### Return type +**AggregateObjectsResponseV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "employee" +# List[AggregationV2Dict] | +aggregation = [ + {"type": "min", "field": "properties.tenure", "name": "min_tenure"}, + {"type": "avg", "field": "properties.tenure", "name": "avg_tenure"}, +] +# List[AggregationGroupByV2Dict] | +group_by = [ + { + "field": "startDate", + "type": "range", + "ranges": [{"startValue": "2020-01-01", "endValue": "2020-06-01"}], + }, + {"field": "city", "type": "exact"}, +] +# Optional[AggregationAccuracyRequest] | +accuracy = None +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[SdkPackageName] | packageName +package_name = None +# Optional[SearchJsonQueryV2Dict] | +where = None + + +try: + api_response = foundry_client.ontologies.OntologyObject.aggregate( + ontology, + object_type, + aggregation=aggregation, + group_by=group_by, + accuracy=accuracy, + artifact_repository=artifact_repository, + package_name=package_name, + where=where, + ) + print("The aggregate response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObject.aggregate: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | AggregateObjectsResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +Returns a count of the objects of the given object type. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | + +### Return type +**CountObjectsResponseV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "employee" +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[SdkPackageName] | packageName +package_name = None + + +try: + api_response = foundry_client.ontologies.OntologyObject.count( + ontology, + object_type, + artifact_repository=artifact_repository, + package_name=package_name, + ) + print("The count response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObject.count: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | CountObjectsResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get** +Gets a specific object with the given primary key. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**primary_key** | PropertyValueEscapedString | primaryKey | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**exclude_rid** | Optional[StrictBool] | excludeRid | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | +**select** | Optional[List[SelectedPropertyApiName]] | select | [optional] | + +### Return type +**OntologyObjectV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "employee" +# PropertyValueEscapedString | primaryKey +primary_key = 50030 +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[StrictBool] | excludeRid +exclude_rid = None +# Optional[SdkPackageName] | packageName +package_name = None +# Optional[List[SelectedPropertyApiName]] | select +select = None + + +try: + api_response = foundry_client.ontologies.OntologyObject.get( + ontology, + object_type, + primary_key, + artifact_repository=artifact_repository, + exclude_rid=exclude_rid, + package_name=package_name, + select=select, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObject.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | OntologyObjectV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **list** +Lists the objects for the given Ontology and object type. + +Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or +repeated objects in the response pages. + +For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects +are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + +Each page may be smaller or larger than the requested page size. However, it +is guaranteed that if there are more results available, at least one result will be present +in the response. + +Note that null value properties will not be returned. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**exclude_rid** | Optional[StrictBool] | excludeRid | [optional] | +**order_by** | Optional[OrderBy] | orderBy | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**select** | Optional[List[SelectedPropertyApiName]] | select | [optional] | + +### Return type +**ResourceIterator[OntologyObjectV2]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "employee" +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[StrictBool] | excludeRid +exclude_rid = None +# Optional[OrderBy] | orderBy +order_by = None +# Optional[SdkPackageName] | packageName +package_name = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[List[SelectedPropertyApiName]] | select +select = None + + +try: + for ontology_object in foundry_client.ontologies.OntologyObject.list( + ontology, + object_type, + artifact_repository=artifact_repository, + exclude_rid=exclude_rid, + order_by=order_by, + package_name=package_name, + page_size=page_size, + select=select, + ): + pprint(ontology_object) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObject.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListObjectsResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **page** +Lists the objects for the given Ontology and object type. + +Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or +repeated objects in the response pages. + +For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects +are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + +Each page may be smaller or larger than the requested page size. However, it +is guaranteed that if there are more results available, at least one result will be present +in the response. + +Note that null value properties will not be returned. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**exclude_rid** | Optional[StrictBool] | excludeRid | [optional] | +**order_by** | Optional[OrderBy] | orderBy | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**select** | Optional[List[SelectedPropertyApiName]] | select | [optional] | + +### Return type +**ListObjectsResponseV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "employee" +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[StrictBool] | excludeRid +exclude_rid = None +# Optional[OrderBy] | orderBy +order_by = None +# Optional[SdkPackageName] | packageName +package_name = None +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[List[SelectedPropertyApiName]] | select +select = None + + +try: + api_response = foundry_client.ontologies.OntologyObject.page( + ontology, + object_type, + artifact_repository=artifact_repository, + exclude_rid=exclude_rid, + order_by=order_by, + package_name=package_name, + page_size=page_size, + page_token=page_token, + select=select, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObject.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListObjectsResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **search** +Search for objects in the specified ontology and object type. The request body is used +to filter objects based on the specified query. The supported queries are: + +| Query type | Description | Supported Types | +|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------| +| lt | The provided property is less than the provided value. | number, string, date, timestamp | +| gt | The provided property is greater than the provided value. | number, string, date, timestamp | +| lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp | +| gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp | +| eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp | +| isNull | The provided property is (or is not) null. | all | +| contains | The provided property contains the provided value. | array | +| not | The sub-query does not match. | N/A (applied on a query) | +| and | All the sub-queries match. | N/A (applied on queries) | +| or | At least one of the sub-queries match. | N/A (applied on queries) | +| startsWith | The provided property starts with the provided value. | string | +| containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string | +| containsAllTermsInOrder | The provided property contains the provided value as a substring. | string | +| containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string | +| containsAllTerms | The provided property contains all the terms separated by whitespace. | string | + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**object_type** | ObjectTypeApiName | objectType | | +**select** | List[PropertyApiName] | The API names of the object type properties to include in the response. | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**exclude_rid** | Optional[StrictBool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | [optional] | +**order_by** | Optional[SearchOrderByV2Dict] | | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | +**page_size** | Optional[PageSize] | | [optional] | +**page_token** | Optional[PageToken] | | [optional] | +**where** | Optional[SearchJsonQueryV2Dict] | | [optional] | + +### Return type +**SearchObjectsResponseV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# ObjectTypeApiName | objectType +object_type = "employee" +# List[PropertyApiName] | The API names of the object type properties to include in the response. +select = None +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[StrictBool] | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. +exclude_rid = None +# Optional[SearchOrderByV2Dict] | +order_by = None +# Optional[SdkPackageName] | packageName +package_name = None +# Optional[PageSize] | +page_size = None +# Optional[PageToken] | +page_token = None +# Optional[SearchJsonQueryV2Dict] | +where = {"type": "eq", "field": "age", "value": 21} + + +try: + api_response = foundry_client.ontologies.OntologyObject.search( + ontology, + object_type, + select=select, + artifact_repository=artifact_repository, + exclude_rid=exclude_rid, + order_by=order_by, + package_name=package_name, + page_size=page_size, + page_token=page_token, + where=where, + ) + print("The search response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling OntologyObject.search: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | SearchObjectsResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/OntologiesV2/OntologyV2.md b/docs/v2/OntologiesV2/OntologyV2.md new file mode 100644 index 00000000..a3fc4cf9 --- /dev/null +++ b/docs/v2/OntologiesV2/OntologyV2.md @@ -0,0 +1,111 @@ +# OntologyV2 + +Method | HTTP request | +------------- | ------------- | +[**get**](#get) | **GET** /v2/ontologies/{ontology} | + +# **get** +Gets a specific ontology with the given Ontology RID. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | + +### Return type +**OntologyV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" + + +try: + api_response = foundry_client.ontologies.Ontology.get( + ontology, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Ontology.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | OntologyV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | + +### Return type +**OntologyFullMetadata** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" + + +try: + api_response = foundry_client.ontologies.Ontology.get_full_metadata( + ontology, + ) + print("The get_full_metadata response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Ontology.get_full_metadata: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | OntologyFullMetadata | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/OntologiesV2/Query.md b/docs/v2/OntologiesV2/Query.md new file mode 100644 index 00000000..3a9abbb6 --- /dev/null +++ b/docs/v2/OntologiesV2/Query.md @@ -0,0 +1,79 @@ +# Query + +Method | HTTP request | +------------- | ------------- | +[**execute**](#execute) | **POST** /v2/ontologies/{ontology}/queries/{queryApiName}/execute | + +# **execute** +Executes a Query using the given parameters. + +Optional parameters do not need to be supplied. + +Third-party applications using this endpoint via OAuth2 must request the +following operation scopes: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**query_api_name** | QueryApiName | queryApiName | | +**parameters** | Dict[ParameterId, Optional[DataValue]] | | | +**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | +**package_name** | Optional[SdkPackageName] | packageName | [optional] | + +### Return type +**ExecuteQueryResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# QueryApiName | queryApiName +query_api_name = "getEmployeesInCity" +# Dict[ParameterId, Optional[DataValue]] | +parameters = {"city": "New York"} +# Optional[ArtifactRepositoryRid] | artifactRepository +artifact_repository = None +# Optional[SdkPackageName] | packageName +package_name = None + + +try: + api_response = foundry_client.ontologies.Query.execute( + ontology, + query_api_name, + parameters=parameters, + artifact_repository=artifact_repository, + package_name=package_name, + ) + print("The execute response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Query.execute: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ExecuteQueryResponse | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/OntologiesV2/QueryType.md b/docs/v2/OntologiesV2/QueryType.md new file mode 100644 index 00000000..bd5e77e5 --- /dev/null +++ b/docs/v2/OntologiesV2/QueryType.md @@ -0,0 +1,191 @@ +# QueryType + +Method | HTTP request | +------------- | ------------- | +[**get**](#get) | **GET** /v2/ontologies/{ontology}/queryTypes/{queryApiName} | +[**list**](#list) | **GET** /v2/ontologies/{ontology}/queryTypes | +[**page**](#page) | **GET** /v2/ontologies/{ontology}/queryTypes | + +# **get** +Gets a specific query type with the given API name. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**query_api_name** | QueryApiName | queryApiName | | + +### Return type +**QueryTypeV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# QueryApiName | queryApiName +query_api_name = "getEmployeesInCity" + + +try: + api_response = foundry_client.ontologies.Ontology.QueryType.get( + ontology, + query_api_name, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling QueryType.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | QueryTypeV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **list** +Lists the query types for the given Ontology. + +Each page may be smaller than the requested page size. However, it is guaranteed that if there are more +results available, at least one result will be present in the response. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**page_size** | Optional[PageSize] | pageSize | [optional] | + +### Return type +**ResourceIterator[QueryTypeV2]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# Optional[PageSize] | pageSize +page_size = None + + +try: + for query_type in foundry_client.ontologies.Ontology.QueryType.list( + ontology, + page_size=page_size, + ): + pprint(query_type) +except PalantirRPCException as e: + print("HTTP error when calling QueryType.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListQueryTypesResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **page** +Lists the query types for the given Ontology. + +Each page may be smaller than the requested page size. However, it is guaranteed that if there are more +results available, at least one result will be present in the response. + +Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**ontology** | OntologyIdentifier | ontology | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | + +### Return type +**ListQueryTypesResponseV2** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# OntologyIdentifier | ontology +ontology = "palantir" +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None + + +try: + api_response = foundry_client.ontologies.Ontology.QueryType.page( + ontology, + page_size=page_size, + page_token=page_token, + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling QueryType.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListQueryTypesResponseV2 | Success response. | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/namespaces/Ontologies/TimeSeriesPropertyV2.md b/docs/v2/OntologiesV2/TimeSeriesPropertyV2.md similarity index 81% rename from docs/v2/namespaces/Ontologies/TimeSeriesPropertyV2.md rename to docs/v2/OntologiesV2/TimeSeriesPropertyV2.md index 9252371b..5fa4544c 100644 --- a/docs/v2/namespaces/Ontologies/TimeSeriesPropertyV2.md +++ b/docs/v2/OntologiesV2/TimeSeriesPropertyV2.md @@ -30,29 +30,24 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryV2Client +from foundry.v2 import FoundryClient from foundry import PalantirRPCException from pprint import pprint -foundry_client = FoundryV2Client( +foundry_client = FoundryClient( auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" ) # OntologyIdentifier | ontology ontology = "palantir" - # ObjectTypeApiName | objectType object_type = "employee" - # PropertyValueEscapedString | primaryKey primary_key = 50030 - # PropertyApiName | property property = "performance" - # Optional[ArtifactRepositoryRid] | artifactRepository artifact_repository = None - # Optional[SdkPackageName] | packageName package_name = None @@ -77,14 +72,14 @@ except PalantirRPCException as e: ### Authorization -See [README](../../../../README.md#authorization) +See [README](../../../README.md#authorization) ### HTTP response details | Status Code | Type | Description | Content Type | |-------------|-------------|-------------|------------------| **200** | TimeSeriesPoint | Success response. | application/json | -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) # **get_last_point** Get the last point of a time series property. @@ -110,29 +105,24 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryV2Client +from foundry.v2 import FoundryClient from foundry import PalantirRPCException from pprint import pprint -foundry_client = FoundryV2Client( +foundry_client = FoundryClient( auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" ) # OntologyIdentifier | ontology ontology = "palantir" - # ObjectTypeApiName | objectType object_type = "employee" - # PropertyValueEscapedString | primaryKey primary_key = 50030 - # PropertyApiName | property property = "performance" - # Optional[ArtifactRepositoryRid] | artifactRepository artifact_repository = None - # Optional[SdkPackageName] | packageName package_name = None @@ -157,14 +147,14 @@ except PalantirRPCException as e: ### Authorization -See [README](../../../../README.md#authorization) +See [README](../../../README.md#authorization) ### HTTP response details | Status Code | Type | Description | Content Type | |-------------|-------------|-------------|------------------| **200** | TimeSeriesPoint | Success response. | application/json | -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) # **stream_points** Stream all of the points of a time series property. @@ -181,9 +171,9 @@ Name | Type | Description | Notes | **object_type** | ObjectTypeApiName | objectType | | **primary_key** | PropertyValueEscapedString | primaryKey | | **property** | PropertyApiName | property | | -**stream_time_series_points_request** | Union[StreamTimeSeriesPointsRequest, StreamTimeSeriesPointsRequestDict] | Body of the request | | **artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | **package_name** | Optional[SdkPackageName] | packageName | [optional] | +**range** | Optional[TimeRangeDict] | | [optional] | ### Return type **bytes** @@ -191,40 +181,32 @@ Name | Type | Description | Notes | ### Example ```python -from foundry.v2 import FoundryV2Client +from foundry.v2 import FoundryClient from foundry import PalantirRPCException from pprint import pprint -foundry_client = FoundryV2Client( +foundry_client = FoundryClient( auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" ) # OntologyIdentifier | ontology ontology = "palantir" - # ObjectTypeApiName | objectType object_type = "employee" - # PropertyValueEscapedString | primaryKey primary_key = 50030 - # PropertyApiName | property property = None - -# Union[StreamTimeSeriesPointsRequest, StreamTimeSeriesPointsRequestDict] | Body of the request -stream_time_series_points_request = { - "range": { - "type": "relative", - "startTime": {"when": "BEFORE", "value": 5, "unit": "MONTHS"}, - "endTime": {"when": "BEFORE", "value": 1, "unit": "MONTHS"}, - } -} - # Optional[ArtifactRepositoryRid] | artifactRepository artifact_repository = None - # Optional[SdkPackageName] | packageName package_name = None +# Optional[TimeRangeDict] | +range = { + "type": "relative", + "startTime": {"when": "BEFORE", "value": 5, "unit": "MONTHS"}, + "endTime": {"when": "BEFORE", "value": 1, "unit": "MONTHS"}, +} try: @@ -233,9 +215,9 @@ try: object_type, primary_key, property, - stream_time_series_points_request, artifact_repository=artifact_repository, package_name=package_name, + range=range, ) print("The stream_points response:\n") pprint(api_response) @@ -248,12 +230,12 @@ except PalantirRPCException as e: ### Authorization -See [README](../../../../README.md#authorization) +See [README](../../../README.md#authorization) ### HTTP response details | Status Code | Type | Description | Content Type | |-------------|-------------|-------------|------------------| **200** | bytes | Success response. | */* | -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/Orchestration/Build.md b/docs/v2/Orchestration/Build.md new file mode 100644 index 00000000..5305e84c --- /dev/null +++ b/docs/v2/Orchestration/Build.md @@ -0,0 +1,145 @@ +# Build + +Method | HTTP request | +------------- | ------------- | +[**create**](#create) | **POST** /v2/orchestration/builds/create | +[**get**](#get) | **GET** /v2/orchestration/builds/{buildRid} | + +# **create** + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**fallback_branches** | FallbackBranches | | | +**target** | BuildTargetDict | The targets of the schedule. | | +**abort_on_failure** | Optional[AbortOnFailure] | | [optional] | +**branch_name** | Optional[BranchName] | The target branch the build should run on. | [optional] | +**force_build** | Optional[ForceBuild] | | [optional] | +**notifications_enabled** | Optional[NotificationsEnabled] | | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**retry_backoff_duration** | Optional[RetryBackoffDurationDict] | | [optional] | +**retry_count** | Optional[RetryCount] | The number of retry attempts for failed jobs. | [optional] | + +### Return type +**Build** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# FallbackBranches | +fallback_branches = ["master"] +# BuildTargetDict | The targets of the schedule. +target = None +# Optional[AbortOnFailure] | +abort_on_failure = None +# Optional[BranchName] | The target branch the build should run on. +branch_name = "master" +# Optional[ForceBuild] | +force_build = None +# Optional[NotificationsEnabled] | +notifications_enabled = None +# Optional[PreviewMode] | preview +preview = None +# Optional[RetryBackoffDurationDict] | +retry_backoff_duration = {"unit": "SECONDS", "value": 30} +# Optional[RetryCount] | The number of retry attempts for failed jobs. +retry_count = None + + +try: + api_response = foundry_client.orchestration.Build.create( + fallback_branches=fallback_branches, + target=target, + abort_on_failure=abort_on_failure, + branch_name=branch_name, + force_build=force_build, + notifications_enabled=notifications_enabled, + preview=preview, + retry_backoff_duration=retry_backoff_duration, + retry_count=retry_count, + ) + print("The create response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Build.create: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Build | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get** +Get the Build with the specified rid. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**build_rid** | BuildRid | buildRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Build** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# BuildRid | buildRid +build_rid = "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58" +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.orchestration.Build.get( + build_rid, + preview=preview, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Build.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Build | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/Orchestration/Schedule.md b/docs/v2/Orchestration/Schedule.md new file mode 100644 index 00000000..e0d45e05 --- /dev/null +++ b/docs/v2/Orchestration/Schedule.md @@ -0,0 +1,229 @@ +# Schedule + +Method | HTTP request | +------------- | ------------- | +[**get**](#get) | **GET** /v2/orchestration/schedules/{scheduleRid} | +[**pause**](#pause) | **POST** /v2/orchestration/schedules/{scheduleRid}/pause | +[**run**](#run) | **POST** /v2/orchestration/schedules/{scheduleRid}/run | +[**unpause**](#unpause) | **POST** /v2/orchestration/schedules/{scheduleRid}/unpause | + +# **get** +Get the Schedule with the specified rid. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**schedule_rid** | ScheduleRid | scheduleRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Schedule** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ScheduleRid | scheduleRid +schedule_rid = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.orchestration.Schedule.get( + schedule_rid, + preview=preview, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Schedule.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Schedule | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **pause** + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**schedule_rid** | ScheduleRid | scheduleRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ScheduleRid | scheduleRid +schedule_rid = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.orchestration.Schedule.pause( + schedule_rid, + preview=preview, + ) + print("The pause response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Schedule.pause: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **run** + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**schedule_rid** | ScheduleRid | scheduleRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ScheduleRun** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ScheduleRid | scheduleRid +schedule_rid = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.orchestration.Schedule.run( + schedule_rid, + preview=preview, + ) + print("The run response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Schedule.run: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ScheduleRun | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **unpause** + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**schedule_rid** | ScheduleRid | scheduleRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ScheduleRid | scheduleRid +schedule_rid = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.orchestration.Schedule.unpause( + schedule_rid, + preview=preview, + ) + print("The unpause response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Schedule.unpause: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/ThirdPartyApplications/ThirdPartyApplication.md b/docs/v2/ThirdPartyApplications/ThirdPartyApplication.md new file mode 100644 index 00000000..e2587413 --- /dev/null +++ b/docs/v2/ThirdPartyApplications/ThirdPartyApplication.md @@ -0,0 +1,61 @@ +# ThirdPartyApplication + +Method | HTTP request | +------------- | ------------- | + +Get the ThirdPartyApplication with the specified rid. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ThirdPartyApplication** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ThirdPartyApplicationRid | thirdPartyApplicationRid +third_party_application_rid = ( + "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" +) +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.third_party_applications.ThirdPartyApplication.get( + third_party_application_rid, + preview=preview, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling ThirdPartyApplication.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ThirdPartyApplication | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/ThirdPartyApplications/Version.md b/docs/v2/ThirdPartyApplications/Version.md new file mode 100644 index 00000000..5559a5a2 --- /dev/null +++ b/docs/v2/ThirdPartyApplications/Version.md @@ -0,0 +1,336 @@ +# Version + +Method | HTTP request | +------------- | ------------- | +[**delete**](#delete) | **DELETE** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | +[**get**](#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | +[**list**](#list) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions | +[**page**](#page) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions | +[**upload**](#upload) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/upload | + +# **delete** +Delete the Version with the specified version. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | +**version_version** | VersionVersion | versionVersion | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ThirdPartyApplicationRid | thirdPartyApplicationRid +third_party_application_rid = ( + "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" +) +# VersionVersion | versionVersion +version_version = "1.2.0" +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = ( + foundry_client.third_party_applications.ThirdPartyApplication.Website.Version.delete( + third_party_application_rid, + version_version, + preview=preview, + ) + ) + print("The delete response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Version.delete: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get** +Get the Version with the specified version. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | +**version_version** | VersionVersion | versionVersion | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Version** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ThirdPartyApplicationRid | thirdPartyApplicationRid +third_party_application_rid = ( + "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" +) +# VersionVersion | versionVersion +version_version = "1.2.0" +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = ( + foundry_client.third_party_applications.ThirdPartyApplication.Website.Version.get( + third_party_application_rid, + version_version, + preview=preview, + ) + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Version.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Version | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **list** +Lists all Versions. + +This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ResourceIterator[Version]** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ThirdPartyApplicationRid | thirdPartyApplicationRid +third_party_application_rid = ( + "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" +) +# Optional[PageSize] | pageSize +page_size = None +# Optional[PreviewMode] | preview +preview = None + + +try: + for ( + version + ) in foundry_client.third_party_applications.ThirdPartyApplication.Website.Version.list( + third_party_application_rid, + page_size=page_size, + preview=preview, + ): + pprint(version) +except PalantirRPCException as e: + print("HTTP error when calling Version.list: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListVersionsResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **page** +Lists all Versions. + +This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | +**page_size** | Optional[PageSize] | pageSize | [optional] | +**page_token** | Optional[PageToken] | pageToken | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**ListVersionsResponse** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ThirdPartyApplicationRid | thirdPartyApplicationRid +third_party_application_rid = ( + "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" +) +# Optional[PageSize] | pageSize +page_size = None +# Optional[PageToken] | pageToken +page_token = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = ( + foundry_client.third_party_applications.ThirdPartyApplication.Website.Version.page( + third_party_application_rid, + page_size=page_size, + page_token=page_token, + preview=preview, + ) + ) + print("The page response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Version.page: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | ListVersionsResponse | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **upload** +Upload a new version of the Website. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | +**body** | bytes | The zip file that contains the contents of your application. For more information, refer to the [documentation](/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. | | +**version** | VersionVersion | version | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Version** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ThirdPartyApplicationRid | thirdPartyApplicationRid +third_party_application_rid = ( + "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" +) +# bytes | The zip file that contains the contents of your application. For more information, refer to the [documentation](/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. +body = None +# VersionVersion | version +version = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = ( + foundry_client.third_party_applications.ThirdPartyApplication.Website.Version.upload( + third_party_application_rid, + body, + version=version, + preview=preview, + ) + ) + print("The upload response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Version.upload: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Version | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/ThirdPartyApplications/Website.md b/docs/v2/ThirdPartyApplications/Website.md new file mode 100644 index 00000000..e9c36c95 --- /dev/null +++ b/docs/v2/ThirdPartyApplications/Website.md @@ -0,0 +1,183 @@ +# Website + +Method | HTTP request | +------------- | ------------- | +[**deploy**](#deploy) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/deploy | +[**get**](#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website | +[**undeploy**](#undeploy) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/undeploy | + +# **deploy** +Deploy a version of the Website. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | +**version** | VersionVersion | | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Website** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ThirdPartyApplicationRid | thirdPartyApplicationRid +third_party_application_rid = ( + "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" +) +# VersionVersion | +version = "1.2.0" +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.third_party_applications.ThirdPartyApplication.Website.deploy( + third_party_application_rid, + version=version, + preview=preview, + ) + print("The deploy response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Website.deploy: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Website | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **get** +Get the Website. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Website** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ThirdPartyApplicationRid | thirdPartyApplicationRid +third_party_application_rid = ( + "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" +) +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.third_party_applications.ThirdPartyApplication.Website.get( + third_party_application_rid, + preview=preview, + ) + print("The get response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Website.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Website | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +# **undeploy** +Remove the currently deployed version of the Website. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**Website** + +### Example + +```python +from foundry.v2 import FoundryClient +from foundry import PalantirRPCException +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ThirdPartyApplicationRid | thirdPartyApplicationRid +third_party_application_rid = ( + "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" +) +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.third_party_applications.ThirdPartyApplication.Website.undeploy( + third_party_application_rid, + preview=preview, + ) + print("The undeploy response:\n") + pprint(api_response) +except PalantirRPCException as e: + print("HTTP error when calling Website.undeploy: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | Website | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/admin/models/AttributeName.md b/docs/v2/admin/models/AttributeName.md new file mode 100644 index 00000000..49289d6c --- /dev/null +++ b/docs/v2/admin/models/AttributeName.md @@ -0,0 +1,11 @@ +# AttributeName + +AttributeName + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/AttributeValue.md b/docs/v2/admin/models/AttributeValue.md new file mode 100644 index 00000000..e6c0c0ff --- /dev/null +++ b/docs/v2/admin/models/AttributeValue.md @@ -0,0 +1,11 @@ +# AttributeValue + +AttributeValue + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/AttributeValues.md b/docs/v2/admin/models/AttributeValues.md new file mode 100644 index 00000000..8bd2ad76 --- /dev/null +++ b/docs/v2/admin/models/AttributeValues.md @@ -0,0 +1,11 @@ +# AttributeValues + +AttributeValues + +## Type +```python +List[AttributeValue] +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GetGroupsBatchRequestElementDict.md b/docs/v2/admin/models/GetGroupsBatchRequestElementDict.md new file mode 100644 index 00000000..eb053bae --- /dev/null +++ b/docs/v2/admin/models/GetGroupsBatchRequestElementDict.md @@ -0,0 +1,11 @@ +# GetGroupsBatchRequestElementDict + +GetGroupsBatchRequestElement + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**groupId** | PrincipalId | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GetGroupsBatchResponse.md b/docs/v2/admin/models/GetGroupsBatchResponse.md new file mode 100644 index 00000000..a672cb08 --- /dev/null +++ b/docs/v2/admin/models/GetGroupsBatchResponse.md @@ -0,0 +1,11 @@ +# GetGroupsBatchResponse + +GetGroupsBatchResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | Dict[PrincipalId, Group] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GetGroupsBatchResponseDict.md b/docs/v2/admin/models/GetGroupsBatchResponseDict.md new file mode 100644 index 00000000..2af104b1 --- /dev/null +++ b/docs/v2/admin/models/GetGroupsBatchResponseDict.md @@ -0,0 +1,11 @@ +# GetGroupsBatchResponseDict + +GetGroupsBatchResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | Dict[PrincipalId, GroupDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GetUserMarkingsResponse.md b/docs/v2/admin/models/GetUserMarkingsResponse.md new file mode 100644 index 00000000..49b9c53f --- /dev/null +++ b/docs/v2/admin/models/GetUserMarkingsResponse.md @@ -0,0 +1,11 @@ +# GetUserMarkingsResponse + +GetUserMarkingsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**view** | List[MarkingId] | Yes | The markings that the user has access to. The user will be able to access resources protected with these markings. This includes organization markings for organizations in which the user is a guest member. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GetUserMarkingsResponseDict.md b/docs/v2/admin/models/GetUserMarkingsResponseDict.md new file mode 100644 index 00000000..fb5863e6 --- /dev/null +++ b/docs/v2/admin/models/GetUserMarkingsResponseDict.md @@ -0,0 +1,11 @@ +# GetUserMarkingsResponseDict + +GetUserMarkingsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**view** | List[MarkingId] | Yes | The markings that the user has access to. The user will be able to access resources protected with these markings. This includes organization markings for organizations in which the user is a guest member. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GetUsersBatchRequestElementDict.md b/docs/v2/admin/models/GetUsersBatchRequestElementDict.md new file mode 100644 index 00000000..b8b3f6f5 --- /dev/null +++ b/docs/v2/admin/models/GetUsersBatchRequestElementDict.md @@ -0,0 +1,11 @@ +# GetUsersBatchRequestElementDict + +GetUsersBatchRequestElement + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**userId** | PrincipalId | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GetUsersBatchResponse.md b/docs/v2/admin/models/GetUsersBatchResponse.md new file mode 100644 index 00000000..7822a5fd --- /dev/null +++ b/docs/v2/admin/models/GetUsersBatchResponse.md @@ -0,0 +1,11 @@ +# GetUsersBatchResponse + +GetUsersBatchResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | Dict[PrincipalId, User] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GetUsersBatchResponseDict.md b/docs/v2/admin/models/GetUsersBatchResponseDict.md new file mode 100644 index 00000000..a19e7c8e --- /dev/null +++ b/docs/v2/admin/models/GetUsersBatchResponseDict.md @@ -0,0 +1,11 @@ +# GetUsersBatchResponseDict + +GetUsersBatchResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | Dict[PrincipalId, UserDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/Group.md b/docs/v2/admin/models/Group.md new file mode 100644 index 00000000..1afdd535 --- /dev/null +++ b/docs/v2/admin/models/Group.md @@ -0,0 +1,16 @@ +# Group + +Group + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**id** | PrincipalId | Yes | | +**name** | GroupName | Yes | The name of the Group. | +**description** | Optional[StrictStr] | No | A description of the Group. | +**realm** | Realm | Yes | | +**organizations** | List[OrganizationRid] | Yes | The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed. | +**attributes** | Dict[AttributeName, AttributeValues] | Yes | A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/models/GroupDict.md b/docs/v2/admin/models/GroupDict.md similarity index 81% rename from docs/v2/models/GroupDict.md rename to docs/v2/admin/models/GroupDict.md index b1765b80..f5eb995d 100644 --- a/docs/v2/models/GroupDict.md +++ b/docs/v2/admin/models/GroupDict.md @@ -13,4 +13,4 @@ Group **attributes** | Dict[AttributeName, AttributeValues] | Yes | A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. | -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GroupMember.md b/docs/v2/admin/models/GroupMember.md new file mode 100644 index 00000000..f178d41b --- /dev/null +++ b/docs/v2/admin/models/GroupMember.md @@ -0,0 +1,12 @@ +# GroupMember + +GroupMember + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**principal_type** | PrincipalType | Yes | | +**principal_id** | PrincipalId | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GroupMemberDict.md b/docs/v2/admin/models/GroupMemberDict.md new file mode 100644 index 00000000..119aee7c --- /dev/null +++ b/docs/v2/admin/models/GroupMemberDict.md @@ -0,0 +1,12 @@ +# GroupMemberDict + +GroupMember + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**principalType** | PrincipalType | Yes | | +**principalId** | PrincipalId | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GroupMembership.md b/docs/v2/admin/models/GroupMembership.md new file mode 100644 index 00000000..884da1f9 --- /dev/null +++ b/docs/v2/admin/models/GroupMembership.md @@ -0,0 +1,11 @@ +# GroupMembership + +GroupMembership + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**group_id** | PrincipalId | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GroupMembershipDict.md b/docs/v2/admin/models/GroupMembershipDict.md new file mode 100644 index 00000000..2145f460 --- /dev/null +++ b/docs/v2/admin/models/GroupMembershipDict.md @@ -0,0 +1,11 @@ +# GroupMembershipDict + +GroupMembership + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**groupId** | PrincipalId | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GroupMembershipExpiration.md b/docs/v2/admin/models/GroupMembershipExpiration.md new file mode 100644 index 00000000..b5c1f1a6 --- /dev/null +++ b/docs/v2/admin/models/GroupMembershipExpiration.md @@ -0,0 +1,11 @@ +# GroupMembershipExpiration + +GroupMembershipExpiration + +## Type +```python +datetime +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GroupName.md b/docs/v2/admin/models/GroupName.md new file mode 100644 index 00000000..c68aa6b3 --- /dev/null +++ b/docs/v2/admin/models/GroupName.md @@ -0,0 +1,11 @@ +# GroupName + +The name of the Group. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/GroupSearchFilterDict.md b/docs/v2/admin/models/GroupSearchFilterDict.md new file mode 100644 index 00000000..2ef56a87 --- /dev/null +++ b/docs/v2/admin/models/GroupSearchFilterDict.md @@ -0,0 +1,12 @@ +# GroupSearchFilterDict + +GroupSearchFilter + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | PrincipalFilterType | Yes | | +**value** | StrictStr | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/ListGroupMembersResponse.md b/docs/v2/admin/models/ListGroupMembersResponse.md new file mode 100644 index 00000000..9502f720 --- /dev/null +++ b/docs/v2/admin/models/ListGroupMembersResponse.md @@ -0,0 +1,12 @@ +# ListGroupMembersResponse + +ListGroupMembersResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[GroupMember] | Yes | | +**next_page_token** | Optional[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/ListGroupMembersResponseDict.md b/docs/v2/admin/models/ListGroupMembersResponseDict.md new file mode 100644 index 00000000..33da3ee0 --- /dev/null +++ b/docs/v2/admin/models/ListGroupMembersResponseDict.md @@ -0,0 +1,12 @@ +# ListGroupMembersResponseDict + +ListGroupMembersResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[GroupMemberDict] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/ListGroupMembershipsResponse.md b/docs/v2/admin/models/ListGroupMembershipsResponse.md new file mode 100644 index 00000000..660da6b3 --- /dev/null +++ b/docs/v2/admin/models/ListGroupMembershipsResponse.md @@ -0,0 +1,12 @@ +# ListGroupMembershipsResponse + +ListGroupMembershipsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[GroupMembership] | Yes | | +**next_page_token** | Optional[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/ListGroupMembershipsResponseDict.md b/docs/v2/admin/models/ListGroupMembershipsResponseDict.md new file mode 100644 index 00000000..49b9d940 --- /dev/null +++ b/docs/v2/admin/models/ListGroupMembershipsResponseDict.md @@ -0,0 +1,12 @@ +# ListGroupMembershipsResponseDict + +ListGroupMembershipsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[GroupMembershipDict] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/ListGroupsResponse.md b/docs/v2/admin/models/ListGroupsResponse.md new file mode 100644 index 00000000..50814949 --- /dev/null +++ b/docs/v2/admin/models/ListGroupsResponse.md @@ -0,0 +1,12 @@ +# ListGroupsResponse + +ListGroupsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[Group] | Yes | | +**next_page_token** | Optional[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/ListGroupsResponseDict.md b/docs/v2/admin/models/ListGroupsResponseDict.md new file mode 100644 index 00000000..197287e5 --- /dev/null +++ b/docs/v2/admin/models/ListGroupsResponseDict.md @@ -0,0 +1,12 @@ +# ListGroupsResponseDict + +ListGroupsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[GroupDict] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/ListMarkingCategoriesResponse.md b/docs/v2/admin/models/ListMarkingCategoriesResponse.md new file mode 100644 index 00000000..7b9cae1a --- /dev/null +++ b/docs/v2/admin/models/ListMarkingCategoriesResponse.md @@ -0,0 +1,12 @@ +# ListMarkingCategoriesResponse + +ListMarkingCategoriesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[MarkingCategory] | Yes | | +**next_page_token** | Optional[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/ListMarkingCategoriesResponseDict.md b/docs/v2/admin/models/ListMarkingCategoriesResponseDict.md new file mode 100644 index 00000000..d0c7e383 --- /dev/null +++ b/docs/v2/admin/models/ListMarkingCategoriesResponseDict.md @@ -0,0 +1,12 @@ +# ListMarkingCategoriesResponseDict + +ListMarkingCategoriesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[MarkingCategoryDict] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/ListMarkingsResponse.md b/docs/v2/admin/models/ListMarkingsResponse.md new file mode 100644 index 00000000..504ba42c --- /dev/null +++ b/docs/v2/admin/models/ListMarkingsResponse.md @@ -0,0 +1,12 @@ +# ListMarkingsResponse + +ListMarkingsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[Marking] | Yes | | +**next_page_token** | Optional[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/ListMarkingsResponseDict.md b/docs/v2/admin/models/ListMarkingsResponseDict.md new file mode 100644 index 00000000..2052b320 --- /dev/null +++ b/docs/v2/admin/models/ListMarkingsResponseDict.md @@ -0,0 +1,12 @@ +# ListMarkingsResponseDict + +ListMarkingsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[MarkingDict] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/ListUsersResponse.md b/docs/v2/admin/models/ListUsersResponse.md new file mode 100644 index 00000000..30992198 --- /dev/null +++ b/docs/v2/admin/models/ListUsersResponse.md @@ -0,0 +1,12 @@ +# ListUsersResponse + +ListUsersResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[User] | Yes | | +**next_page_token** | Optional[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/ListUsersResponseDict.md b/docs/v2/admin/models/ListUsersResponseDict.md new file mode 100644 index 00000000..44bdaf64 --- /dev/null +++ b/docs/v2/admin/models/ListUsersResponseDict.md @@ -0,0 +1,12 @@ +# ListUsersResponseDict + +ListUsersResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[UserDict] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/Marking.md b/docs/v2/admin/models/Marking.md new file mode 100644 index 00000000..c1bb8003 --- /dev/null +++ b/docs/v2/admin/models/Marking.md @@ -0,0 +1,17 @@ +# Marking + +Marking + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**id** | MarkingId | Yes | | +**category_id** | MarkingCategoryId | Yes | | +**display_name** | MarkingDisplayName | Yes | | +**description** | Optional[StrictStr] | No | | +**organization_rid** | Optional[OrganizationRid] | No | If this marking is associated with an Organization, its RID will be populated here. | +**created_time** | CreatedTime | Yes | | +**created_by** | Optional[CreatedBy] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/MarkingCategory.md b/docs/v2/admin/models/MarkingCategory.md new file mode 100644 index 00000000..0dd3bdcd --- /dev/null +++ b/docs/v2/admin/models/MarkingCategory.md @@ -0,0 +1,18 @@ +# MarkingCategory + +MarkingCategory + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**id** | MarkingCategoryId | Yes | | +**display_name** | MarkingCategoryDisplayName | Yes | | +**description** | Optional[StrictStr] | No | | +**category_type** | MarkingCategoryType | Yes | | +**marking_type** | MarkingType | Yes | | +**markings** | List[MarkingId] | Yes | | +**created_time** | CreatedTime | Yes | | +**created_by** | Optional[CreatedBy] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/MarkingCategoryDict.md b/docs/v2/admin/models/MarkingCategoryDict.md new file mode 100644 index 00000000..e9ff7778 --- /dev/null +++ b/docs/v2/admin/models/MarkingCategoryDict.md @@ -0,0 +1,18 @@ +# MarkingCategoryDict + +MarkingCategory + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**id** | MarkingCategoryId | Yes | | +**displayName** | MarkingCategoryDisplayName | Yes | | +**description** | NotRequired[StrictStr] | No | | +**categoryType** | MarkingCategoryType | Yes | | +**markingType** | MarkingType | Yes | | +**markings** | List[MarkingId] | Yes | | +**createdTime** | CreatedTime | Yes | | +**createdBy** | NotRequired[CreatedBy] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/MarkingCategoryDisplayName.md b/docs/v2/admin/models/MarkingCategoryDisplayName.md new file mode 100644 index 00000000..c1586b90 --- /dev/null +++ b/docs/v2/admin/models/MarkingCategoryDisplayName.md @@ -0,0 +1,11 @@ +# MarkingCategoryDisplayName + +MarkingCategoryDisplayName + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/MarkingCategoryId.md b/docs/v2/admin/models/MarkingCategoryId.md new file mode 100644 index 00000000..2fd53ed9 --- /dev/null +++ b/docs/v2/admin/models/MarkingCategoryId.md @@ -0,0 +1,13 @@ +# MarkingCategoryId + +The ID of a marking category. For user-created categories, this will be a UUID. Markings associated with +Organizations are placed in a category with ID "Organization". + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/MarkingCategoryType.md b/docs/v2/admin/models/MarkingCategoryType.md new file mode 100644 index 00000000..1b4490cb --- /dev/null +++ b/docs/v2/admin/models/MarkingCategoryType.md @@ -0,0 +1,11 @@ +# MarkingCategoryType + +MarkingCategoryType + +| **Value** | +| --------- | +| `"CONJUNCTIVE"` | +| `"DISJUNCTIVE"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/MarkingDict.md b/docs/v2/admin/models/MarkingDict.md new file mode 100644 index 00000000..05f4557c --- /dev/null +++ b/docs/v2/admin/models/MarkingDict.md @@ -0,0 +1,17 @@ +# MarkingDict + +Marking + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**id** | MarkingId | Yes | | +**categoryId** | MarkingCategoryId | Yes | | +**displayName** | MarkingDisplayName | Yes | | +**description** | NotRequired[StrictStr] | No | | +**organizationRid** | NotRequired[OrganizationRid] | No | If this marking is associated with an Organization, its RID will be populated here. | +**createdTime** | CreatedTime | Yes | | +**createdBy** | NotRequired[CreatedBy] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/MarkingDisplayName.md b/docs/v2/admin/models/MarkingDisplayName.md new file mode 100644 index 00000000..7904466c --- /dev/null +++ b/docs/v2/admin/models/MarkingDisplayName.md @@ -0,0 +1,11 @@ +# MarkingDisplayName + +MarkingDisplayName + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/MarkingType.md b/docs/v2/admin/models/MarkingType.md new file mode 100644 index 00000000..6b9f7f9c --- /dev/null +++ b/docs/v2/admin/models/MarkingType.md @@ -0,0 +1,11 @@ +# MarkingType + +MarkingType + +| **Value** | +| --------- | +| `"MANDATORY"` | +| `"CBAC"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/PrincipalFilterType.md b/docs/v2/admin/models/PrincipalFilterType.md new file mode 100644 index 00000000..024e83fa --- /dev/null +++ b/docs/v2/admin/models/PrincipalFilterType.md @@ -0,0 +1,10 @@ +# PrincipalFilterType + +PrincipalFilterType + +| **Value** | +| --------- | +| `"queryString"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/SearchGroupsResponse.md b/docs/v2/admin/models/SearchGroupsResponse.md new file mode 100644 index 00000000..513f8c3c --- /dev/null +++ b/docs/v2/admin/models/SearchGroupsResponse.md @@ -0,0 +1,12 @@ +# SearchGroupsResponse + +SearchGroupsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[Group] | Yes | | +**next_page_token** | Optional[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/SearchGroupsResponseDict.md b/docs/v2/admin/models/SearchGroupsResponseDict.md new file mode 100644 index 00000000..8164d3dd --- /dev/null +++ b/docs/v2/admin/models/SearchGroupsResponseDict.md @@ -0,0 +1,12 @@ +# SearchGroupsResponseDict + +SearchGroupsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[GroupDict] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/SearchUsersResponse.md b/docs/v2/admin/models/SearchUsersResponse.md new file mode 100644 index 00000000..c4f55920 --- /dev/null +++ b/docs/v2/admin/models/SearchUsersResponse.md @@ -0,0 +1,12 @@ +# SearchUsersResponse + +SearchUsersResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[User] | Yes | | +**next_page_token** | Optional[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/SearchUsersResponseDict.md b/docs/v2/admin/models/SearchUsersResponseDict.md new file mode 100644 index 00000000..dc46fd28 --- /dev/null +++ b/docs/v2/admin/models/SearchUsersResponseDict.md @@ -0,0 +1,12 @@ +# SearchUsersResponseDict + +SearchUsersResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[UserDict] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/User.md b/docs/v2/admin/models/User.md new file mode 100644 index 00000000..2c5051a1 --- /dev/null +++ b/docs/v2/admin/models/User.md @@ -0,0 +1,18 @@ +# User + +User + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**id** | PrincipalId | Yes | | +**username** | UserUsername | Yes | The Foundry username of the User. This is unique within the realm. | +**given_name** | Optional[StrictStr] | No | The given name of the User. | +**family_name** | Optional[StrictStr] | No | The family name (last name) of the User. | +**email** | Optional[StrictStr] | No | The email at which to contact a User. Multiple users may have the same email address. | +**realm** | Realm | Yes | | +**organization** | Optional[OrganizationRid] | No | The RID of the user's primary Organization. This will be blank for third-party application service users. | +**attributes** | Dict[AttributeName, AttributeValues] | Yes | A map of the User's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. Additional attributes may be configured by Foundry administrators in Control Panel and populated by the User's SSO provider upon login. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/models/UserDict.md b/docs/v2/admin/models/UserDict.md similarity index 87% rename from docs/v2/models/UserDict.md rename to docs/v2/admin/models/UserDict.md index 2dbc5948..077b31e9 100644 --- a/docs/v2/models/UserDict.md +++ b/docs/v2/admin/models/UserDict.md @@ -15,4 +15,4 @@ User **attributes** | Dict[AttributeName, AttributeValues] | Yes | A map of the User's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. Additional attributes may be configured by Foundry administrators in Control Panel and populated by the User's SSO provider upon login. | -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/UserSearchFilterDict.md b/docs/v2/admin/models/UserSearchFilterDict.md new file mode 100644 index 00000000..8d550340 --- /dev/null +++ b/docs/v2/admin/models/UserSearchFilterDict.md @@ -0,0 +1,12 @@ +# UserSearchFilterDict + +UserSearchFilter + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | PrincipalFilterType | Yes | | +**value** | StrictStr | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/admin/models/UserUsername.md b/docs/v2/admin/models/UserUsername.md new file mode 100644 index 00000000..d787856c --- /dev/null +++ b/docs/v2/admin/models/UserUsername.md @@ -0,0 +1,11 @@ +# UserUsername + +The Foundry username of the User. This is unique within the realm. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/AttachmentType.md b/docs/v2/core/models/AttachmentType.md new file mode 100644 index 00000000..9d058782 --- /dev/null +++ b/docs/v2/core/models/AttachmentType.md @@ -0,0 +1,11 @@ +# AttachmentType + +AttachmentType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["attachment"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/AttachmentTypeDict.md b/docs/v2/core/models/AttachmentTypeDict.md new file mode 100644 index 00000000..b5b32055 --- /dev/null +++ b/docs/v2/core/models/AttachmentTypeDict.md @@ -0,0 +1,11 @@ +# AttachmentTypeDict + +AttachmentType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["attachment"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/BooleanType.md b/docs/v2/core/models/BooleanType.md new file mode 100644 index 00000000..0c8a4323 --- /dev/null +++ b/docs/v2/core/models/BooleanType.md @@ -0,0 +1,11 @@ +# BooleanType + +BooleanType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["boolean"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/BooleanTypeDict.md b/docs/v2/core/models/BooleanTypeDict.md new file mode 100644 index 00000000..5393418c --- /dev/null +++ b/docs/v2/core/models/BooleanTypeDict.md @@ -0,0 +1,11 @@ +# BooleanTypeDict + +BooleanType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["boolean"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/ByteType.md b/docs/v2/core/models/ByteType.md new file mode 100644 index 00000000..5a69a03d --- /dev/null +++ b/docs/v2/core/models/ByteType.md @@ -0,0 +1,11 @@ +# ByteType + +ByteType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["byte"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/ByteTypeDict.md b/docs/v2/core/models/ByteTypeDict.md new file mode 100644 index 00000000..8e022d52 --- /dev/null +++ b/docs/v2/core/models/ByteTypeDict.md @@ -0,0 +1,11 @@ +# ByteTypeDict + +ByteType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["byte"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/ContentLength.md b/docs/v2/core/models/ContentLength.md new file mode 100644 index 00000000..a3d87899 --- /dev/null +++ b/docs/v2/core/models/ContentLength.md @@ -0,0 +1,11 @@ +# ContentLength + +ContentLength + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/ContentType.md b/docs/v2/core/models/ContentType.md new file mode 100644 index 00000000..8b04cc30 --- /dev/null +++ b/docs/v2/core/models/ContentType.md @@ -0,0 +1,11 @@ +# ContentType + +ContentType + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/CreatedBy.md b/docs/v2/core/models/CreatedBy.md new file mode 100644 index 00000000..ce3c4a30 --- /dev/null +++ b/docs/v2/core/models/CreatedBy.md @@ -0,0 +1,11 @@ +# CreatedBy + +The Foundry user who created this resource + +## Type +```python +PrincipalId +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/CreatedTime.md b/docs/v2/core/models/CreatedTime.md new file mode 100644 index 00000000..f450d553 --- /dev/null +++ b/docs/v2/core/models/CreatedTime.md @@ -0,0 +1,12 @@ +# CreatedTime + +The time at which the resource was created. + + +## Type +```python +datetime +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/DateType.md b/docs/v2/core/models/DateType.md new file mode 100644 index 00000000..dd820f1b --- /dev/null +++ b/docs/v2/core/models/DateType.md @@ -0,0 +1,11 @@ +# DateType + +DateType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["date"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/DateTypeDict.md b/docs/v2/core/models/DateTypeDict.md new file mode 100644 index 00000000..78ff464f --- /dev/null +++ b/docs/v2/core/models/DateTypeDict.md @@ -0,0 +1,11 @@ +# DateTypeDict + +DateType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["date"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/DecimalType.md b/docs/v2/core/models/DecimalType.md new file mode 100644 index 00000000..a283be72 --- /dev/null +++ b/docs/v2/core/models/DecimalType.md @@ -0,0 +1,13 @@ +# DecimalType + +DecimalType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**precision** | Optional[StrictInt] | No | | +**scale** | Optional[StrictInt] | No | | +**type** | Literal["decimal"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/DecimalTypeDict.md b/docs/v2/core/models/DecimalTypeDict.md new file mode 100644 index 00000000..5f5a8cb1 --- /dev/null +++ b/docs/v2/core/models/DecimalTypeDict.md @@ -0,0 +1,13 @@ +# DecimalTypeDict + +DecimalType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**precision** | NotRequired[StrictInt] | No | | +**scale** | NotRequired[StrictInt] | No | | +**type** | Literal["decimal"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/DisplayName.md b/docs/v2/core/models/DisplayName.md new file mode 100644 index 00000000..cc6399bb --- /dev/null +++ b/docs/v2/core/models/DisplayName.md @@ -0,0 +1,11 @@ +# DisplayName + +The display name of the entity. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/Distance.md b/docs/v2/core/models/Distance.md new file mode 100644 index 00000000..19d4bd07 --- /dev/null +++ b/docs/v2/core/models/Distance.md @@ -0,0 +1,12 @@ +# Distance + +A measurement of distance. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | StrictFloat | Yes | | +**unit** | DistanceUnit | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/DistanceDict.md b/docs/v2/core/models/DistanceDict.md new file mode 100644 index 00000000..5a994929 --- /dev/null +++ b/docs/v2/core/models/DistanceDict.md @@ -0,0 +1,12 @@ +# DistanceDict + +A measurement of distance. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | StrictFloat | Yes | | +**unit** | DistanceUnit | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/DistanceUnit.md b/docs/v2/core/models/DistanceUnit.md new file mode 100644 index 00000000..8c307f2b --- /dev/null +++ b/docs/v2/core/models/DistanceUnit.md @@ -0,0 +1,18 @@ +# DistanceUnit + +DistanceUnit + +| **Value** | +| --------- | +| `"MILLIMETERS"` | +| `"CENTIMETERS"` | +| `"METERS"` | +| `"KILOMETERS"` | +| `"INCHES"` | +| `"FEET"` | +| `"YARDS"` | +| `"MILES"` | +| `"NAUTICAL_MILES"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/DoubleType.md b/docs/v2/core/models/DoubleType.md new file mode 100644 index 00000000..55f1765c --- /dev/null +++ b/docs/v2/core/models/DoubleType.md @@ -0,0 +1,11 @@ +# DoubleType + +DoubleType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["double"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/DoubleTypeDict.md b/docs/v2/core/models/DoubleTypeDict.md new file mode 100644 index 00000000..083ce097 --- /dev/null +++ b/docs/v2/core/models/DoubleTypeDict.md @@ -0,0 +1,11 @@ +# DoubleTypeDict + +DoubleType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["double"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/Duration.md b/docs/v2/core/models/Duration.md new file mode 100644 index 00000000..011fd4e5 --- /dev/null +++ b/docs/v2/core/models/Duration.md @@ -0,0 +1,12 @@ +# Duration + +A measurement of duration. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | StrictInt | Yes | The duration value. | +**unit** | TimeUnit | Yes | The unit of duration. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/DurationDict.md b/docs/v2/core/models/DurationDict.md new file mode 100644 index 00000000..4c7b7e99 --- /dev/null +++ b/docs/v2/core/models/DurationDict.md @@ -0,0 +1,12 @@ +# DurationDict + +A measurement of duration. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | StrictInt | Yes | The duration value. | +**unit** | TimeUnit | Yes | The unit of duration. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/FilePath.md b/docs/v2/core/models/FilePath.md new file mode 100644 index 00000000..70323713 --- /dev/null +++ b/docs/v2/core/models/FilePath.md @@ -0,0 +1,12 @@ +# FilePath + +The path to a File within Foundry. Examples: `my-file.txt`, `path/to/my-file.jpg`, `dataframe.snappy.parquet`. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/Filename.md b/docs/v2/core/models/Filename.md new file mode 100644 index 00000000..9787d72e --- /dev/null +++ b/docs/v2/core/models/Filename.md @@ -0,0 +1,12 @@ +# Filename + +The name of a File within Foundry. Examples: `my-file.txt`, `my-file.jpg`, `dataframe.snappy.parquet`. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/FloatType.md b/docs/v2/core/models/FloatType.md new file mode 100644 index 00000000..3890980b --- /dev/null +++ b/docs/v2/core/models/FloatType.md @@ -0,0 +1,11 @@ +# FloatType + +FloatType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["float"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/FloatTypeDict.md b/docs/v2/core/models/FloatTypeDict.md new file mode 100644 index 00000000..c01ab804 --- /dev/null +++ b/docs/v2/core/models/FloatTypeDict.md @@ -0,0 +1,11 @@ +# FloatTypeDict + +FloatType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["float"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/GeoPointType.md b/docs/v2/core/models/GeoPointType.md new file mode 100644 index 00000000..9118eea0 --- /dev/null +++ b/docs/v2/core/models/GeoPointType.md @@ -0,0 +1,11 @@ +# GeoPointType + +GeoPointType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["geopoint"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/GeoPointTypeDict.md b/docs/v2/core/models/GeoPointTypeDict.md new file mode 100644 index 00000000..ffe9b04e --- /dev/null +++ b/docs/v2/core/models/GeoPointTypeDict.md @@ -0,0 +1,11 @@ +# GeoPointTypeDict + +GeoPointType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["geopoint"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/GeoShapeType.md b/docs/v2/core/models/GeoShapeType.md new file mode 100644 index 00000000..acaef278 --- /dev/null +++ b/docs/v2/core/models/GeoShapeType.md @@ -0,0 +1,11 @@ +# GeoShapeType + +GeoShapeType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["geoshape"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/GeoShapeTypeDict.md b/docs/v2/core/models/GeoShapeTypeDict.md new file mode 100644 index 00000000..5e906526 --- /dev/null +++ b/docs/v2/core/models/GeoShapeTypeDict.md @@ -0,0 +1,11 @@ +# GeoShapeTypeDict + +GeoShapeType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["geoshape"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/IntegerType.md b/docs/v2/core/models/IntegerType.md new file mode 100644 index 00000000..fa78c00c --- /dev/null +++ b/docs/v2/core/models/IntegerType.md @@ -0,0 +1,11 @@ +# IntegerType + +IntegerType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["integer"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/IntegerTypeDict.md b/docs/v2/core/models/IntegerTypeDict.md new file mode 100644 index 00000000..2d0d0204 --- /dev/null +++ b/docs/v2/core/models/IntegerTypeDict.md @@ -0,0 +1,11 @@ +# IntegerTypeDict + +IntegerType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["integer"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/LongType.md b/docs/v2/core/models/LongType.md new file mode 100644 index 00000000..5419e442 --- /dev/null +++ b/docs/v2/core/models/LongType.md @@ -0,0 +1,11 @@ +# LongType + +LongType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["long"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/LongTypeDict.md b/docs/v2/core/models/LongTypeDict.md new file mode 100644 index 00000000..dc34d663 --- /dev/null +++ b/docs/v2/core/models/LongTypeDict.md @@ -0,0 +1,11 @@ +# LongTypeDict + +LongType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["long"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/MarkingId.md b/docs/v2/core/models/MarkingId.md new file mode 100644 index 00000000..5f00d3c7 --- /dev/null +++ b/docs/v2/core/models/MarkingId.md @@ -0,0 +1,11 @@ +# MarkingId + +The ID of a security marking. + +## Type +```python +UUID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/MarkingType.md b/docs/v2/core/models/MarkingType.md new file mode 100644 index 00000000..ddc4a13f --- /dev/null +++ b/docs/v2/core/models/MarkingType.md @@ -0,0 +1,11 @@ +# MarkingType + +MarkingType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["marking"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/MarkingTypeDict.md b/docs/v2/core/models/MarkingTypeDict.md new file mode 100644 index 00000000..9b12a89b --- /dev/null +++ b/docs/v2/core/models/MarkingTypeDict.md @@ -0,0 +1,11 @@ +# MarkingTypeDict + +MarkingType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["marking"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/MediaSetRid.md b/docs/v2/core/models/MediaSetRid.md new file mode 100644 index 00000000..58bde4b3 --- /dev/null +++ b/docs/v2/core/models/MediaSetRid.md @@ -0,0 +1,11 @@ +# MediaSetRid + +The Resource Identifier (RID) of a Media Set + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/MediaType.md b/docs/v2/core/models/MediaType.md new file mode 100644 index 00000000..4ae5aa1d --- /dev/null +++ b/docs/v2/core/models/MediaType.md @@ -0,0 +1,13 @@ +# MediaType + +The [media type](https://www.iana.org/assignments/media-types/media-types.xhtml) of the file or attachment. +Examples: `application/json`, `application/pdf`, `application/octet-stream`, `image/jpeg` + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/NullType.md b/docs/v2/core/models/NullType.md new file mode 100644 index 00000000..eb3fcd49 --- /dev/null +++ b/docs/v2/core/models/NullType.md @@ -0,0 +1,11 @@ +# NullType + +NullType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["null"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/NullTypeDict.md b/docs/v2/core/models/NullTypeDict.md new file mode 100644 index 00000000..0fe67033 --- /dev/null +++ b/docs/v2/core/models/NullTypeDict.md @@ -0,0 +1,11 @@ +# NullTypeDict + +NullType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["null"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/OrganizationRid.md b/docs/v2/core/models/OrganizationRid.md new file mode 100644 index 00000000..ee7721df --- /dev/null +++ b/docs/v2/core/models/OrganizationRid.md @@ -0,0 +1,11 @@ +# OrganizationRid + +OrganizationRid + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/PageSize.md b/docs/v2/core/models/PageSize.md new file mode 100644 index 00000000..b8dc04eb --- /dev/null +++ b/docs/v2/core/models/PageSize.md @@ -0,0 +1,11 @@ +# PageSize + +The page size to use for the endpoint. + +## Type +```python +StrictInt +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/PageToken.md b/docs/v2/core/models/PageToken.md new file mode 100644 index 00000000..05dee98b --- /dev/null +++ b/docs/v2/core/models/PageToken.md @@ -0,0 +1,13 @@ +# PageToken + +The page token indicates where to start paging. This should be omitted from the first page's request. + To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response + and populate the next request's `pageToken` field with it. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/PreviewMode.md b/docs/v2/core/models/PreviewMode.md new file mode 100644 index 00000000..a2d9d5d9 --- /dev/null +++ b/docs/v2/core/models/PreviewMode.md @@ -0,0 +1,11 @@ +# PreviewMode + +Enables the use of preview functionality. + +## Type +```python +StrictBool +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/PrincipalId.md b/docs/v2/core/models/PrincipalId.md new file mode 100644 index 00000000..bdc569bf --- /dev/null +++ b/docs/v2/core/models/PrincipalId.md @@ -0,0 +1,11 @@ +# PrincipalId + +The ID of a Foundry Group or User. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/PrincipalType.md b/docs/v2/core/models/PrincipalType.md new file mode 100644 index 00000000..5b00c218 --- /dev/null +++ b/docs/v2/core/models/PrincipalType.md @@ -0,0 +1,11 @@ +# PrincipalType + +PrincipalType + +| **Value** | +| --------- | +| `"USER"` | +| `"GROUP"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/Realm.md b/docs/v2/core/models/Realm.md new file mode 100644 index 00000000..48efaed2 --- /dev/null +++ b/docs/v2/core/models/Realm.md @@ -0,0 +1,13 @@ +# Realm + +Identifies which Realm a User or Group is a member of. +The `palantir-internal-realm` is used for Users or Groups that are created in Foundry by administrators and not associated with any SSO provider. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/ReleaseStatus.md b/docs/v2/core/models/ReleaseStatus.md new file mode 100644 index 00000000..5cfa7656 --- /dev/null +++ b/docs/v2/core/models/ReleaseStatus.md @@ -0,0 +1,12 @@ +# ReleaseStatus + +The release status of the entity. + +| **Value** | +| --------- | +| `"ACTIVE"` | +| `"EXPERIMENTAL"` | +| `"DEPRECATED"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/ShortType.md b/docs/v2/core/models/ShortType.md new file mode 100644 index 00000000..f1973690 --- /dev/null +++ b/docs/v2/core/models/ShortType.md @@ -0,0 +1,11 @@ +# ShortType + +ShortType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["short"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/ShortTypeDict.md b/docs/v2/core/models/ShortTypeDict.md new file mode 100644 index 00000000..62a43bf6 --- /dev/null +++ b/docs/v2/core/models/ShortTypeDict.md @@ -0,0 +1,11 @@ +# ShortTypeDict + +ShortType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["short"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/SizeBytes.md b/docs/v2/core/models/SizeBytes.md new file mode 100644 index 00000000..63d03a0e --- /dev/null +++ b/docs/v2/core/models/SizeBytes.md @@ -0,0 +1,11 @@ +# SizeBytes + +The size of the file or attachment in bytes. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/StringType.md b/docs/v2/core/models/StringType.md new file mode 100644 index 00000000..a82271b7 --- /dev/null +++ b/docs/v2/core/models/StringType.md @@ -0,0 +1,11 @@ +# StringType + +StringType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["string"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/StringTypeDict.md b/docs/v2/core/models/StringTypeDict.md new file mode 100644 index 00000000..7f55f6b1 --- /dev/null +++ b/docs/v2/core/models/StringTypeDict.md @@ -0,0 +1,11 @@ +# StringTypeDict + +StringType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["string"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/StructFieldName.md b/docs/v2/core/models/StructFieldName.md new file mode 100644 index 00000000..ad143bfd --- /dev/null +++ b/docs/v2/core/models/StructFieldName.md @@ -0,0 +1,12 @@ +# StructFieldName + +The name of a field in a `Struct`. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/TimeSeriesItemType.md b/docs/v2/core/models/TimeSeriesItemType.md new file mode 100644 index 00000000..e647deb3 --- /dev/null +++ b/docs/v2/core/models/TimeSeriesItemType.md @@ -0,0 +1,17 @@ +# TimeSeriesItemType + +A union of the types supported by time series properties. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +StringType | string +DoubleType | double + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/TimeSeriesItemTypeDict.md b/docs/v2/core/models/TimeSeriesItemTypeDict.md new file mode 100644 index 00000000..cd06de7f --- /dev/null +++ b/docs/v2/core/models/TimeSeriesItemTypeDict.md @@ -0,0 +1,17 @@ +# TimeSeriesItemTypeDict + +A union of the types supported by time series properties. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +StringTypeDict | string +DoubleTypeDict | double + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/TimeUnit.md b/docs/v2/core/models/TimeUnit.md new file mode 100644 index 00000000..f814f5ad --- /dev/null +++ b/docs/v2/core/models/TimeUnit.md @@ -0,0 +1,17 @@ +# TimeUnit + +TimeUnit + +| **Value** | +| --------- | +| `"MILLISECONDS"` | +| `"SECONDS"` | +| `"MINUTES"` | +| `"HOURS"` | +| `"DAYS"` | +| `"WEEKS"` | +| `"MONTHS"` | +| `"YEARS"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/TimeseriesType.md b/docs/v2/core/models/TimeseriesType.md new file mode 100644 index 00000000..e662b020 --- /dev/null +++ b/docs/v2/core/models/TimeseriesType.md @@ -0,0 +1,12 @@ +# TimeseriesType + +TimeseriesType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**item_type** | TimeSeriesItemType | Yes | | +**type** | Literal["timeseries"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/TimeseriesTypeDict.md b/docs/v2/core/models/TimeseriesTypeDict.md new file mode 100644 index 00000000..c0bc0ab3 --- /dev/null +++ b/docs/v2/core/models/TimeseriesTypeDict.md @@ -0,0 +1,12 @@ +# TimeseriesTypeDict + +TimeseriesType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**itemType** | TimeSeriesItemTypeDict | Yes | | +**type** | Literal["timeseries"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/TimestampType.md b/docs/v2/core/models/TimestampType.md new file mode 100644 index 00000000..914eec11 --- /dev/null +++ b/docs/v2/core/models/TimestampType.md @@ -0,0 +1,11 @@ +# TimestampType + +TimestampType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["timestamp"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/TimestampTypeDict.md b/docs/v2/core/models/TimestampTypeDict.md new file mode 100644 index 00000000..20ffd0af --- /dev/null +++ b/docs/v2/core/models/TimestampTypeDict.md @@ -0,0 +1,11 @@ +# TimestampTypeDict + +TimestampType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["timestamp"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/TotalCount.md b/docs/v2/core/models/TotalCount.md new file mode 100644 index 00000000..a579c15d --- /dev/null +++ b/docs/v2/core/models/TotalCount.md @@ -0,0 +1,12 @@ +# TotalCount + +The total number of items across all pages. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/UnsupportedType.md b/docs/v2/core/models/UnsupportedType.md new file mode 100644 index 00000000..3f9e399f --- /dev/null +++ b/docs/v2/core/models/UnsupportedType.md @@ -0,0 +1,12 @@ +# UnsupportedType + +UnsupportedType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**unsupported_type** | StrictStr | Yes | | +**type** | Literal["unsupported"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/UnsupportedTypeDict.md b/docs/v2/core/models/UnsupportedTypeDict.md new file mode 100644 index 00000000..5bc2d0d9 --- /dev/null +++ b/docs/v2/core/models/UnsupportedTypeDict.md @@ -0,0 +1,12 @@ +# UnsupportedTypeDict + +UnsupportedType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**unsupportedType** | StrictStr | Yes | | +**type** | Literal["unsupported"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/UpdatedBy.md b/docs/v2/core/models/UpdatedBy.md new file mode 100644 index 00000000..b860b731 --- /dev/null +++ b/docs/v2/core/models/UpdatedBy.md @@ -0,0 +1,11 @@ +# UpdatedBy + +The Foundry user who last updated this resource + +## Type +```python +UserId +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/UpdatedTime.md b/docs/v2/core/models/UpdatedTime.md new file mode 100644 index 00000000..e46019f7 --- /dev/null +++ b/docs/v2/core/models/UpdatedTime.md @@ -0,0 +1,12 @@ +# UpdatedTime + +The time at which the resource was most recently updated. + + +## Type +```python +datetime +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/UserId.md b/docs/v2/core/models/UserId.md new file mode 100644 index 00000000..caac8524 --- /dev/null +++ b/docs/v2/core/models/UserId.md @@ -0,0 +1,11 @@ +# UserId + +A Foundry User ID. + +## Type +```python +UUID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/Branch.md b/docs/v2/datasets/models/Branch.md new file mode 100644 index 00000000..dc4e8960 --- /dev/null +++ b/docs/v2/datasets/models/Branch.md @@ -0,0 +1,12 @@ +# Branch + +Branch + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**name** | BranchName | Yes | | +**transaction_rid** | Optional[TransactionRid] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/BranchDict.md b/docs/v2/datasets/models/BranchDict.md new file mode 100644 index 00000000..9c7a17c4 --- /dev/null +++ b/docs/v2/datasets/models/BranchDict.md @@ -0,0 +1,12 @@ +# BranchDict + +Branch + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**name** | BranchName | Yes | | +**transactionRid** | NotRequired[TransactionRid] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/BranchName.md b/docs/v2/datasets/models/BranchName.md new file mode 100644 index 00000000..056082cc --- /dev/null +++ b/docs/v2/datasets/models/BranchName.md @@ -0,0 +1,12 @@ +# BranchName + +The name of a Branch. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/Dataset.md b/docs/v2/datasets/models/Dataset.md new file mode 100644 index 00000000..ab30e61e --- /dev/null +++ b/docs/v2/datasets/models/Dataset.md @@ -0,0 +1,13 @@ +# Dataset + +Dataset + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | DatasetRid | Yes | | +**name** | DatasetName | Yes | | +**parent_folder_rid** | FolderRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/DatasetDict.md b/docs/v2/datasets/models/DatasetDict.md new file mode 100644 index 00000000..b82426df --- /dev/null +++ b/docs/v2/datasets/models/DatasetDict.md @@ -0,0 +1,13 @@ +# DatasetDict + +Dataset + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | DatasetRid | Yes | | +**name** | DatasetName | Yes | | +**parentFolderRid** | FolderRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/DatasetName.md b/docs/v2/datasets/models/DatasetName.md new file mode 100644 index 00000000..9cc3ad75 --- /dev/null +++ b/docs/v2/datasets/models/DatasetName.md @@ -0,0 +1,11 @@ +# DatasetName + +DatasetName + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/DatasetRid.md b/docs/v2/datasets/models/DatasetRid.md new file mode 100644 index 00000000..86d5f357 --- /dev/null +++ b/docs/v2/datasets/models/DatasetRid.md @@ -0,0 +1,12 @@ +# DatasetRid + +The Resource Identifier (RID) of a Dataset. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/File.md b/docs/v2/datasets/models/File.md new file mode 100644 index 00000000..76add7d6 --- /dev/null +++ b/docs/v2/datasets/models/File.md @@ -0,0 +1,14 @@ +# File + +File + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**path** | FilePath | Yes | | +**transaction_rid** | TransactionRid | Yes | | +**size_bytes** | Optional[StrictStr] | No | | +**updated_time** | FileUpdatedTime | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/FileDict.md b/docs/v2/datasets/models/FileDict.md new file mode 100644 index 00000000..973e713a --- /dev/null +++ b/docs/v2/datasets/models/FileDict.md @@ -0,0 +1,14 @@ +# FileDict + +File + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**path** | FilePath | Yes | | +**transactionRid** | TransactionRid | Yes | | +**sizeBytes** | NotRequired[StrictStr] | No | | +**updatedTime** | FileUpdatedTime | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/FileUpdatedTime.md b/docs/v2/datasets/models/FileUpdatedTime.md new file mode 100644 index 00000000..6562c485 --- /dev/null +++ b/docs/v2/datasets/models/FileUpdatedTime.md @@ -0,0 +1,11 @@ +# FileUpdatedTime + +FileUpdatedTime + +## Type +```python +datetime +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/ListBranchesResponse.md b/docs/v2/datasets/models/ListBranchesResponse.md new file mode 100644 index 00000000..ba485a9c --- /dev/null +++ b/docs/v2/datasets/models/ListBranchesResponse.md @@ -0,0 +1,12 @@ +# ListBranchesResponse + +ListBranchesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[Branch] | Yes | | +**next_page_token** | Optional[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/ListBranchesResponseDict.md b/docs/v2/datasets/models/ListBranchesResponseDict.md new file mode 100644 index 00000000..9ba7b278 --- /dev/null +++ b/docs/v2/datasets/models/ListBranchesResponseDict.md @@ -0,0 +1,12 @@ +# ListBranchesResponseDict + +ListBranchesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[BranchDict] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/ListFilesResponse.md b/docs/v2/datasets/models/ListFilesResponse.md new file mode 100644 index 00000000..e3e2ba81 --- /dev/null +++ b/docs/v2/datasets/models/ListFilesResponse.md @@ -0,0 +1,12 @@ +# ListFilesResponse + +ListFilesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[File] | Yes | | +**next_page_token** | Optional[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/ListFilesResponseDict.md b/docs/v2/datasets/models/ListFilesResponseDict.md new file mode 100644 index 00000000..21c4c8b3 --- /dev/null +++ b/docs/v2/datasets/models/ListFilesResponseDict.md @@ -0,0 +1,12 @@ +# ListFilesResponseDict + +ListFilesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[FileDict] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/TableExportFormat.md b/docs/v2/datasets/models/TableExportFormat.md new file mode 100644 index 00000000..d108384a --- /dev/null +++ b/docs/v2/datasets/models/TableExportFormat.md @@ -0,0 +1,12 @@ +# TableExportFormat + +Format for tabular dataset export. + + +| **Value** | +| --------- | +| `"ARROW"` | +| `"CSV"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/Transaction.md b/docs/v2/datasets/models/Transaction.md new file mode 100644 index 00000000..ab9990d4 --- /dev/null +++ b/docs/v2/datasets/models/Transaction.md @@ -0,0 +1,15 @@ +# Transaction + +Transaction + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | TransactionRid | Yes | | +**transaction_type** | TransactionType | Yes | | +**status** | TransactionStatus | Yes | | +**created_time** | TransactionCreatedTime | Yes | The timestamp when the transaction was created, in ISO 8601 timestamp format. | +**closed_time** | Optional[datetime] | No | The timestamp when the transaction was closed, in ISO 8601 timestamp format. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/TransactionCreatedTime.md b/docs/v2/datasets/models/TransactionCreatedTime.md new file mode 100644 index 00000000..94fc46ee --- /dev/null +++ b/docs/v2/datasets/models/TransactionCreatedTime.md @@ -0,0 +1,12 @@ +# TransactionCreatedTime + +The timestamp when the transaction was created, in ISO 8601 timestamp format. + + +## Type +```python +datetime +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/TransactionDict.md b/docs/v2/datasets/models/TransactionDict.md new file mode 100644 index 00000000..ed36a871 --- /dev/null +++ b/docs/v2/datasets/models/TransactionDict.md @@ -0,0 +1,15 @@ +# TransactionDict + +Transaction + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | TransactionRid | Yes | | +**transactionType** | TransactionType | Yes | | +**status** | TransactionStatus | Yes | | +**createdTime** | TransactionCreatedTime | Yes | The timestamp when the transaction was created, in ISO 8601 timestamp format. | +**closedTime** | NotRequired[datetime] | No | The timestamp when the transaction was closed, in ISO 8601 timestamp format. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/TransactionRid.md b/docs/v2/datasets/models/TransactionRid.md new file mode 100644 index 00000000..4d33f703 --- /dev/null +++ b/docs/v2/datasets/models/TransactionRid.md @@ -0,0 +1,12 @@ +# TransactionRid + +The Resource Identifier (RID) of a Transaction. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/TransactionStatus.md b/docs/v2/datasets/models/TransactionStatus.md new file mode 100644 index 00000000..fd6f677d --- /dev/null +++ b/docs/v2/datasets/models/TransactionStatus.md @@ -0,0 +1,13 @@ +# TransactionStatus + +The status of a Transaction. + + +| **Value** | +| --------- | +| `"ABORTED"` | +| `"COMMITTED"` | +| `"OPEN"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/datasets/models/TransactionType.md b/docs/v2/datasets/models/TransactionType.md new file mode 100644 index 00000000..ab12c2fa --- /dev/null +++ b/docs/v2/datasets/models/TransactionType.md @@ -0,0 +1,14 @@ +# TransactionType + +The type of a Transaction. + + +| **Value** | +| --------- | +| `"APPEND"` | +| `"UPDATE"` | +| `"SNAPSHOT"` | +| `"DELETE"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/filesystem/models/FolderRid.md b/docs/v2/filesystem/models/FolderRid.md new file mode 100644 index 00000000..028ea08d --- /dev/null +++ b/docs/v2/filesystem/models/FolderRid.md @@ -0,0 +1,11 @@ +# FolderRid + +The unique resource identifier (RID) of a Folder. + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/filesystem/models/ProjectRid.md b/docs/v2/filesystem/models/ProjectRid.md new file mode 100644 index 00000000..aea3cfd6 --- /dev/null +++ b/docs/v2/filesystem/models/ProjectRid.md @@ -0,0 +1,11 @@ +# ProjectRid + +The unique resource identifier (RID) of a Project. + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/geo/models/BBox.md b/docs/v2/geo/models/BBox.md new file mode 100644 index 00000000..b21a5fec --- /dev/null +++ b/docs/v2/geo/models/BBox.md @@ -0,0 +1,18 @@ +# BBox + +A GeoJSON object MAY have a member named "bbox" to include +information on the coordinate range for its Geometries, Features, or +FeatureCollections. The value of the bbox member MUST be an array of +length 2*n where n is the number of dimensions represented in the +contained geometries, with all axes of the most southwesterly point +followed by all axes of the more northeasterly point. The axes order +of a bbox follows the axes order of geometries. + + +## Type +```python +List[Coordinate] +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/geo/models/Coordinate.md b/docs/v2/geo/models/Coordinate.md new file mode 100644 index 00000000..cfe77d07 --- /dev/null +++ b/docs/v2/geo/models/Coordinate.md @@ -0,0 +1,11 @@ +# Coordinate + +Coordinate + +## Type +```python +StrictFloat +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/geo/models/GeoPoint.md b/docs/v2/geo/models/GeoPoint.md new file mode 100644 index 00000000..5f99fa3a --- /dev/null +++ b/docs/v2/geo/models/GeoPoint.md @@ -0,0 +1,13 @@ +# GeoPoint + +GeoPoint + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**coordinates** | Position | Yes | | +**bbox** | Optional[BBox] | No | | +**type** | Literal["Point"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/geo/models/GeoPointDict.md b/docs/v2/geo/models/GeoPointDict.md new file mode 100644 index 00000000..038830c9 --- /dev/null +++ b/docs/v2/geo/models/GeoPointDict.md @@ -0,0 +1,13 @@ +# GeoPointDict + +GeoPoint + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**coordinates** | Position | Yes | | +**bbox** | NotRequired[BBox] | No | | +**type** | Literal["Point"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/geo/models/LinearRing.md b/docs/v2/geo/models/LinearRing.md new file mode 100644 index 00000000..e03df863 --- /dev/null +++ b/docs/v2/geo/models/LinearRing.md @@ -0,0 +1,22 @@ +# LinearRing + +A linear ring is a closed LineString with four or more positions. + +The first and last positions are equivalent, and they MUST contain +identical values; their representation SHOULD also be identical. + +A linear ring is the boundary of a surface or the boundary of a hole in +a surface. + +A linear ring MUST follow the right-hand rule with respect to the area +it bounds, i.e., exterior rings are counterclockwise, and holes are +clockwise. + + +## Type +```python +List[Position] +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/geo/models/Polygon.md b/docs/v2/geo/models/Polygon.md new file mode 100644 index 00000000..01331aef --- /dev/null +++ b/docs/v2/geo/models/Polygon.md @@ -0,0 +1,13 @@ +# Polygon + +Polygon + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**coordinates** | List[LinearRing] | Yes | | +**bbox** | Optional[BBox] | No | | +**type** | Literal["Polygon"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/geo/models/PolygonDict.md b/docs/v2/geo/models/PolygonDict.md new file mode 100644 index 00000000..a75c2513 --- /dev/null +++ b/docs/v2/geo/models/PolygonDict.md @@ -0,0 +1,13 @@ +# PolygonDict + +Polygon + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**coordinates** | List[LinearRing] | Yes | | +**bbox** | NotRequired[BBox] | No | | +**type** | Literal["Polygon"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/geo/models/Position.md b/docs/v2/geo/models/Position.md new file mode 100644 index 00000000..3c782038 --- /dev/null +++ b/docs/v2/geo/models/Position.md @@ -0,0 +1,25 @@ +# Position + +GeoJSon fundamental geometry construct. + +A position is an array of numbers. There MUST be two or more elements. +The first two elements are longitude and latitude, precisely in that order and using decimal numbers. +Altitude or elevation MAY be included as an optional third element. + +Implementations SHOULD NOT extend positions beyond three elements +because the semantics of extra elements are unspecified and ambiguous. +Historically, some implementations have used a fourth element to carry +a linear referencing measure (sometimes denoted as "M") or a numerical +timestamp, but in most situations a parser will not be able to properly +interpret these values. The interpretation and meaning of additional +elements is beyond the scope of this specification, and additional +elements MAY be ignored by parsers. + + +## Type +```python +List[Coordinate] +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/models/AbortOnFailure.md b/docs/v2/models/AbortOnFailure.md deleted file mode 100644 index 2b5da02d..00000000 --- a/docs/v2/models/AbortOnFailure.md +++ /dev/null @@ -1,13 +0,0 @@ -# AbortOnFailure - -If any job in the build is unsuccessful, immediately finish the -build by cancelling all other jobs. - - -## Type -```python -StrictBool -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AbsoluteTimeRange.md b/docs/v2/models/AbsoluteTimeRange.md deleted file mode 100644 index 7280e39a..00000000 --- a/docs/v2/models/AbsoluteTimeRange.md +++ /dev/null @@ -1,13 +0,0 @@ -# AbsoluteTimeRange - -ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**start_time** | Optional[datetime] | No | | -**end_time** | Optional[datetime] | No | | -**type** | Literal["absolute"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AbsoluteTimeRangeDict.md b/docs/v2/models/AbsoluteTimeRangeDict.md deleted file mode 100644 index 355cbf3d..00000000 --- a/docs/v2/models/AbsoluteTimeRangeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AbsoluteTimeRangeDict - -ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**startTime** | NotRequired[datetime] | No | | -**endTime** | NotRequired[datetime] | No | | -**type** | Literal["absolute"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Action.md b/docs/v2/models/Action.md deleted file mode 100644 index eb7bce15..00000000 --- a/docs/v2/models/Action.md +++ /dev/null @@ -1,18 +0,0 @@ -# Action - -Action - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**target** | BuildTarget | Yes | | -**branch_name** | BranchName | Yes | The target branch the schedule should run on. | -**fallback_branches** | FallbackBranches | Yes | | -**force_build** | ForceBuild | Yes | | -**retry_count** | Optional[RetryCount] | No | | -**retry_backoff_duration** | Optional[RetryBackoffDuration] | No | | -**abort_on_failure** | AbortOnFailure | Yes | | -**notifications_enabled** | NotificationsEnabled | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionMode.md b/docs/v2/models/ActionMode.md deleted file mode 100644 index e6a6c5b7..00000000 --- a/docs/v2/models/ActionMode.md +++ /dev/null @@ -1,12 +0,0 @@ -# ActionMode - -ActionMode - -| **Value** | -| --------- | -| `"ASYNC"` | -| `"RUN"` | -| `"VALIDATE"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionParameterArrayType.md b/docs/v2/models/ActionParameterArrayType.md deleted file mode 100644 index 6268b633..00000000 --- a/docs/v2/models/ActionParameterArrayType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ActionParameterArrayType - -ActionParameterArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**sub_type** | ActionParameterType | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionParameterArrayTypeDict.md b/docs/v2/models/ActionParameterArrayTypeDict.md deleted file mode 100644 index 0701a05d..00000000 --- a/docs/v2/models/ActionParameterArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ActionParameterArrayTypeDict - -ActionParameterArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | ActionParameterTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionParameterType.md b/docs/v2/models/ActionParameterType.md deleted file mode 100644 index 3123490d..00000000 --- a/docs/v2/models/ActionParameterType.md +++ /dev/null @@ -1,27 +0,0 @@ -# ActionParameterType - -A union of all the types supported by Ontology Action parameters. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ActionParameterArrayType](ActionParameterArrayType.md) | array -[AttachmentType](AttachmentType.md) | attachment -[BooleanType](BooleanType.md) | boolean -[DateType](DateType.md) | date -[DoubleType](DoubleType.md) | double -[IntegerType](IntegerType.md) | integer -[LongType](LongType.md) | long -[MarkingType](MarkingType.md) | marking -[OntologyObjectSetType](OntologyObjectSetType.md) | objectSet -[OntologyObjectType](OntologyObjectType.md) | object -[StringType](StringType.md) | string -[TimestampType](TimestampType.md) | timestamp - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionParameterTypeDict.md b/docs/v2/models/ActionParameterTypeDict.md deleted file mode 100644 index 58c13e50..00000000 --- a/docs/v2/models/ActionParameterTypeDict.md +++ /dev/null @@ -1,27 +0,0 @@ -# ActionParameterTypeDict - -A union of all the types supported by Ontology Action parameters. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ActionParameterArrayTypeDict](ActionParameterArrayTypeDict.md) | array -[AttachmentTypeDict](AttachmentTypeDict.md) | attachment -[BooleanTypeDict](BooleanTypeDict.md) | boolean -[DateTypeDict](DateTypeDict.md) | date -[DoubleTypeDict](DoubleTypeDict.md) | double -[IntegerTypeDict](IntegerTypeDict.md) | integer -[LongTypeDict](LongTypeDict.md) | long -[MarkingTypeDict](MarkingTypeDict.md) | marking -[OntologyObjectSetTypeDict](OntologyObjectSetTypeDict.md) | objectSet -[OntologyObjectTypeDict](OntologyObjectTypeDict.md) | object -[StringTypeDict](StringTypeDict.md) | string -[TimestampTypeDict](TimestampTypeDict.md) | timestamp - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionParameterV2.md b/docs/v2/models/ActionParameterV2.md deleted file mode 100644 index 0d7c668b..00000000 --- a/docs/v2/models/ActionParameterV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# ActionParameterV2 - -Details about a parameter of an action. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | Optional[StrictStr] | No | | -**data_type** | ActionParameterType | Yes | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionParameterV2Dict.md b/docs/v2/models/ActionParameterV2Dict.md deleted file mode 100644 index 93d5a351..00000000 --- a/docs/v2/models/ActionParameterV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ActionParameterV2Dict - -Details about a parameter of an action. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[StrictStr] | No | | -**dataType** | ActionParameterTypeDict | Yes | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionResults.md b/docs/v2/models/ActionResults.md deleted file mode 100644 index 91027a66..00000000 --- a/docs/v2/models/ActionResults.md +++ /dev/null @@ -1,16 +0,0 @@ -# ActionResults - -ActionResults - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectEdits](ObjectEdits.md) | edits -[ObjectTypeEdits](ObjectTypeEdits.md) | largeScaleEdits - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionResultsDict.md b/docs/v2/models/ActionResultsDict.md deleted file mode 100644 index de02ad6f..00000000 --- a/docs/v2/models/ActionResultsDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ActionResultsDict - -ActionResults - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectEditsDict](ObjectEditsDict.md) | edits -[ObjectTypeEditsDict](ObjectTypeEditsDict.md) | largeScaleEdits - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionRid.md b/docs/v2/models/ActionRid.md deleted file mode 100644 index faaefe83..00000000 --- a/docs/v2/models/ActionRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ActionRid - -The unique resource identifier for an action. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionType.md b/docs/v2/models/ActionType.md deleted file mode 100644 index 2fa54196..00000000 --- a/docs/v2/models/ActionType.md +++ /dev/null @@ -1,17 +0,0 @@ -# ActionType - -Represents an action type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | ActionTypeApiName | Yes | | -**description** | Optional[StrictStr] | No | | -**display_name** | Optional[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**parameters** | Dict[ParameterId, Parameter] | Yes | | -**rid** | ActionTypeRid | Yes | | -**operations** | List[LogicRule] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionTypeApiName.md b/docs/v2/models/ActionTypeApiName.md deleted file mode 100644 index 29ebf49d..00000000 --- a/docs/v2/models/ActionTypeApiName.md +++ /dev/null @@ -1,13 +0,0 @@ -# ActionTypeApiName - -The name of the action type in the API. To find the API name for your Action Type, use the `List action types` -endpoint or check the **Ontology Manager**. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionTypeDict.md b/docs/v2/models/ActionTypeDict.md deleted file mode 100644 index 3aa9e813..00000000 --- a/docs/v2/models/ActionTypeDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ActionTypeDict - -Represents an action type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ActionTypeApiName | Yes | | -**description** | NotRequired[StrictStr] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**parameters** | Dict[ParameterId, ParameterDict] | Yes | | -**rid** | ActionTypeRid | Yes | | -**operations** | List[LogicRuleDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionTypeRid.md b/docs/v2/models/ActionTypeRid.md deleted file mode 100644 index c3b0a48f..00000000 --- a/docs/v2/models/ActionTypeRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# ActionTypeRid - -The unique resource identifier of an action type, useful for interacting with other Foundry APIs. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionTypeV2.md b/docs/v2/models/ActionTypeV2.md deleted file mode 100644 index a7fc542e..00000000 --- a/docs/v2/models/ActionTypeV2.md +++ /dev/null @@ -1,17 +0,0 @@ -# ActionTypeV2 - -Represents an action type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | ActionTypeApiName | Yes | | -**description** | Optional[StrictStr] | No | | -**display_name** | Optional[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**parameters** | Dict[ParameterId, ActionParameterV2] | Yes | | -**rid** | ActionTypeRid | Yes | | -**operations** | List[LogicRule] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ActionTypeV2Dict.md b/docs/v2/models/ActionTypeV2Dict.md deleted file mode 100644 index 4e20f8ee..00000000 --- a/docs/v2/models/ActionTypeV2Dict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ActionTypeV2Dict - -Represents an action type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ActionTypeApiName | Yes | | -**description** | NotRequired[StrictStr] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**parameters** | Dict[ParameterId, ActionParameterV2Dict] | Yes | | -**rid** | ActionTypeRid | Yes | | -**operations** | List[LogicRuleDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AddGroupMembersRequest.md b/docs/v2/models/AddGroupMembersRequest.md deleted file mode 100644 index 4c040543..00000000 --- a/docs/v2/models/AddGroupMembersRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# AddGroupMembersRequest - -AddGroupMembersRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**principal_ids** | List[PrincipalId] | Yes | | -**expiration** | Optional[GroupMembershipExpiration] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AddGroupMembersRequestDict.md b/docs/v2/models/AddGroupMembersRequestDict.md deleted file mode 100644 index 004c9862..00000000 --- a/docs/v2/models/AddGroupMembersRequestDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AddGroupMembersRequestDict - -AddGroupMembersRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**principalIds** | List[PrincipalId] | Yes | | -**expiration** | NotRequired[GroupMembershipExpiration] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AddLink.md b/docs/v2/models/AddLink.md deleted file mode 100644 index d8da9ae0..00000000 --- a/docs/v2/models/AddLink.md +++ /dev/null @@ -1,15 +0,0 @@ -# AddLink - -AddLink - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**link_type_api_name_ato_b** | LinkTypeApiName | Yes | | -**link_type_api_name_bto_a** | LinkTypeApiName | Yes | | -**a_side_object** | LinkSideObject | Yes | | -**b_side_object** | LinkSideObject | Yes | | -**type** | Literal["addLink"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AddLinkDict.md b/docs/v2/models/AddLinkDict.md deleted file mode 100644 index 0dd1d1e6..00000000 --- a/docs/v2/models/AddLinkDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# AddLinkDict - -AddLink - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | -**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | -**aSideObject** | LinkSideObjectDict | Yes | | -**bSideObject** | LinkSideObjectDict | Yes | | -**type** | Literal["addLink"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AddObject.md b/docs/v2/models/AddObject.md deleted file mode 100644 index 4fb4348f..00000000 --- a/docs/v2/models/AddObject.md +++ /dev/null @@ -1,13 +0,0 @@ -# AddObject - -AddObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primary_key** | PropertyValue | Yes | | -**object_type** | ObjectTypeApiName | Yes | | -**type** | Literal["addObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AddObjectDict.md b/docs/v2/models/AddObjectDict.md deleted file mode 100644 index 3059ff56..00000000 --- a/docs/v2/models/AddObjectDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AddObjectDict - -AddObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primaryKey** | PropertyValue | Yes | | -**objectType** | ObjectTypeApiName | Yes | | -**type** | Literal["addObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregateObjectSetRequestV2.md b/docs/v2/models/AggregateObjectSetRequestV2.md deleted file mode 100644 index f60919ef..00000000 --- a/docs/v2/models/AggregateObjectSetRequestV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# AggregateObjectSetRequestV2 - -AggregateObjectSetRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**aggregation** | List[AggregationV2] | Yes | | -**object_set** | ObjectSet | Yes | | -**group_by** | List[AggregationGroupByV2] | Yes | | -**accuracy** | Optional[AggregationAccuracyRequest] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregateObjectSetRequestV2Dict.md b/docs/v2/models/AggregateObjectSetRequestV2Dict.md deleted file mode 100644 index 36badea1..00000000 --- a/docs/v2/models/AggregateObjectSetRequestV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AggregateObjectSetRequestV2Dict - -AggregateObjectSetRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**aggregation** | List[AggregationV2Dict] | Yes | | -**objectSet** | ObjectSetDict | Yes | | -**groupBy** | List[AggregationGroupByV2Dict] | Yes | | -**accuracy** | NotRequired[AggregationAccuracyRequest] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregateObjectsRequest.md b/docs/v2/models/AggregateObjectsRequest.md deleted file mode 100644 index aac0ef14..00000000 --- a/docs/v2/models/AggregateObjectsRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregateObjectsRequest - -AggregateObjectsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**aggregation** | List[Aggregation] | Yes | | -**query** | Optional[SearchJsonQuery] | No | | -**group_by** | List[AggregationGroupBy] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregateObjectsRequestDict.md b/docs/v2/models/AggregateObjectsRequestDict.md deleted file mode 100644 index 9f9b2197..00000000 --- a/docs/v2/models/AggregateObjectsRequestDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregateObjectsRequestDict - -AggregateObjectsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**aggregation** | List[AggregationDict] | Yes | | -**query** | NotRequired[SearchJsonQueryDict] | No | | -**groupBy** | List[AggregationGroupByDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregateObjectsRequestV2.md b/docs/v2/models/AggregateObjectsRequestV2.md deleted file mode 100644 index 04fd68d3..00000000 --- a/docs/v2/models/AggregateObjectsRequestV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# AggregateObjectsRequestV2 - -AggregateObjectsRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**aggregation** | List[AggregationV2] | Yes | | -**where** | Optional[SearchJsonQueryV2] | No | | -**group_by** | List[AggregationGroupByV2] | Yes | | -**accuracy** | Optional[AggregationAccuracyRequest] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregateObjectsRequestV2Dict.md b/docs/v2/models/AggregateObjectsRequestV2Dict.md deleted file mode 100644 index 0bb8e2ee..00000000 --- a/docs/v2/models/AggregateObjectsRequestV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AggregateObjectsRequestV2Dict - -AggregateObjectsRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**aggregation** | List[AggregationV2Dict] | Yes | | -**where** | NotRequired[SearchJsonQueryV2Dict] | No | | -**groupBy** | List[AggregationGroupByV2Dict] | Yes | | -**accuracy** | NotRequired[AggregationAccuracyRequest] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregateObjectsResponse.md b/docs/v2/models/AggregateObjectsResponse.md deleted file mode 100644 index 6616654d..00000000 --- a/docs/v2/models/AggregateObjectsResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregateObjectsResponse - -AggregateObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**excluded_items** | Optional[StrictInt] | No | | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[AggregateObjectsResponseItem] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregateObjectsResponseDict.md b/docs/v2/models/AggregateObjectsResponseDict.md deleted file mode 100644 index a7b373b8..00000000 --- a/docs/v2/models/AggregateObjectsResponseDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregateObjectsResponseDict - -AggregateObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**excludedItems** | NotRequired[StrictInt] | No | | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[AggregateObjectsResponseItemDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregateObjectsResponseItem.md b/docs/v2/models/AggregateObjectsResponseItem.md deleted file mode 100644 index 0c203e53..00000000 --- a/docs/v2/models/AggregateObjectsResponseItem.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregateObjectsResponseItem - -AggregateObjectsResponseItem - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**group** | Dict[AggregationGroupKey, AggregationGroupValue] | Yes | | -**metrics** | List[AggregationMetricResult] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregateObjectsResponseItemDict.md b/docs/v2/models/AggregateObjectsResponseItemDict.md deleted file mode 100644 index cf1f812b..00000000 --- a/docs/v2/models/AggregateObjectsResponseItemDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregateObjectsResponseItemDict - -AggregateObjectsResponseItem - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**group** | Dict[AggregationGroupKey, AggregationGroupValue] | Yes | | -**metrics** | List[AggregationMetricResultDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregateObjectsResponseItemV2.md b/docs/v2/models/AggregateObjectsResponseItemV2.md deleted file mode 100644 index b13db337..00000000 --- a/docs/v2/models/AggregateObjectsResponseItemV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregateObjectsResponseItemV2 - -AggregateObjectsResponseItemV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**group** | Dict[AggregationGroupKeyV2, AggregationGroupValueV2] | Yes | | -**metrics** | List[AggregationMetricResultV2] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregateObjectsResponseItemV2Dict.md b/docs/v2/models/AggregateObjectsResponseItemV2Dict.md deleted file mode 100644 index 356008a8..00000000 --- a/docs/v2/models/AggregateObjectsResponseItemV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregateObjectsResponseItemV2Dict - -AggregateObjectsResponseItemV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**group** | Dict[AggregationGroupKeyV2, AggregationGroupValueV2] | Yes | | -**metrics** | List[AggregationMetricResultV2Dict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregateObjectsResponseV2.md b/docs/v2/models/AggregateObjectsResponseV2.md deleted file mode 100644 index b7cce26c..00000000 --- a/docs/v2/models/AggregateObjectsResponseV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregateObjectsResponseV2 - -AggregateObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**excluded_items** | Optional[StrictInt] | No | | -**accuracy** | AggregationAccuracy | Yes | | -**data** | List[AggregateObjectsResponseItemV2] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregateObjectsResponseV2Dict.md b/docs/v2/models/AggregateObjectsResponseV2Dict.md deleted file mode 100644 index 9e0e52a0..00000000 --- a/docs/v2/models/AggregateObjectsResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregateObjectsResponseV2Dict - -AggregateObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**excludedItems** | NotRequired[StrictInt] | No | | -**accuracy** | AggregationAccuracy | Yes | | -**data** | List[AggregateObjectsResponseItemV2Dict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Aggregation.md b/docs/v2/models/Aggregation.md deleted file mode 100644 index 3f8ee7cb..00000000 --- a/docs/v2/models/Aggregation.md +++ /dev/null @@ -1,20 +0,0 @@ -# Aggregation - -Specifies an aggregation function. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[MaxAggregation](MaxAggregation.md) | max -[MinAggregation](MinAggregation.md) | min -[AvgAggregation](AvgAggregation.md) | avg -[SumAggregation](SumAggregation.md) | sum -[CountAggregation](CountAggregation.md) | count -[ApproximateDistinctAggregation](ApproximateDistinctAggregation.md) | approximateDistinct - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationAccuracy.md b/docs/v2/models/AggregationAccuracy.md deleted file mode 100644 index 70c00e42..00000000 --- a/docs/v2/models/AggregationAccuracy.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationAccuracy - -AggregationAccuracy - -| **Value** | -| --------- | -| `"ACCURATE"` | -| `"APPROXIMATE"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationAccuracyRequest.md b/docs/v2/models/AggregationAccuracyRequest.md deleted file mode 100644 index 5be402e1..00000000 --- a/docs/v2/models/AggregationAccuracyRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationAccuracyRequest - -AggregationAccuracyRequest - -| **Value** | -| --------- | -| `"REQUIRE_ACCURATE"` | -| `"ALLOW_APPROXIMATE"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationDict.md b/docs/v2/models/AggregationDict.md deleted file mode 100644 index 80aa366c..00000000 --- a/docs/v2/models/AggregationDict.md +++ /dev/null @@ -1,20 +0,0 @@ -# AggregationDict - -Specifies an aggregation function. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[MaxAggregationDict](MaxAggregationDict.md) | max -[MinAggregationDict](MinAggregationDict.md) | min -[AvgAggregationDict](AvgAggregationDict.md) | avg -[SumAggregationDict](SumAggregationDict.md) | sum -[CountAggregationDict](CountAggregationDict.md) | count -[ApproximateDistinctAggregationDict](ApproximateDistinctAggregationDict.md) | approximateDistinct - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationDurationGrouping.md b/docs/v2/models/AggregationDurationGrouping.md deleted file mode 100644 index f36567b5..00000000 --- a/docs/v2/models/AggregationDurationGrouping.md +++ /dev/null @@ -1,15 +0,0 @@ -# AggregationDurationGrouping - -Divides objects into groups according to an interval. Note that this grouping applies only on date types. -The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**duration** | Duration | Yes | | -**type** | Literal["duration"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationDurationGroupingDict.md b/docs/v2/models/AggregationDurationGroupingDict.md deleted file mode 100644 index 8f5cc464..00000000 --- a/docs/v2/models/AggregationDurationGroupingDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# AggregationDurationGroupingDict - -Divides objects into groups according to an interval. Note that this grouping applies only on date types. -The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**duration** | DurationDict | Yes | | -**type** | Literal["duration"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationDurationGroupingV2.md b/docs/v2/models/AggregationDurationGroupingV2.md deleted file mode 100644 index ff240e60..00000000 --- a/docs/v2/models/AggregationDurationGroupingV2.md +++ /dev/null @@ -1,16 +0,0 @@ -# AggregationDurationGroupingV2 - -Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. -When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictInt | Yes | | -**unit** | TimeUnit | Yes | | -**type** | Literal["duration"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationDurationGroupingV2Dict.md b/docs/v2/models/AggregationDurationGroupingV2Dict.md deleted file mode 100644 index e327e565..00000000 --- a/docs/v2/models/AggregationDurationGroupingV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# AggregationDurationGroupingV2Dict - -Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. -When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictInt | Yes | | -**unit** | TimeUnit | Yes | | -**type** | Literal["duration"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationExactGrouping.md b/docs/v2/models/AggregationExactGrouping.md deleted file mode 100644 index 1037e903..00000000 --- a/docs/v2/models/AggregationExactGrouping.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationExactGrouping - -Divides objects into groups according to an exact value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**max_group_count** | Optional[StrictInt] | No | | -**type** | Literal["exact"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationExactGroupingDict.md b/docs/v2/models/AggregationExactGroupingDict.md deleted file mode 100644 index 6e05224d..00000000 --- a/docs/v2/models/AggregationExactGroupingDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationExactGroupingDict - -Divides objects into groups according to an exact value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**maxGroupCount** | NotRequired[StrictInt] | No | | -**type** | Literal["exact"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationExactGroupingV2.md b/docs/v2/models/AggregationExactGroupingV2.md deleted file mode 100644 index 150a7f66..00000000 --- a/docs/v2/models/AggregationExactGroupingV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationExactGroupingV2 - -Divides objects into groups according to an exact value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**max_group_count** | Optional[StrictInt] | No | | -**type** | Literal["exact"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationExactGroupingV2Dict.md b/docs/v2/models/AggregationExactGroupingV2Dict.md deleted file mode 100644 index e4baeb25..00000000 --- a/docs/v2/models/AggregationExactGroupingV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationExactGroupingV2Dict - -Divides objects into groups according to an exact value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**maxGroupCount** | NotRequired[StrictInt] | No | | -**type** | Literal["exact"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationFixedWidthGrouping.md b/docs/v2/models/AggregationFixedWidthGrouping.md deleted file mode 100644 index ce4b780e..00000000 --- a/docs/v2/models/AggregationFixedWidthGrouping.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationFixedWidthGrouping - -Divides objects into groups with the specified width. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**fixed_width** | StrictInt | Yes | | -**type** | Literal["fixedWidth"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationFixedWidthGroupingDict.md b/docs/v2/models/AggregationFixedWidthGroupingDict.md deleted file mode 100644 index 4afee6ac..00000000 --- a/docs/v2/models/AggregationFixedWidthGroupingDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationFixedWidthGroupingDict - -Divides objects into groups with the specified width. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**fixedWidth** | StrictInt | Yes | | -**type** | Literal["fixedWidth"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationFixedWidthGroupingV2.md b/docs/v2/models/AggregationFixedWidthGroupingV2.md deleted file mode 100644 index c071ef0a..00000000 --- a/docs/v2/models/AggregationFixedWidthGroupingV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationFixedWidthGroupingV2 - -Divides objects into groups with the specified width. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**fixed_width** | StrictInt | Yes | | -**type** | Literal["fixedWidth"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationFixedWidthGroupingV2Dict.md b/docs/v2/models/AggregationFixedWidthGroupingV2Dict.md deleted file mode 100644 index c3bd4f60..00000000 --- a/docs/v2/models/AggregationFixedWidthGroupingV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationFixedWidthGroupingV2Dict - -Divides objects into groups with the specified width. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**fixedWidth** | StrictInt | Yes | | -**type** | Literal["fixedWidth"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationGroupBy.md b/docs/v2/models/AggregationGroupBy.md deleted file mode 100644 index 4648b0a9..00000000 --- a/docs/v2/models/AggregationGroupBy.md +++ /dev/null @@ -1,18 +0,0 @@ -# AggregationGroupBy - -Specifies a grouping for aggregation results. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AggregationFixedWidthGrouping](AggregationFixedWidthGrouping.md) | fixedWidth -[AggregationRangesGrouping](AggregationRangesGrouping.md) | ranges -[AggregationExactGrouping](AggregationExactGrouping.md) | exact -[AggregationDurationGrouping](AggregationDurationGrouping.md) | duration - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationGroupByDict.md b/docs/v2/models/AggregationGroupByDict.md deleted file mode 100644 index 7492be91..00000000 --- a/docs/v2/models/AggregationGroupByDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# AggregationGroupByDict - -Specifies a grouping for aggregation results. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AggregationFixedWidthGroupingDict](AggregationFixedWidthGroupingDict.md) | fixedWidth -[AggregationRangesGroupingDict](AggregationRangesGroupingDict.md) | ranges -[AggregationExactGroupingDict](AggregationExactGroupingDict.md) | exact -[AggregationDurationGroupingDict](AggregationDurationGroupingDict.md) | duration - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationGroupByV2.md b/docs/v2/models/AggregationGroupByV2.md deleted file mode 100644 index 5c5b6393..00000000 --- a/docs/v2/models/AggregationGroupByV2.md +++ /dev/null @@ -1,18 +0,0 @@ -# AggregationGroupByV2 - -Specifies a grouping for aggregation results. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AggregationFixedWidthGroupingV2](AggregationFixedWidthGroupingV2.md) | fixedWidth -[AggregationRangesGroupingV2](AggregationRangesGroupingV2.md) | ranges -[AggregationExactGroupingV2](AggregationExactGroupingV2.md) | exact -[AggregationDurationGroupingV2](AggregationDurationGroupingV2.md) | duration - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationGroupByV2Dict.md b/docs/v2/models/AggregationGroupByV2Dict.md deleted file mode 100644 index de5e514f..00000000 --- a/docs/v2/models/AggregationGroupByV2Dict.md +++ /dev/null @@ -1,18 +0,0 @@ -# AggregationGroupByV2Dict - -Specifies a grouping for aggregation results. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AggregationFixedWidthGroupingV2Dict](AggregationFixedWidthGroupingV2Dict.md) | fixedWidth -[AggregationRangesGroupingV2Dict](AggregationRangesGroupingV2Dict.md) | ranges -[AggregationExactGroupingV2Dict](AggregationExactGroupingV2Dict.md) | exact -[AggregationDurationGroupingV2Dict](AggregationDurationGroupingV2Dict.md) | duration - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationGroupKey.md b/docs/v2/models/AggregationGroupKey.md deleted file mode 100644 index 3c91b354..00000000 --- a/docs/v2/models/AggregationGroupKey.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationGroupKey - -AggregationGroupKey - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationGroupKeyV2.md b/docs/v2/models/AggregationGroupKeyV2.md deleted file mode 100644 index a299ab2a..00000000 --- a/docs/v2/models/AggregationGroupKeyV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationGroupKeyV2 - -AggregationGroupKeyV2 - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationGroupValue.md b/docs/v2/models/AggregationGroupValue.md deleted file mode 100644 index 214d8483..00000000 --- a/docs/v2/models/AggregationGroupValue.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationGroupValue - -AggregationGroupValue - -## Type -```python -Any -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationGroupValueV2.md b/docs/v2/models/AggregationGroupValueV2.md deleted file mode 100644 index 976cd7dd..00000000 --- a/docs/v2/models/AggregationGroupValueV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationGroupValueV2 - -AggregationGroupValueV2 - -## Type -```python -Any -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationMetricName.md b/docs/v2/models/AggregationMetricName.md deleted file mode 100644 index e537e6b9..00000000 --- a/docs/v2/models/AggregationMetricName.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationMetricName - -A user-specified alias for an aggregation metric name. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationMetricResult.md b/docs/v2/models/AggregationMetricResult.md deleted file mode 100644 index c9cabe98..00000000 --- a/docs/v2/models/AggregationMetricResult.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationMetricResult - -AggregationMetricResult - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StrictStr | Yes | | -**value** | Optional[StrictFloat] | No | TBD | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationMetricResultDict.md b/docs/v2/models/AggregationMetricResultDict.md deleted file mode 100644 index ce43ab80..00000000 --- a/docs/v2/models/AggregationMetricResultDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationMetricResultDict - -AggregationMetricResult - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StrictStr | Yes | | -**value** | NotRequired[StrictFloat] | No | TBD | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationMetricResultV2.md b/docs/v2/models/AggregationMetricResultV2.md deleted file mode 100644 index 3cf37b3a..00000000 --- a/docs/v2/models/AggregationMetricResultV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationMetricResultV2 - -AggregationMetricResultV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StrictStr | Yes | | -**value** | Optional[Any] | No | The value of the metric. This will be a double in the case of a numeric metric, or a date string in the case of a date metric. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationMetricResultV2Dict.md b/docs/v2/models/AggregationMetricResultV2Dict.md deleted file mode 100644 index 0ef80453..00000000 --- a/docs/v2/models/AggregationMetricResultV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationMetricResultV2Dict - -AggregationMetricResultV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StrictStr | Yes | | -**value** | NotRequired[Any] | No | The value of the metric. This will be a double in the case of a numeric metric, or a date string in the case of a date metric. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationObjectTypeGrouping.md b/docs/v2/models/AggregationObjectTypeGrouping.md deleted file mode 100644 index 8072b80d..00000000 --- a/docs/v2/models/AggregationObjectTypeGrouping.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationObjectTypeGrouping - -Divides objects into groups based on their object type. This grouping is only useful when aggregating across -multiple object types, such as when aggregating over an interface type. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationObjectTypeGroupingDict.md b/docs/v2/models/AggregationObjectTypeGroupingDict.md deleted file mode 100644 index cc37ad6e..00000000 --- a/docs/v2/models/AggregationObjectTypeGroupingDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationObjectTypeGroupingDict - -Divides objects into groups based on their object type. This grouping is only useful when aggregating across -multiple object types, such as when aggregating over an interface type. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationOrderBy.md b/docs/v2/models/AggregationOrderBy.md deleted file mode 100644 index d8e4943d..00000000 --- a/docs/v2/models/AggregationOrderBy.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationOrderBy - -AggregationOrderBy - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**metric_name** | StrictStr | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationOrderByDict.md b/docs/v2/models/AggregationOrderByDict.md deleted file mode 100644 index 24815f16..00000000 --- a/docs/v2/models/AggregationOrderByDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AggregationOrderByDict - -AggregationOrderBy - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**metricName** | StrictStr | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationRange.md b/docs/v2/models/AggregationRange.md deleted file mode 100644 index aa581385..00000000 --- a/docs/v2/models/AggregationRange.md +++ /dev/null @@ -1,14 +0,0 @@ -# AggregationRange - -Specifies a date range from an inclusive start date to an exclusive end date. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | Optional[Any] | No | Exclusive end date. | -**lte** | Optional[Any] | No | Inclusive end date. | -**gt** | Optional[Any] | No | Exclusive start date. | -**gte** | Optional[Any] | No | Inclusive start date. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationRangeDict.md b/docs/v2/models/AggregationRangeDict.md deleted file mode 100644 index 6c40bd85..00000000 --- a/docs/v2/models/AggregationRangeDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AggregationRangeDict - -Specifies a date range from an inclusive start date to an exclusive end date. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Exclusive end date. | -**lte** | NotRequired[Any] | No | Inclusive end date. | -**gt** | NotRequired[Any] | No | Exclusive start date. | -**gte** | NotRequired[Any] | No | Inclusive start date. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationRangeV2.md b/docs/v2/models/AggregationRangeV2.md deleted file mode 100644 index 3f9e4622..00000000 --- a/docs/v2/models/AggregationRangeV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationRangeV2 - -Specifies a range from an inclusive start value to an exclusive end value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**start_value** | Any | Yes | Inclusive start. | -**end_value** | Any | Yes | Exclusive end. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationRangeV2Dict.md b/docs/v2/models/AggregationRangeV2Dict.md deleted file mode 100644 index 76b77977..00000000 --- a/docs/v2/models/AggregationRangeV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AggregationRangeV2Dict - -Specifies a range from an inclusive start value to an exclusive end value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**startValue** | Any | Yes | Inclusive start. | -**endValue** | Any | Yes | Exclusive end. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationRangesGrouping.md b/docs/v2/models/AggregationRangesGrouping.md deleted file mode 100644 index 0aef7f6e..00000000 --- a/docs/v2/models/AggregationRangesGrouping.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationRangesGrouping - -Divides objects into groups according to specified ranges. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**ranges** | List[AggregationRange] | Yes | | -**type** | Literal["ranges"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationRangesGroupingDict.md b/docs/v2/models/AggregationRangesGroupingDict.md deleted file mode 100644 index 4a7678b3..00000000 --- a/docs/v2/models/AggregationRangesGroupingDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationRangesGroupingDict - -Divides objects into groups according to specified ranges. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**ranges** | List[AggregationRangeDict] | Yes | | -**type** | Literal["ranges"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationRangesGroupingV2.md b/docs/v2/models/AggregationRangesGroupingV2.md deleted file mode 100644 index 4773c4d9..00000000 --- a/docs/v2/models/AggregationRangesGroupingV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationRangesGroupingV2 - -Divides objects into groups according to specified ranges. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**ranges** | List[AggregationRangeV2] | Yes | | -**type** | Literal["ranges"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationRangesGroupingV2Dict.md b/docs/v2/models/AggregationRangesGroupingV2Dict.md deleted file mode 100644 index b4dc4ba9..00000000 --- a/docs/v2/models/AggregationRangesGroupingV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AggregationRangesGroupingV2Dict - -Divides objects into groups according to specified ranges. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**ranges** | List[AggregationRangeV2Dict] | Yes | | -**type** | Literal["ranges"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationV2.md b/docs/v2/models/AggregationV2.md deleted file mode 100644 index 0d8194c6..00000000 --- a/docs/v2/models/AggregationV2.md +++ /dev/null @@ -1,22 +0,0 @@ -# AggregationV2 - -Specifies an aggregation function. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[MaxAggregationV2](MaxAggregationV2.md) | max -[MinAggregationV2](MinAggregationV2.md) | min -[AvgAggregationV2](AvgAggregationV2.md) | avg -[SumAggregationV2](SumAggregationV2.md) | sum -[CountAggregationV2](CountAggregationV2.md) | count -[ApproximateDistinctAggregationV2](ApproximateDistinctAggregationV2.md) | approximateDistinct -[ApproximatePercentileAggregationV2](ApproximatePercentileAggregationV2.md) | approximatePercentile -[ExactDistinctAggregationV2](ExactDistinctAggregationV2.md) | exactDistinct - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AggregationV2Dict.md b/docs/v2/models/AggregationV2Dict.md deleted file mode 100644 index 795a6c72..00000000 --- a/docs/v2/models/AggregationV2Dict.md +++ /dev/null @@ -1,22 +0,0 @@ -# AggregationV2Dict - -Specifies an aggregation function. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[MaxAggregationV2Dict](MaxAggregationV2Dict.md) | max -[MinAggregationV2Dict](MinAggregationV2Dict.md) | min -[AvgAggregationV2Dict](AvgAggregationV2Dict.md) | avg -[SumAggregationV2Dict](SumAggregationV2Dict.md) | sum -[CountAggregationV2Dict](CountAggregationV2Dict.md) | count -[ApproximateDistinctAggregationV2Dict](ApproximateDistinctAggregationV2Dict.md) | approximateDistinct -[ApproximatePercentileAggregationV2Dict](ApproximatePercentileAggregationV2Dict.md) | approximatePercentile -[ExactDistinctAggregationV2Dict](ExactDistinctAggregationV2Dict.md) | exactDistinct - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AllTermsQuery.md b/docs/v2/models/AllTermsQuery.md deleted file mode 100644 index 8a92456e..00000000 --- a/docs/v2/models/AllTermsQuery.md +++ /dev/null @@ -1,16 +0,0 @@ -# AllTermsQuery - -Returns objects where the specified field contains all of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | Optional[Fuzzy] | No | | -**type** | Literal["allTerms"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AllTermsQueryDict.md b/docs/v2/models/AllTermsQueryDict.md deleted file mode 100644 index 8c1e0214..00000000 --- a/docs/v2/models/AllTermsQueryDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# AllTermsQueryDict - -Returns objects where the specified field contains all of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | NotRequired[Fuzzy] | No | | -**type** | Literal["allTerms"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AndQuery.md b/docs/v2/models/AndQuery.md deleted file mode 100644 index afa06823..00000000 --- a/docs/v2/models/AndQuery.md +++ /dev/null @@ -1,12 +0,0 @@ -# AndQuery - -Returns objects where every query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQuery] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AndQueryDict.md b/docs/v2/models/AndQueryDict.md deleted file mode 100644 index b0fc7a6e..00000000 --- a/docs/v2/models/AndQueryDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AndQueryDict - -Returns objects where every query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryDict] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AndQueryV2.md b/docs/v2/models/AndQueryV2.md deleted file mode 100644 index 3226428b..00000000 --- a/docs/v2/models/AndQueryV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# AndQueryV2 - -Returns objects where every query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryV2] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AndQueryV2Dict.md b/docs/v2/models/AndQueryV2Dict.md deleted file mode 100644 index e2f7b802..00000000 --- a/docs/v2/models/AndQueryV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AndQueryV2Dict - -Returns objects where every query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryV2Dict] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AndTrigger.md b/docs/v2/models/AndTrigger.md deleted file mode 100644 index 5fb6c378..00000000 --- a/docs/v2/models/AndTrigger.md +++ /dev/null @@ -1,12 +0,0 @@ -# AndTrigger - -Trigger after all of the given triggers emit an event. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**triggers** | List[Trigger] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AndTriggerDict.md b/docs/v2/models/AndTriggerDict.md deleted file mode 100644 index 882a3cc4..00000000 --- a/docs/v2/models/AndTriggerDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# AndTriggerDict - -Trigger after all of the given triggers emit an event. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**triggers** | List[TriggerDict] | Yes | | -**type** | Literal["and"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AnyTermQuery.md b/docs/v2/models/AnyTermQuery.md deleted file mode 100644 index 7d863f26..00000000 --- a/docs/v2/models/AnyTermQuery.md +++ /dev/null @@ -1,16 +0,0 @@ -# AnyTermQuery - -Returns objects where the specified field contains any of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | Optional[Fuzzy] | No | | -**type** | Literal["anyTerm"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AnyTermQueryDict.md b/docs/v2/models/AnyTermQueryDict.md deleted file mode 100644 index 9884c3d3..00000000 --- a/docs/v2/models/AnyTermQueryDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# AnyTermQueryDict - -Returns objects where the specified field contains any of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | NotRequired[Fuzzy] | No | | -**type** | Literal["anyTerm"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AnyType.md b/docs/v2/models/AnyType.md deleted file mode 100644 index 256363fd..00000000 --- a/docs/v2/models/AnyType.md +++ /dev/null @@ -1,11 +0,0 @@ -# AnyType - -AnyType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["any"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AnyTypeDict.md b/docs/v2/models/AnyTypeDict.md deleted file mode 100644 index 95327ea7..00000000 --- a/docs/v2/models/AnyTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AnyTypeDict - -AnyType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["any"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApiDefinition.md b/docs/v2/models/ApiDefinition.md deleted file mode 100644 index 6c3d7c0c..00000000 --- a/docs/v2/models/ApiDefinition.md +++ /dev/null @@ -1,15 +0,0 @@ -# ApiDefinition - -ApiDefinition - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**version** | IrVersion | Yes | | -**rid** | ApiDefinitionRid | Yes | | -**name** | ApiDefinitionName | Yes | | -**deprecated** | ApiDefinitionDeprecated | Yes | | -**ir** | List[Any] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApiDefinitionDeprecated.md b/docs/v2/models/ApiDefinitionDeprecated.md deleted file mode 100644 index 8a27fd30..00000000 --- a/docs/v2/models/ApiDefinitionDeprecated.md +++ /dev/null @@ -1,11 +0,0 @@ -# ApiDefinitionDeprecated - -ApiDefinitionDeprecated - -## Type -```python -StrictBool -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApiDefinitionDict.md b/docs/v2/models/ApiDefinitionDict.md deleted file mode 100644 index 454e296e..00000000 --- a/docs/v2/models/ApiDefinitionDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# ApiDefinitionDict - -ApiDefinition - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**version** | IrVersion | Yes | | -**rid** | ApiDefinitionRid | Yes | | -**name** | ApiDefinitionName | Yes | | -**deprecated** | ApiDefinitionDeprecated | Yes | | -**ir** | List[Any] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApiDefinitionName.md b/docs/v2/models/ApiDefinitionName.md deleted file mode 100644 index 542dded0..00000000 --- a/docs/v2/models/ApiDefinitionName.md +++ /dev/null @@ -1,11 +0,0 @@ -# ApiDefinitionName - -ApiDefinitionName - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApiDefinitionRid.md b/docs/v2/models/ApiDefinitionRid.md deleted file mode 100644 index 9c2b98d9..00000000 --- a/docs/v2/models/ApiDefinitionRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ApiDefinitionRid - -ApiDefinitionRid - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApplyActionMode.md b/docs/v2/models/ApplyActionMode.md deleted file mode 100644 index aeb8259a..00000000 --- a/docs/v2/models/ApplyActionMode.md +++ /dev/null @@ -1,11 +0,0 @@ -# ApplyActionMode - -ApplyActionMode - -| **Value** | -| --------- | -| `"VALIDATE_ONLY"` | -| `"VALIDATE_AND_EXECUTE"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApplyActionRequest.md b/docs/v2/models/ApplyActionRequest.md deleted file mode 100644 index 9631634a..00000000 --- a/docs/v2/models/ApplyActionRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# ApplyActionRequest - -ApplyActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApplyActionRequestDict.md b/docs/v2/models/ApplyActionRequestDict.md deleted file mode 100644 index 11884c41..00000000 --- a/docs/v2/models/ApplyActionRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ApplyActionRequestDict - -ApplyActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApplyActionRequestOptions.md b/docs/v2/models/ApplyActionRequestOptions.md deleted file mode 100644 index 28c5ef2e..00000000 --- a/docs/v2/models/ApplyActionRequestOptions.md +++ /dev/null @@ -1,12 +0,0 @@ -# ApplyActionRequestOptions - -ApplyActionRequestOptions - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**mode** | Optional[ApplyActionMode] | No | | -**return_edits** | Optional[ReturnEditsMode] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApplyActionRequestOptionsDict.md b/docs/v2/models/ApplyActionRequestOptionsDict.md deleted file mode 100644 index 07b5bcf8..00000000 --- a/docs/v2/models/ApplyActionRequestOptionsDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ApplyActionRequestOptionsDict - -ApplyActionRequestOptions - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**mode** | NotRequired[ApplyActionMode] | No | | -**returnEdits** | NotRequired[ReturnEditsMode] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApplyActionRequestV2.md b/docs/v2/models/ApplyActionRequestV2.md deleted file mode 100644 index 1c1f4a05..00000000 --- a/docs/v2/models/ApplyActionRequestV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# ApplyActionRequestV2 - -ApplyActionRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**options** | Optional[ApplyActionRequestOptions] | No | | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApplyActionRequestV2Dict.md b/docs/v2/models/ApplyActionRequestV2Dict.md deleted file mode 100644 index 61acb602..00000000 --- a/docs/v2/models/ApplyActionRequestV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ApplyActionRequestV2Dict - -ApplyActionRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**options** | NotRequired[ApplyActionRequestOptionsDict] | No | | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApplyActionResponse.md b/docs/v2/models/ApplyActionResponse.md deleted file mode 100644 index 7a9ad20a..00000000 --- a/docs/v2/models/ApplyActionResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# ApplyActionResponse - -ApplyActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApplyActionResponseDict.md b/docs/v2/models/ApplyActionResponseDict.md deleted file mode 100644 index 4bc52f49..00000000 --- a/docs/v2/models/ApplyActionResponseDict.md +++ /dev/null @@ -1,10 +0,0 @@ -# ApplyActionResponseDict - -ApplyActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApproximateDistinctAggregation.md b/docs/v2/models/ApproximateDistinctAggregation.md deleted file mode 100644 index 33a91576..00000000 --- a/docs/v2/models/ApproximateDistinctAggregation.md +++ /dev/null @@ -1,13 +0,0 @@ -# ApproximateDistinctAggregation - -Computes an approximate number of distinct values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**type** | Literal["approximateDistinct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApproximateDistinctAggregationDict.md b/docs/v2/models/ApproximateDistinctAggregationDict.md deleted file mode 100644 index cf909e28..00000000 --- a/docs/v2/models/ApproximateDistinctAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ApproximateDistinctAggregationDict - -Computes an approximate number of distinct values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["approximateDistinct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApproximateDistinctAggregationV2.md b/docs/v2/models/ApproximateDistinctAggregationV2.md deleted file mode 100644 index 8fb7d8f1..00000000 --- a/docs/v2/models/ApproximateDistinctAggregationV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# ApproximateDistinctAggregationV2 - -Computes an approximate number of distinct values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["approximateDistinct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApproximateDistinctAggregationV2Dict.md b/docs/v2/models/ApproximateDistinctAggregationV2Dict.md deleted file mode 100644 index ca326651..00000000 --- a/docs/v2/models/ApproximateDistinctAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ApproximateDistinctAggregationV2Dict - -Computes an approximate number of distinct values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["approximateDistinct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApproximatePercentileAggregationV2.md b/docs/v2/models/ApproximatePercentileAggregationV2.md deleted file mode 100644 index 95febd54..00000000 --- a/docs/v2/models/ApproximatePercentileAggregationV2.md +++ /dev/null @@ -1,15 +0,0 @@ -# ApproximatePercentileAggregationV2 - -Computes the approximate percentile value for the provided field. Requires Object Storage V2. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**approximate_percentile** | StrictFloat | Yes | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["approximatePercentile"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ApproximatePercentileAggregationV2Dict.md b/docs/v2/models/ApproximatePercentileAggregationV2Dict.md deleted file mode 100644 index f8d2a8c1..00000000 --- a/docs/v2/models/ApproximatePercentileAggregationV2Dict.md +++ /dev/null @@ -1,15 +0,0 @@ -# ApproximatePercentileAggregationV2Dict - -Computes the approximate percentile value for the provided field. Requires Object Storage V2. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**approximatePercentile** | StrictFloat | Yes | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["approximatePercentile"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ArchiveFileFormat.md b/docs/v2/models/ArchiveFileFormat.md deleted file mode 100644 index c6d9af08..00000000 --- a/docs/v2/models/ArchiveFileFormat.md +++ /dev/null @@ -1,11 +0,0 @@ -# ArchiveFileFormat - -The format of an archive file. - - -| **Value** | -| --------- | -| `"ZIP"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Arg.md b/docs/v2/models/Arg.md deleted file mode 100644 index 281fd943..00000000 --- a/docs/v2/models/Arg.md +++ /dev/null @@ -1,12 +0,0 @@ -# Arg - -Arg - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StrictStr | Yes | | -**value** | StrictStr | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ArgDict.md b/docs/v2/models/ArgDict.md deleted file mode 100644 index fa3e11e3..00000000 --- a/docs/v2/models/ArgDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ArgDict - -Arg - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StrictStr | Yes | | -**value** | StrictStr | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ArraySizeConstraint.md b/docs/v2/models/ArraySizeConstraint.md deleted file mode 100644 index 996b894a..00000000 --- a/docs/v2/models/ArraySizeConstraint.md +++ /dev/null @@ -1,16 +0,0 @@ -# ArraySizeConstraint - -The parameter expects an array of values and the size of the array must fall within the defined range. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | Optional[Any] | No | Less than | -**lte** | Optional[Any] | No | Less than or equal | -**gt** | Optional[Any] | No | Greater than | -**gte** | Optional[Any] | No | Greater than or equal | -**type** | Literal["arraySize"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ArraySizeConstraintDict.md b/docs/v2/models/ArraySizeConstraintDict.md deleted file mode 100644 index 31efc1c6..00000000 --- a/docs/v2/models/ArraySizeConstraintDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ArraySizeConstraintDict - -The parameter expects an array of values and the size of the array must fall within the defined range. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Less than | -**lte** | NotRequired[Any] | No | Less than or equal | -**gt** | NotRequired[Any] | No | Greater than | -**gte** | NotRequired[Any] | No | Greater than or equal | -**type** | Literal["arraySize"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ArtifactRepositoryRid.md b/docs/v2/models/ArtifactRepositoryRid.md deleted file mode 100644 index c9e4f35b..00000000 --- a/docs/v2/models/ArtifactRepositoryRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ArtifactRepositoryRid - -ArtifactRepositoryRid - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AsyncActionStatus.md b/docs/v2/models/AsyncActionStatus.md deleted file mode 100644 index 2904ec8b..00000000 --- a/docs/v2/models/AsyncActionStatus.md +++ /dev/null @@ -1,16 +0,0 @@ -# AsyncActionStatus - -AsyncActionStatus - -| **Value** | -| --------- | -| `"RUNNING_SUBMISSION_CHECKS"` | -| `"EXECUTING_WRITE_BACK_WEBHOOK"` | -| `"COMPUTING_ONTOLOGY_EDITS"` | -| `"COMPUTING_FUNCTION"` | -| `"WRITING_ONTOLOGY_EDITS"` | -| `"EXECUTING_SIDE_EFFECT_WEBHOOK"` | -| `"SENDING_NOTIFICATIONS"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AsyncApplyActionOperationResponseV2.md b/docs/v2/models/AsyncApplyActionOperationResponseV2.md deleted file mode 100644 index 3174f0b1..00000000 --- a/docs/v2/models/AsyncApplyActionOperationResponseV2.md +++ /dev/null @@ -1,10 +0,0 @@ -# AsyncApplyActionOperationResponseV2 - -AsyncApplyActionOperationResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AsyncApplyActionOperationResponseV2Dict.md b/docs/v2/models/AsyncApplyActionOperationResponseV2Dict.md deleted file mode 100644 index 6f4dbc22..00000000 --- a/docs/v2/models/AsyncApplyActionOperationResponseV2Dict.md +++ /dev/null @@ -1,10 +0,0 @@ -# AsyncApplyActionOperationResponseV2Dict - -AsyncApplyActionOperationResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AsyncApplyActionRequest.md b/docs/v2/models/AsyncApplyActionRequest.md deleted file mode 100644 index 974bf675..00000000 --- a/docs/v2/models/AsyncApplyActionRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# AsyncApplyActionRequest - -AsyncApplyActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AsyncApplyActionRequestDict.md b/docs/v2/models/AsyncApplyActionRequestDict.md deleted file mode 100644 index af4c4e14..00000000 --- a/docs/v2/models/AsyncApplyActionRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AsyncApplyActionRequestDict - -AsyncApplyActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AsyncApplyActionRequestV2.md b/docs/v2/models/AsyncApplyActionRequestV2.md deleted file mode 100644 index 596ac4ac..00000000 --- a/docs/v2/models/AsyncApplyActionRequestV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# AsyncApplyActionRequestV2 - -AsyncApplyActionRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AsyncApplyActionRequestV2Dict.md b/docs/v2/models/AsyncApplyActionRequestV2Dict.md deleted file mode 100644 index ad380702..00000000 --- a/docs/v2/models/AsyncApplyActionRequestV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AsyncApplyActionRequestV2Dict - -AsyncApplyActionRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AsyncApplyActionResponse.md b/docs/v2/models/AsyncApplyActionResponse.md deleted file mode 100644 index 10955605..00000000 --- a/docs/v2/models/AsyncApplyActionResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# AsyncApplyActionResponse - -AsyncApplyActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AsyncApplyActionResponseDict.md b/docs/v2/models/AsyncApplyActionResponseDict.md deleted file mode 100644 index 92cb5600..00000000 --- a/docs/v2/models/AsyncApplyActionResponseDict.md +++ /dev/null @@ -1,10 +0,0 @@ -# AsyncApplyActionResponseDict - -AsyncApplyActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AsyncApplyActionResponseV2.md b/docs/v2/models/AsyncApplyActionResponseV2.md deleted file mode 100644 index 5799fca7..00000000 --- a/docs/v2/models/AsyncApplyActionResponseV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# AsyncApplyActionResponseV2 - -AsyncApplyActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**operation_id** | RID | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AsyncApplyActionResponseV2Dict.md b/docs/v2/models/AsyncApplyActionResponseV2Dict.md deleted file mode 100644 index 47b81b22..00000000 --- a/docs/v2/models/AsyncApplyActionResponseV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AsyncApplyActionResponseV2Dict - -AsyncApplyActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**operationId** | RID | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Attachment.md b/docs/v2/models/Attachment.md deleted file mode 100644 index 66439ba0..00000000 --- a/docs/v2/models/Attachment.md +++ /dev/null @@ -1,14 +0,0 @@ -# Attachment - -The representation of an attachment. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AttachmentRid | Yes | | -**filename** | Filename | Yes | | -**size_bytes** | SizeBytes | Yes | | -**media_type** | MediaType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AttachmentDict.md b/docs/v2/models/AttachmentDict.md deleted file mode 100644 index 748fef45..00000000 --- a/docs/v2/models/AttachmentDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AttachmentDict - -The representation of an attachment. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AttachmentRid | Yes | | -**filename** | Filename | Yes | | -**sizeBytes** | SizeBytes | Yes | | -**mediaType** | MediaType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AttachmentMetadataResponse.md b/docs/v2/models/AttachmentMetadataResponse.md deleted file mode 100644 index a2b0e735..00000000 --- a/docs/v2/models/AttachmentMetadataResponse.md +++ /dev/null @@ -1,16 +0,0 @@ -# AttachmentMetadataResponse - -The attachment metadata response - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AttachmentV2](AttachmentV2.md) | single -[ListAttachmentsResponseV2](ListAttachmentsResponseV2.md) | multiple - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AttachmentMetadataResponseDict.md b/docs/v2/models/AttachmentMetadataResponseDict.md deleted file mode 100644 index 0fc25841..00000000 --- a/docs/v2/models/AttachmentMetadataResponseDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# AttachmentMetadataResponseDict - -The attachment metadata response - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AttachmentV2Dict](AttachmentV2Dict.md) | single -[ListAttachmentsResponseV2Dict](ListAttachmentsResponseV2Dict.md) | multiple - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AttachmentProperty.md b/docs/v2/models/AttachmentProperty.md deleted file mode 100644 index c3fc6ce3..00000000 --- a/docs/v2/models/AttachmentProperty.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttachmentProperty - -The representation of an attachment as a data type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AttachmentRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AttachmentPropertyDict.md b/docs/v2/models/AttachmentPropertyDict.md deleted file mode 100644 index 5f6243dd..00000000 --- a/docs/v2/models/AttachmentPropertyDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttachmentPropertyDict - -The representation of an attachment as a data type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AttachmentRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AttachmentRid.md b/docs/v2/models/AttachmentRid.md deleted file mode 100644 index 24937342..00000000 --- a/docs/v2/models/AttachmentRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttachmentRid - -The unique resource identifier of an attachment. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AttachmentType.md b/docs/v2/models/AttachmentType.md deleted file mode 100644 index 8cec11f6..00000000 --- a/docs/v2/models/AttachmentType.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttachmentType - -AttachmentType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["attachment"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AttachmentTypeDict.md b/docs/v2/models/AttachmentTypeDict.md deleted file mode 100644 index d916f6c4..00000000 --- a/docs/v2/models/AttachmentTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttachmentTypeDict - -AttachmentType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["attachment"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AttachmentV2.md b/docs/v2/models/AttachmentV2.md deleted file mode 100644 index d7069d72..00000000 --- a/docs/v2/models/AttachmentV2.md +++ /dev/null @@ -1,15 +0,0 @@ -# AttachmentV2 - -The representation of an attachment. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AttachmentRid | Yes | | -**filename** | Filename | Yes | | -**size_bytes** | SizeBytes | Yes | | -**media_type** | MediaType | Yes | | -**type** | Literal["single"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AttachmentV2Dict.md b/docs/v2/models/AttachmentV2Dict.md deleted file mode 100644 index 6d4c9e02..00000000 --- a/docs/v2/models/AttachmentV2Dict.md +++ /dev/null @@ -1,15 +0,0 @@ -# AttachmentV2Dict - -The representation of an attachment. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | AttachmentRid | Yes | | -**filename** | Filename | Yes | | -**sizeBytes** | SizeBytes | Yes | | -**mediaType** | MediaType | Yes | | -**type** | Literal["single"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AttributeName.md b/docs/v2/models/AttributeName.md deleted file mode 100644 index b7d3e598..00000000 --- a/docs/v2/models/AttributeName.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttributeName - -AttributeName - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AttributeValue.md b/docs/v2/models/AttributeValue.md deleted file mode 100644 index f49a0a2d..00000000 --- a/docs/v2/models/AttributeValue.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttributeValue - -AttributeValue - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AttributeValues.md b/docs/v2/models/AttributeValues.md deleted file mode 100644 index a85cdf71..00000000 --- a/docs/v2/models/AttributeValues.md +++ /dev/null @@ -1,11 +0,0 @@ -# AttributeValues - -AttributeValues - -## Type -```python -List[AttributeValue] -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AvgAggregation.md b/docs/v2/models/AvgAggregation.md deleted file mode 100644 index a5cdfc53..00000000 --- a/docs/v2/models/AvgAggregation.md +++ /dev/null @@ -1,13 +0,0 @@ -# AvgAggregation - -Computes the average value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**type** | Literal["avg"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AvgAggregationDict.md b/docs/v2/models/AvgAggregationDict.md deleted file mode 100644 index 8a96e447..00000000 --- a/docs/v2/models/AvgAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# AvgAggregationDict - -Computes the average value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["avg"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AvgAggregationV2.md b/docs/v2/models/AvgAggregationV2.md deleted file mode 100644 index 6c0c8a64..00000000 --- a/docs/v2/models/AvgAggregationV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# AvgAggregationV2 - -Computes the average value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["avg"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/AvgAggregationV2Dict.md b/docs/v2/models/AvgAggregationV2Dict.md deleted file mode 100644 index f3e0ea69..00000000 --- a/docs/v2/models/AvgAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# AvgAggregationV2Dict - -Computes the average value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["avg"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BBox.md b/docs/v2/models/BBox.md deleted file mode 100644 index 392b6752..00000000 --- a/docs/v2/models/BBox.md +++ /dev/null @@ -1,18 +0,0 @@ -# BBox - -A GeoJSON object MAY have a member named "bbox" to include -information on the coordinate range for its Geometries, Features, or -FeatureCollections. The value of the bbox member MUST be an array of -length 2*n where n is the number of dimensions represented in the -contained geometries, with all axes of the most southwesterly point -followed by all axes of the more northeasterly point. The axes order -of a bbox follows the axes order of geometries. - - -## Type -```python -List[Coordinate] -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BatchApplyActionRequest.md b/docs/v2/models/BatchApplyActionRequest.md deleted file mode 100644 index 145272c7..00000000 --- a/docs/v2/models/BatchApplyActionRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionRequest - -BatchApplyActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**requests** | List[ApplyActionRequest] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BatchApplyActionRequestDict.md b/docs/v2/models/BatchApplyActionRequestDict.md deleted file mode 100644 index 70f00c58..00000000 --- a/docs/v2/models/BatchApplyActionRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionRequestDict - -BatchApplyActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**requests** | List[ApplyActionRequestDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BatchApplyActionRequestItem.md b/docs/v2/models/BatchApplyActionRequestItem.md deleted file mode 100644 index 9c13aaf0..00000000 --- a/docs/v2/models/BatchApplyActionRequestItem.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionRequestItem - -BatchApplyActionRequestItem - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BatchApplyActionRequestItemDict.md b/docs/v2/models/BatchApplyActionRequestItemDict.md deleted file mode 100644 index 083f7319..00000000 --- a/docs/v2/models/BatchApplyActionRequestItemDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionRequestItemDict - -BatchApplyActionRequestItem - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BatchApplyActionRequestOptions.md b/docs/v2/models/BatchApplyActionRequestOptions.md deleted file mode 100644 index b6b8a214..00000000 --- a/docs/v2/models/BatchApplyActionRequestOptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionRequestOptions - -BatchApplyActionRequestOptions - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**return_edits** | Optional[ReturnEditsMode] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BatchApplyActionRequestOptionsDict.md b/docs/v2/models/BatchApplyActionRequestOptionsDict.md deleted file mode 100644 index ad5ecac8..00000000 --- a/docs/v2/models/BatchApplyActionRequestOptionsDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionRequestOptionsDict - -BatchApplyActionRequestOptions - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**returnEdits** | NotRequired[ReturnEditsMode] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BatchApplyActionRequestV2.md b/docs/v2/models/BatchApplyActionRequestV2.md deleted file mode 100644 index 76ec5a59..00000000 --- a/docs/v2/models/BatchApplyActionRequestV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# BatchApplyActionRequestV2 - -BatchApplyActionRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**options** | Optional[BatchApplyActionRequestOptions] | No | | -**requests** | List[BatchApplyActionRequestItem] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BatchApplyActionRequestV2Dict.md b/docs/v2/models/BatchApplyActionRequestV2Dict.md deleted file mode 100644 index feaed49b..00000000 --- a/docs/v2/models/BatchApplyActionRequestV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# BatchApplyActionRequestV2Dict - -BatchApplyActionRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**options** | NotRequired[BatchApplyActionRequestOptionsDict] | No | | -**requests** | List[BatchApplyActionRequestItemDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BatchApplyActionResponse.md b/docs/v2/models/BatchApplyActionResponse.md deleted file mode 100644 index a9fb5bc0..00000000 --- a/docs/v2/models/BatchApplyActionResponse.md +++ /dev/null @@ -1,10 +0,0 @@ -# BatchApplyActionResponse - -BatchApplyActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BatchApplyActionResponseDict.md b/docs/v2/models/BatchApplyActionResponseDict.md deleted file mode 100644 index 8cd6879e..00000000 --- a/docs/v2/models/BatchApplyActionResponseDict.md +++ /dev/null @@ -1,10 +0,0 @@ -# BatchApplyActionResponseDict - -BatchApplyActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BatchApplyActionResponseV2.md b/docs/v2/models/BatchApplyActionResponseV2.md deleted file mode 100644 index 6695e258..00000000 --- a/docs/v2/models/BatchApplyActionResponseV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionResponseV2 - -BatchApplyActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**edits** | Optional[ActionResults] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BatchApplyActionResponseV2Dict.md b/docs/v2/models/BatchApplyActionResponseV2Dict.md deleted file mode 100644 index e836ea15..00000000 --- a/docs/v2/models/BatchApplyActionResponseV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BatchApplyActionResponseV2Dict - -BatchApplyActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**edits** | NotRequired[ActionResultsDict] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BinaryType.md b/docs/v2/models/BinaryType.md deleted file mode 100644 index 563af427..00000000 --- a/docs/v2/models/BinaryType.md +++ /dev/null @@ -1,11 +0,0 @@ -# BinaryType - -BinaryType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["binary"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BinaryTypeDict.md b/docs/v2/models/BinaryTypeDict.md deleted file mode 100644 index 4ffab2d9..00000000 --- a/docs/v2/models/BinaryTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BinaryTypeDict - -BinaryType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["binary"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BlueprintIcon.md b/docs/v2/models/BlueprintIcon.md deleted file mode 100644 index 9ccbb33d..00000000 --- a/docs/v2/models/BlueprintIcon.md +++ /dev/null @@ -1,13 +0,0 @@ -# BlueprintIcon - -BlueprintIcon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**color** | StrictStr | Yes | A hexadecimal color code. | -**name** | StrictStr | Yes | The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. Used to specify the Blueprint icon to represent the object type in a React app. | -**type** | Literal["blueprint"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BlueprintIconDict.md b/docs/v2/models/BlueprintIconDict.md deleted file mode 100644 index 348bfb3e..00000000 --- a/docs/v2/models/BlueprintIconDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# BlueprintIconDict - -BlueprintIcon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**color** | StrictStr | Yes | A hexadecimal color code. | -**name** | StrictStr | Yes | The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. Used to specify the Blueprint icon to represent the object type in a React app. | -**type** | Literal["blueprint"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BooleanType.md b/docs/v2/models/BooleanType.md deleted file mode 100644 index 7050367f..00000000 --- a/docs/v2/models/BooleanType.md +++ /dev/null @@ -1,11 +0,0 @@ -# BooleanType - -BooleanType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["boolean"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BooleanTypeDict.md b/docs/v2/models/BooleanTypeDict.md deleted file mode 100644 index 594acac2..00000000 --- a/docs/v2/models/BooleanTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# BooleanTypeDict - -BooleanType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["boolean"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BoundingBoxValue.md b/docs/v2/models/BoundingBoxValue.md deleted file mode 100644 index 57dd04f1..00000000 --- a/docs/v2/models/BoundingBoxValue.md +++ /dev/null @@ -1,13 +0,0 @@ -# BoundingBoxValue - -The top left and bottom right coordinate points that make up the bounding box. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**top_left** | WithinBoundingBoxPoint | Yes | | -**bottom_right** | WithinBoundingBoxPoint | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BoundingBoxValueDict.md b/docs/v2/models/BoundingBoxValueDict.md deleted file mode 100644 index e14dcb93..00000000 --- a/docs/v2/models/BoundingBoxValueDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# BoundingBoxValueDict - -The top left and bottom right coordinate points that make up the bounding box. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**topLeft** | WithinBoundingBoxPointDict | Yes | | -**bottomRight** | WithinBoundingBoxPointDict | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Branch.md b/docs/v2/models/Branch.md deleted file mode 100644 index a1dd3dc4..00000000 --- a/docs/v2/models/Branch.md +++ /dev/null @@ -1,12 +0,0 @@ -# Branch - -Branch - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | BranchName | Yes | | -**transaction_rid** | Optional[TransactionRid] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BranchDict.md b/docs/v2/models/BranchDict.md deleted file mode 100644 index 214f1bfd..00000000 --- a/docs/v2/models/BranchDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# BranchDict - -Branch - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | BranchName | Yes | | -**transactionRid** | NotRequired[TransactionRid] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BranchId.md b/docs/v2/models/BranchId.md deleted file mode 100644 index 00e25705..00000000 --- a/docs/v2/models/BranchId.md +++ /dev/null @@ -1,12 +0,0 @@ -# BranchId - -The identifier (name) of a Branch. Example: `master`. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BranchName.md b/docs/v2/models/BranchName.md deleted file mode 100644 index 2fa19555..00000000 --- a/docs/v2/models/BranchName.md +++ /dev/null @@ -1,12 +0,0 @@ -# BranchName - -The name of a Branch. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Build.md b/docs/v2/models/Build.md deleted file mode 100644 index 83e98c2e..00000000 --- a/docs/v2/models/Build.md +++ /dev/null @@ -1,19 +0,0 @@ -# Build - -Build - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | BuildRid | Yes | The RID of a build | -**branch_name** | BranchName | Yes | The branch that the build is running on. | -**created_time** | CreatedTime | Yes | The timestamp that the build was created. | -**created_by** | CreatedBy | Yes | The user who created the build. | -**fallback_branches** | FallbackBranches | Yes | | -**retry_count** | RetryCount | Yes | | -**retry_backoff_duration** | RetryBackoffDuration | Yes | | -**abort_on_failure** | AbortOnFailure | Yes | | -**status** | BuildStatus | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BuildRid.md b/docs/v2/models/BuildRid.md deleted file mode 100644 index cc6c6aaf..00000000 --- a/docs/v2/models/BuildRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# BuildRid - -The RID of a build - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BuildStatus.md b/docs/v2/models/BuildStatus.md deleted file mode 100644 index 8c299826..00000000 --- a/docs/v2/models/BuildStatus.md +++ /dev/null @@ -1,13 +0,0 @@ -# BuildStatus - -The status of the build. - -| **Value** | -| --------- | -| `"RUNNING"` | -| `"SUCCEEDED"` | -| `"FAILED"` | -| `"CANCELED"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BuildTarget.md b/docs/v2/models/BuildTarget.md deleted file mode 100644 index 53253320..00000000 --- a/docs/v2/models/BuildTarget.md +++ /dev/null @@ -1,17 +0,0 @@ -# BuildTarget - -The targets of the build. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ManualTarget](ManualTarget.md) | manual -[UpstreamTarget](UpstreamTarget.md) | upstream -[ConnectingTarget](ConnectingTarget.md) | connecting - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/BuildTargetDict.md b/docs/v2/models/BuildTargetDict.md deleted file mode 100644 index 8a36d66e..00000000 --- a/docs/v2/models/BuildTargetDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# BuildTargetDict - -The targets of the build. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ManualTargetDict](ManualTargetDict.md) | manual -[UpstreamTargetDict](UpstreamTargetDict.md) | upstream -[ConnectingTargetDict](ConnectingTargetDict.md) | connecting - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ByteType.md b/docs/v2/models/ByteType.md deleted file mode 100644 index e0c11934..00000000 --- a/docs/v2/models/ByteType.md +++ /dev/null @@ -1,11 +0,0 @@ -# ByteType - -ByteType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["byte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ByteTypeDict.md b/docs/v2/models/ByteTypeDict.md deleted file mode 100644 index ffa0905c..00000000 --- a/docs/v2/models/ByteTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ByteTypeDict - -ByteType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["byte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CenterPoint.md b/docs/v2/models/CenterPoint.md deleted file mode 100644 index 41db5ec2..00000000 --- a/docs/v2/models/CenterPoint.md +++ /dev/null @@ -1,13 +0,0 @@ -# CenterPoint - -The coordinate point to use as the center of the distance query. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**center** | CenterPointTypes | Yes | | -**distance** | Distance | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CenterPointDict.md b/docs/v2/models/CenterPointDict.md deleted file mode 100644 index a7fbf257..00000000 --- a/docs/v2/models/CenterPointDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# CenterPointDict - -The coordinate point to use as the center of the distance query. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**center** | CenterPointTypesDict | Yes | | -**distance** | DistanceDict | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CenterPointTypes.md b/docs/v2/models/CenterPointTypes.md deleted file mode 100644 index 9fd77ca5..00000000 --- a/docs/v2/models/CenterPointTypes.md +++ /dev/null @@ -1,11 +0,0 @@ -# CenterPointTypes - -CenterPointTypes - -## Type -```python -GeoPoint -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CenterPointTypesDict.md b/docs/v2/models/CenterPointTypesDict.md deleted file mode 100644 index e5dea841..00000000 --- a/docs/v2/models/CenterPointTypesDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CenterPointTypesDict - -CenterPointTypes - -## Type -```python -GeoPointDict -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ContainsAllTermsInOrderPrefixLastTerm.md b/docs/v2/models/ContainsAllTermsInOrderPrefixLastTerm.md deleted file mode 100644 index 6073435d..00000000 --- a/docs/v2/models/ContainsAllTermsInOrderPrefixLastTerm.md +++ /dev/null @@ -1,16 +0,0 @@ -# ContainsAllTermsInOrderPrefixLastTerm - -Returns objects where the specified field contains all of the terms in the order provided, -but they do have to be adjacent to each other. -The last term can be a partial prefix match. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["containsAllTermsInOrderPrefixLastTerm"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ContainsAllTermsInOrderPrefixLastTermDict.md b/docs/v2/models/ContainsAllTermsInOrderPrefixLastTermDict.md deleted file mode 100644 index 754da615..00000000 --- a/docs/v2/models/ContainsAllTermsInOrderPrefixLastTermDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ContainsAllTermsInOrderPrefixLastTermDict - -Returns objects where the specified field contains all of the terms in the order provided, -but they do have to be adjacent to each other. -The last term can be a partial prefix match. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["containsAllTermsInOrderPrefixLastTerm"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ContainsAllTermsInOrderQuery.md b/docs/v2/models/ContainsAllTermsInOrderQuery.md deleted file mode 100644 index 2f014560..00000000 --- a/docs/v2/models/ContainsAllTermsInOrderQuery.md +++ /dev/null @@ -1,15 +0,0 @@ -# ContainsAllTermsInOrderQuery - -Returns objects where the specified field contains all of the terms in the order provided, -but they do have to be adjacent to each other. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["containsAllTermsInOrder"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ContainsAllTermsInOrderQueryDict.md b/docs/v2/models/ContainsAllTermsInOrderQueryDict.md deleted file mode 100644 index 823e3bd6..00000000 --- a/docs/v2/models/ContainsAllTermsInOrderQueryDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# ContainsAllTermsInOrderQueryDict - -Returns objects where the specified field contains all of the terms in the order provided, -but they do have to be adjacent to each other. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["containsAllTermsInOrder"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ContainsAllTermsQuery.md b/docs/v2/models/ContainsAllTermsQuery.md deleted file mode 100644 index d5556292..00000000 --- a/docs/v2/models/ContainsAllTermsQuery.md +++ /dev/null @@ -1,16 +0,0 @@ -# ContainsAllTermsQuery - -Returns objects where the specified field contains all of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | Optional[FuzzyV2] | No | | -**type** | Literal["containsAllTerms"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ContainsAllTermsQueryDict.md b/docs/v2/models/ContainsAllTermsQueryDict.md deleted file mode 100644 index dc1b6202..00000000 --- a/docs/v2/models/ContainsAllTermsQueryDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ContainsAllTermsQueryDict - -Returns objects where the specified field contains all of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | NotRequired[FuzzyV2] | No | | -**type** | Literal["containsAllTerms"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ContainsAnyTermQuery.md b/docs/v2/models/ContainsAnyTermQuery.md deleted file mode 100644 index 4b046009..00000000 --- a/docs/v2/models/ContainsAnyTermQuery.md +++ /dev/null @@ -1,16 +0,0 @@ -# ContainsAnyTermQuery - -Returns objects where the specified field contains any of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | Optional[FuzzyV2] | No | | -**type** | Literal["containsAnyTerm"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ContainsAnyTermQueryDict.md b/docs/v2/models/ContainsAnyTermQueryDict.md deleted file mode 100644 index 8d6fc024..00000000 --- a/docs/v2/models/ContainsAnyTermQueryDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ContainsAnyTermQueryDict - -Returns objects where the specified field contains any of the whitespace separated words in any -order in the provided value. This query supports fuzzy matching. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**fuzzy** | NotRequired[FuzzyV2] | No | | -**type** | Literal["containsAnyTerm"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ContainsQuery.md b/docs/v2/models/ContainsQuery.md deleted file mode 100644 index 8f79d5f1..00000000 --- a/docs/v2/models/ContainsQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# ContainsQuery - -Returns objects where the specified array contains a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["contains"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ContainsQueryDict.md b/docs/v2/models/ContainsQueryDict.md deleted file mode 100644 index 95ad4abc..00000000 --- a/docs/v2/models/ContainsQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ContainsQueryDict - -Returns objects where the specified array contains a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["contains"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ContainsQueryV2.md b/docs/v2/models/ContainsQueryV2.md deleted file mode 100644 index afaacf9c..00000000 --- a/docs/v2/models/ContainsQueryV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# ContainsQueryV2 - -Returns objects where the specified array contains a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["contains"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ContainsQueryV2Dict.md b/docs/v2/models/ContainsQueryV2Dict.md deleted file mode 100644 index 29b9c300..00000000 --- a/docs/v2/models/ContainsQueryV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ContainsQueryV2Dict - -Returns objects where the specified array contains a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["contains"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ContentLength.md b/docs/v2/models/ContentLength.md deleted file mode 100644 index a6104b30..00000000 --- a/docs/v2/models/ContentLength.md +++ /dev/null @@ -1,11 +0,0 @@ -# ContentLength - -ContentLength - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ContentType.md b/docs/v2/models/ContentType.md deleted file mode 100644 index f2ba9a8f..00000000 --- a/docs/v2/models/ContentType.md +++ /dev/null @@ -1,11 +0,0 @@ -# ContentType - -ContentType - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Coordinate.md b/docs/v2/models/Coordinate.md deleted file mode 100644 index 7ab1d6c9..00000000 --- a/docs/v2/models/Coordinate.md +++ /dev/null @@ -1,11 +0,0 @@ -# Coordinate - -Coordinate - -## Type -```python -StrictFloat -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CountAggregation.md b/docs/v2/models/CountAggregation.md deleted file mode 100644 index 31aa550f..00000000 --- a/docs/v2/models/CountAggregation.md +++ /dev/null @@ -1,12 +0,0 @@ -# CountAggregation - -Computes the total count of objects. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | Optional[AggregationMetricName] | No | | -**type** | Literal["count"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CountAggregationDict.md b/docs/v2/models/CountAggregationDict.md deleted file mode 100644 index f2053bb4..00000000 --- a/docs/v2/models/CountAggregationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CountAggregationDict - -Computes the total count of objects. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["count"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CountAggregationV2.md b/docs/v2/models/CountAggregationV2.md deleted file mode 100644 index f7746475..00000000 --- a/docs/v2/models/CountAggregationV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# CountAggregationV2 - -Computes the total count of objects. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | Optional[AggregationMetricName] | No | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["count"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CountAggregationV2Dict.md b/docs/v2/models/CountAggregationV2Dict.md deleted file mode 100644 index 79ba180f..00000000 --- a/docs/v2/models/CountAggregationV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# CountAggregationV2Dict - -Computes the total count of objects. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["count"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CountObjectsResponseV2.md b/docs/v2/models/CountObjectsResponseV2.md deleted file mode 100644 index 6cc4b1cc..00000000 --- a/docs/v2/models/CountObjectsResponseV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# CountObjectsResponseV2 - -CountObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**count** | Optional[StrictInt] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CountObjectsResponseV2Dict.md b/docs/v2/models/CountObjectsResponseV2Dict.md deleted file mode 100644 index 1c99e3a5..00000000 --- a/docs/v2/models/CountObjectsResponseV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CountObjectsResponseV2Dict - -CountObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**count** | NotRequired[StrictInt] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateBranchRequest.md b/docs/v2/models/CreateBranchRequest.md deleted file mode 100644 index cc84d135..00000000 --- a/docs/v2/models/CreateBranchRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateBranchRequest - -CreateBranchRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**transaction_rid** | Optional[TransactionRid] | No | | -**name** | BranchName | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateBranchRequestDict.md b/docs/v2/models/CreateBranchRequestDict.md deleted file mode 100644 index ee82ac55..00000000 --- a/docs/v2/models/CreateBranchRequestDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateBranchRequestDict - -CreateBranchRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**transactionRid** | NotRequired[TransactionRid] | No | | -**name** | BranchName | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateBuildsRequest.md b/docs/v2/models/CreateBuildsRequest.md deleted file mode 100644 index a4645e03..00000000 --- a/docs/v2/models/CreateBuildsRequest.md +++ /dev/null @@ -1,18 +0,0 @@ -# CreateBuildsRequest - -CreateBuildsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**target** | BuildTarget | Yes | The targets of the schedule. | -**branch_name** | Optional[BranchName] | No | The target branch the build should run on. | -**fallback_branches** | FallbackBranches | Yes | | -**force_build** | Optional[ForceBuild] | No | | -**retry_count** | Optional[RetryCount] | No | The number of retry attempts for failed jobs. | -**retry_backoff_duration** | Optional[RetryBackoffDuration] | No | | -**abort_on_failure** | Optional[AbortOnFailure] | No | | -**notifications_enabled** | Optional[NotificationsEnabled] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateBuildsRequestDict.md b/docs/v2/models/CreateBuildsRequestDict.md deleted file mode 100644 index ad84bb06..00000000 --- a/docs/v2/models/CreateBuildsRequestDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# CreateBuildsRequestDict - -CreateBuildsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**target** | BuildTargetDict | Yes | The targets of the schedule. | -**branchName** | NotRequired[BranchName] | No | The target branch the build should run on. | -**fallbackBranches** | FallbackBranches | Yes | | -**forceBuild** | NotRequired[ForceBuild] | No | | -**retryCount** | NotRequired[RetryCount] | No | The number of retry attempts for failed jobs. | -**retryBackoffDuration** | NotRequired[RetryBackoffDurationDict] | No | | -**abortOnFailure** | NotRequired[AbortOnFailure] | No | | -**notificationsEnabled** | NotRequired[NotificationsEnabled] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateDatasetRequest.md b/docs/v2/models/CreateDatasetRequest.md deleted file mode 100644 index 9f9dff30..00000000 --- a/docs/v2/models/CreateDatasetRequest.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateDatasetRequest - -CreateDatasetRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parent_folder_rid** | FolderRid | Yes | | -**name** | DatasetName | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateDatasetRequestDict.md b/docs/v2/models/CreateDatasetRequestDict.md deleted file mode 100644 index cb09874d..00000000 --- a/docs/v2/models/CreateDatasetRequestDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateDatasetRequestDict - -CreateDatasetRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parentFolderRid** | FolderRid | Yes | | -**name** | DatasetName | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateGroupRequest.md b/docs/v2/models/CreateGroupRequest.md deleted file mode 100644 index 0d1c78ea..00000000 --- a/docs/v2/models/CreateGroupRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# CreateGroupRequest - -CreateGroupRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | GroupName | Yes | The name of the Group. | -**organizations** | List[OrganizationRid] | Yes | The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed. | -**description** | Optional[StrictStr] | No | A description of the Group. | -**attributes** | Dict[AttributeName, AttributeValues] | Yes | A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateGroupRequestDict.md b/docs/v2/models/CreateGroupRequestDict.md deleted file mode 100644 index 31ddd117..00000000 --- a/docs/v2/models/CreateGroupRequestDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# CreateGroupRequestDict - -CreateGroupRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | GroupName | Yes | The name of the Group. | -**organizations** | List[OrganizationRid] | Yes | The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed. | -**description** | NotRequired[StrictStr] | No | A description of the Group. | -**attributes** | Dict[AttributeName, AttributeValues] | Yes | A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateLinkRule.md b/docs/v2/models/CreateLinkRule.md deleted file mode 100644 index 30406f9c..00000000 --- a/docs/v2/models/CreateLinkRule.md +++ /dev/null @@ -1,15 +0,0 @@ -# CreateLinkRule - -CreateLinkRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**link_type_api_name_ato_b** | LinkTypeApiName | Yes | | -**link_type_api_name_bto_a** | LinkTypeApiName | Yes | | -**a_side_object_type_api_name** | ObjectTypeApiName | Yes | | -**b_side_object_type_api_name** | ObjectTypeApiName | Yes | | -**type** | Literal["createLink"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateLinkRuleDict.md b/docs/v2/models/CreateLinkRuleDict.md deleted file mode 100644 index 801b0595..00000000 --- a/docs/v2/models/CreateLinkRuleDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# CreateLinkRuleDict - -CreateLinkRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | -**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | -**aSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**bSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["createLink"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateObjectRule.md b/docs/v2/models/CreateObjectRule.md deleted file mode 100644 index 70661c8f..00000000 --- a/docs/v2/models/CreateObjectRule.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateObjectRule - -CreateObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_type_api_name** | ObjectTypeApiName | Yes | | -**type** | Literal["createObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateObjectRuleDict.md b/docs/v2/models/CreateObjectRuleDict.md deleted file mode 100644 index 8cd9c076..00000000 --- a/docs/v2/models/CreateObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreateObjectRuleDict - -CreateObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["createObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateTemporaryObjectSetRequestV2.md b/docs/v2/models/CreateTemporaryObjectSetRequestV2.md deleted file mode 100644 index c7afa31c..00000000 --- a/docs/v2/models/CreateTemporaryObjectSetRequestV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTemporaryObjectSetRequestV2 - -CreateTemporaryObjectSetRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_set** | ObjectSet | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateTemporaryObjectSetRequestV2Dict.md b/docs/v2/models/CreateTemporaryObjectSetRequestV2Dict.md deleted file mode 100644 index b9382df1..00000000 --- a/docs/v2/models/CreateTemporaryObjectSetRequestV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTemporaryObjectSetRequestV2Dict - -CreateTemporaryObjectSetRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateTemporaryObjectSetResponseV2.md b/docs/v2/models/CreateTemporaryObjectSetResponseV2.md deleted file mode 100644 index 57a1fb1d..00000000 --- a/docs/v2/models/CreateTemporaryObjectSetResponseV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTemporaryObjectSetResponseV2 - -CreateTemporaryObjectSetResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_set_rid** | ObjectSetRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateTemporaryObjectSetResponseV2Dict.md b/docs/v2/models/CreateTemporaryObjectSetResponseV2Dict.md deleted file mode 100644 index 2d57a593..00000000 --- a/docs/v2/models/CreateTemporaryObjectSetResponseV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTemporaryObjectSetResponseV2Dict - -CreateTemporaryObjectSetResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSetRid** | ObjectSetRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateTransactionRequest.md b/docs/v2/models/CreateTransactionRequest.md deleted file mode 100644 index 181359e5..00000000 --- a/docs/v2/models/CreateTransactionRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTransactionRequest - -CreateTransactionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**transaction_type** | TransactionType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreateTransactionRequestDict.md b/docs/v2/models/CreateTransactionRequestDict.md deleted file mode 100644 index ee349e47..00000000 --- a/docs/v2/models/CreateTransactionRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreateTransactionRequestDict - -CreateTransactionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**transactionType** | TransactionType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreatedBy.md b/docs/v2/models/CreatedBy.md deleted file mode 100644 index 6db9b246..00000000 --- a/docs/v2/models/CreatedBy.md +++ /dev/null @@ -1,11 +0,0 @@ -# CreatedBy - -The Foundry user who created this resource - -## Type -```python -UserId -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CreatedTime.md b/docs/v2/models/CreatedTime.md deleted file mode 100644 index dfffedfd..00000000 --- a/docs/v2/models/CreatedTime.md +++ /dev/null @@ -1,12 +0,0 @@ -# CreatedTime - -The time at which the resource was created. - - -## Type -```python -datetime -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CronExpression.md b/docs/v2/models/CronExpression.md deleted file mode 100644 index 9d67e3d6..00000000 --- a/docs/v2/models/CronExpression.md +++ /dev/null @@ -1,13 +0,0 @@ -# CronExpression - -A standard CRON expression with minute, hour, day, month -and day of week. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/CustomTypeId.md b/docs/v2/models/CustomTypeId.md deleted file mode 100644 index 656f45bb..00000000 --- a/docs/v2/models/CustomTypeId.md +++ /dev/null @@ -1,12 +0,0 @@ -# CustomTypeId - -A UUID representing a custom type in a given Function. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DataValue.md b/docs/v2/models/DataValue.md deleted file mode 100644 index 7ab1d62d..00000000 --- a/docs/v2/models/DataValue.md +++ /dev/null @@ -1,35 +0,0 @@ -# DataValue - -Represents the value of data in the following format. Note that these values can be nested, for example an array of structs. -| Type | JSON encoding | Example | -|-----------------------------|-------------------------------------------------------|-------------------------------------------------------------------------------| -| Array | array | `["alpha", "bravo", "charlie"]` | -| Attachment | string | `"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"` | -| Boolean | boolean | `true` | -| Byte | number | `31` | -| Date | ISO 8601 extended local date string | `"2021-05-01"` | -| Decimal | string | `"2.718281828"` | -| Float | number | `3.14159265` | -| Double | number | `3.14159265` | -| Integer | number | `238940` | -| Long | string | `"58319870951433"` | -| Marking | string | `"MU"` | -| Null | null | `null` | -| Object Set | string OR the object set definition | `ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z`| -| Ontology Object Reference | JSON encoding of the object's primary key | `10033123` or `"EMP1234"` | -| Set | array | `["alpha", "bravo", "charlie"]` | -| Short | number | `8739` | -| String | string | `"Call me Ishmael"` | -| Struct | JSON object | `{"name": "John Doe", "age": 42}` | -| TwoDimensionalAggregation | JSON object | `{"groups": [{"key": "alpha", "value": 100}, {"key": "beta", "value": 101}]}` | -| ThreeDimensionalAggregation | JSON object | `{"groups": [{"key": "NYC", "groups": [{"key": "Engineer", "value" : 100}]}]}`| -| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | - - -## Type -```python -Any -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Dataset.md b/docs/v2/models/Dataset.md deleted file mode 100644 index 8525a78e..00000000 --- a/docs/v2/models/Dataset.md +++ /dev/null @@ -1,13 +0,0 @@ -# Dataset - -Dataset - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | DatasetRid | Yes | | -**name** | DatasetName | Yes | | -**parent_folder_rid** | FolderRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DatasetDict.md b/docs/v2/models/DatasetDict.md deleted file mode 100644 index 57612186..00000000 --- a/docs/v2/models/DatasetDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# DatasetDict - -Dataset - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | DatasetRid | Yes | | -**name** | DatasetName | Yes | | -**parentFolderRid** | FolderRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DatasetName.md b/docs/v2/models/DatasetName.md deleted file mode 100644 index a6b9e330..00000000 --- a/docs/v2/models/DatasetName.md +++ /dev/null @@ -1,11 +0,0 @@ -# DatasetName - -DatasetName - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DatasetRid.md b/docs/v2/models/DatasetRid.md deleted file mode 100644 index 0c1a36ea..00000000 --- a/docs/v2/models/DatasetRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# DatasetRid - -The Resource Identifier (RID) of a Dataset. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DatasetUpdatedTrigger.md b/docs/v2/models/DatasetUpdatedTrigger.md deleted file mode 100644 index 22c60a28..00000000 --- a/docs/v2/models/DatasetUpdatedTrigger.md +++ /dev/null @@ -1,15 +0,0 @@ -# DatasetUpdatedTrigger - -Trigger whenever a new transaction is committed to the -dataset on the target branch. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | Yes | | -**branch_name** | BranchName | Yes | | -**type** | Literal["datasetUpdated"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DatasetUpdatedTriggerDict.md b/docs/v2/models/DatasetUpdatedTriggerDict.md deleted file mode 100644 index 5f2a0fa9..00000000 --- a/docs/v2/models/DatasetUpdatedTriggerDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# DatasetUpdatedTriggerDict - -Trigger whenever a new transaction is committed to the -dataset on the target branch. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**datasetRid** | DatasetRid | Yes | | -**branchName** | BranchName | Yes | | -**type** | Literal["datasetUpdated"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DateType.md b/docs/v2/models/DateType.md deleted file mode 100644 index b6711058..00000000 --- a/docs/v2/models/DateType.md +++ /dev/null @@ -1,11 +0,0 @@ -# DateType - -DateType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["date"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DateTypeDict.md b/docs/v2/models/DateTypeDict.md deleted file mode 100644 index 00af52f3..00000000 --- a/docs/v2/models/DateTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# DateTypeDict - -DateType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["date"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DecimalType.md b/docs/v2/models/DecimalType.md deleted file mode 100644 index 559ee5ef..00000000 --- a/docs/v2/models/DecimalType.md +++ /dev/null @@ -1,13 +0,0 @@ -# DecimalType - -DecimalType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**precision** | Optional[StrictInt] | No | | -**scale** | Optional[StrictInt] | No | | -**type** | Literal["decimal"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DecimalTypeDict.md b/docs/v2/models/DecimalTypeDict.md deleted file mode 100644 index 95c745aa..00000000 --- a/docs/v2/models/DecimalTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# DecimalTypeDict - -DecimalType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**precision** | NotRequired[StrictInt] | No | | -**scale** | NotRequired[StrictInt] | No | | -**type** | Literal["decimal"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DeleteLinkRule.md b/docs/v2/models/DeleteLinkRule.md deleted file mode 100644 index 9200c4de..00000000 --- a/docs/v2/models/DeleteLinkRule.md +++ /dev/null @@ -1,15 +0,0 @@ -# DeleteLinkRule - -DeleteLinkRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**link_type_api_name_ato_b** | LinkTypeApiName | Yes | | -**link_type_api_name_bto_a** | LinkTypeApiName | Yes | | -**a_side_object_type_api_name** | ObjectTypeApiName | Yes | | -**b_side_object_type_api_name** | ObjectTypeApiName | Yes | | -**type** | Literal["deleteLink"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DeleteLinkRuleDict.md b/docs/v2/models/DeleteLinkRuleDict.md deleted file mode 100644 index 88413488..00000000 --- a/docs/v2/models/DeleteLinkRuleDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# DeleteLinkRuleDict - -DeleteLinkRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | -**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | -**aSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**bSideObjectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["deleteLink"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DeleteObjectRule.md b/docs/v2/models/DeleteObjectRule.md deleted file mode 100644 index 18601f82..00000000 --- a/docs/v2/models/DeleteObjectRule.md +++ /dev/null @@ -1,12 +0,0 @@ -# DeleteObjectRule - -DeleteObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_type_api_name** | ObjectTypeApiName | Yes | | -**type** | Literal["deleteObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DeleteObjectRuleDict.md b/docs/v2/models/DeleteObjectRuleDict.md deleted file mode 100644 index d1f24704..00000000 --- a/docs/v2/models/DeleteObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# DeleteObjectRuleDict - -DeleteObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["deleteObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DeployWebsiteRequest.md b/docs/v2/models/DeployWebsiteRequest.md deleted file mode 100644 index 7df5d8ab..00000000 --- a/docs/v2/models/DeployWebsiteRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# DeployWebsiteRequest - -DeployWebsiteRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**version** | VersionVersion | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DeployWebsiteRequestDict.md b/docs/v2/models/DeployWebsiteRequestDict.md deleted file mode 100644 index 2ceb8295..00000000 --- a/docs/v2/models/DeployWebsiteRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# DeployWebsiteRequestDict - -DeployWebsiteRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**version** | VersionVersion | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DisplayName.md b/docs/v2/models/DisplayName.md deleted file mode 100644 index d24712c6..00000000 --- a/docs/v2/models/DisplayName.md +++ /dev/null @@ -1,11 +0,0 @@ -# DisplayName - -The display name of the entity. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Distance.md b/docs/v2/models/Distance.md deleted file mode 100644 index 713a89ba..00000000 --- a/docs/v2/models/Distance.md +++ /dev/null @@ -1,12 +0,0 @@ -# Distance - -A measurement of distance. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | StrictFloat | Yes | | -**unit** | DistanceUnit | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DistanceDict.md b/docs/v2/models/DistanceDict.md deleted file mode 100644 index 1866e7da..00000000 --- a/docs/v2/models/DistanceDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# DistanceDict - -A measurement of distance. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | StrictFloat | Yes | | -**unit** | DistanceUnit | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DistanceUnit.md b/docs/v2/models/DistanceUnit.md deleted file mode 100644 index e0e15461..00000000 --- a/docs/v2/models/DistanceUnit.md +++ /dev/null @@ -1,18 +0,0 @@ -# DistanceUnit - -DistanceUnit - -| **Value** | -| --------- | -| `"MILLIMETERS"` | -| `"CENTIMETERS"` | -| `"METERS"` | -| `"KILOMETERS"` | -| `"INCHES"` | -| `"FEET"` | -| `"YARDS"` | -| `"MILES"` | -| `"NAUTICAL_MILES"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DoesNotIntersectBoundingBoxQuery.md b/docs/v2/models/DoesNotIntersectBoundingBoxQuery.md deleted file mode 100644 index 73a09f70..00000000 --- a/docs/v2/models/DoesNotIntersectBoundingBoxQuery.md +++ /dev/null @@ -1,14 +0,0 @@ -# DoesNotIntersectBoundingBoxQuery - -Returns objects where the specified field does not intersect the bounding box provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | BoundingBoxValue | Yes | | -**type** | Literal["doesNotIntersectBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DoesNotIntersectBoundingBoxQueryDict.md b/docs/v2/models/DoesNotIntersectBoundingBoxQueryDict.md deleted file mode 100644 index 50f0ed35..00000000 --- a/docs/v2/models/DoesNotIntersectBoundingBoxQueryDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# DoesNotIntersectBoundingBoxQueryDict - -Returns objects where the specified field does not intersect the bounding box provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | BoundingBoxValueDict | Yes | | -**type** | Literal["doesNotIntersectBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DoesNotIntersectPolygonQuery.md b/docs/v2/models/DoesNotIntersectPolygonQuery.md deleted file mode 100644 index 076d4d03..00000000 --- a/docs/v2/models/DoesNotIntersectPolygonQuery.md +++ /dev/null @@ -1,14 +0,0 @@ -# DoesNotIntersectPolygonQuery - -Returns objects where the specified field does not intersect the polygon provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PolygonValue | Yes | | -**type** | Literal["doesNotIntersectPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DoesNotIntersectPolygonQueryDict.md b/docs/v2/models/DoesNotIntersectPolygonQueryDict.md deleted file mode 100644 index cfac4ab8..00000000 --- a/docs/v2/models/DoesNotIntersectPolygonQueryDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# DoesNotIntersectPolygonQueryDict - -Returns objects where the specified field does not intersect the polygon provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PolygonValueDict | Yes | | -**type** | Literal["doesNotIntersectPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DoubleType.md b/docs/v2/models/DoubleType.md deleted file mode 100644 index d1192aca..00000000 --- a/docs/v2/models/DoubleType.md +++ /dev/null @@ -1,11 +0,0 @@ -# DoubleType - -DoubleType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["double"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DoubleTypeDict.md b/docs/v2/models/DoubleTypeDict.md deleted file mode 100644 index ff33e8eb..00000000 --- a/docs/v2/models/DoubleTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# DoubleTypeDict - -DoubleType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["double"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Duration.md b/docs/v2/models/Duration.md deleted file mode 100644 index 694f79de..00000000 --- a/docs/v2/models/Duration.md +++ /dev/null @@ -1,12 +0,0 @@ -# Duration - -A measurement of duration. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | StrictInt | Yes | The duration value. | -**unit** | TimeUnit | Yes | The unit of duration. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/DurationDict.md b/docs/v2/models/DurationDict.md deleted file mode 100644 index 47d7d0a4..00000000 --- a/docs/v2/models/DurationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# DurationDict - -A measurement of duration. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | StrictInt | Yes | The duration value. | -**unit** | TimeUnit | Yes | The unit of duration. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/EqualsQuery.md b/docs/v2/models/EqualsQuery.md deleted file mode 100644 index 84f8c54c..00000000 --- a/docs/v2/models/EqualsQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# EqualsQuery - -Returns objects where the specified field is equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["eq"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/EqualsQueryDict.md b/docs/v2/models/EqualsQueryDict.md deleted file mode 100644 index 8ad6a618..00000000 --- a/docs/v2/models/EqualsQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# EqualsQueryDict - -Returns objects where the specified field is equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["eq"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/EqualsQueryV2.md b/docs/v2/models/EqualsQueryV2.md deleted file mode 100644 index f2d191ad..00000000 --- a/docs/v2/models/EqualsQueryV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# EqualsQueryV2 - -Returns objects where the specified field is equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["eq"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/EqualsQueryV2Dict.md b/docs/v2/models/EqualsQueryV2Dict.md deleted file mode 100644 index 88fba3c6..00000000 --- a/docs/v2/models/EqualsQueryV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# EqualsQueryV2Dict - -Returns objects where the specified field is equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["eq"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Error.md b/docs/v2/models/Error.md deleted file mode 100644 index 10f33492..00000000 --- a/docs/v2/models/Error.md +++ /dev/null @@ -1,13 +0,0 @@ -# Error - -Error - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**error** | ErrorName | Yes | | -**args** | List[Arg] | Yes | | -**type** | Literal["error"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ErrorDict.md b/docs/v2/models/ErrorDict.md deleted file mode 100644 index afa367f7..00000000 --- a/docs/v2/models/ErrorDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ErrorDict - -Error - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**error** | ErrorName | Yes | | -**args** | List[ArgDict] | Yes | | -**type** | Literal["error"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ErrorName.md b/docs/v2/models/ErrorName.md deleted file mode 100644 index 382e084f..00000000 --- a/docs/v2/models/ErrorName.md +++ /dev/null @@ -1,11 +0,0 @@ -# ErrorName - -ErrorName - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ExactDistinctAggregationV2.md b/docs/v2/models/ExactDistinctAggregationV2.md deleted file mode 100644 index b4c98b41..00000000 --- a/docs/v2/models/ExactDistinctAggregationV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# ExactDistinctAggregationV2 - -Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["exactDistinct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ExactDistinctAggregationV2Dict.md b/docs/v2/models/ExactDistinctAggregationV2Dict.md deleted file mode 100644 index 356c3d26..00000000 --- a/docs/v2/models/ExactDistinctAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ExactDistinctAggregationV2Dict - -Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["exactDistinct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ExecuteQueryRequest.md b/docs/v2/models/ExecuteQueryRequest.md deleted file mode 100644 index 7b85ce39..00000000 --- a/docs/v2/models/ExecuteQueryRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExecuteQueryRequest - -ExecuteQueryRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ExecuteQueryRequestDict.md b/docs/v2/models/ExecuteQueryRequestDict.md deleted file mode 100644 index 191c2081..00000000 --- a/docs/v2/models/ExecuteQueryRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExecuteQueryRequestDict - -ExecuteQueryRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ExecuteQueryResponse.md b/docs/v2/models/ExecuteQueryResponse.md deleted file mode 100644 index 204cdc5b..00000000 --- a/docs/v2/models/ExecuteQueryResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExecuteQueryResponse - -ExecuteQueryResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | DataValue | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ExecuteQueryResponseDict.md b/docs/v2/models/ExecuteQueryResponseDict.md deleted file mode 100644 index 91fa8c6d..00000000 --- a/docs/v2/models/ExecuteQueryResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ExecuteQueryResponseDict - -ExecuteQueryResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | DataValue | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FallbackBranches.md b/docs/v2/models/FallbackBranches.md deleted file mode 100644 index cd8ff25f..00000000 --- a/docs/v2/models/FallbackBranches.md +++ /dev/null @@ -1,13 +0,0 @@ -# FallbackBranches - -The branches to retrieve JobSpecs from if no JobSpec is found on the -target branch. - - -## Type -```python -List[BranchName] -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Feature.md b/docs/v2/models/Feature.md deleted file mode 100644 index 30876a05..00000000 --- a/docs/v2/models/Feature.md +++ /dev/null @@ -1,15 +0,0 @@ -# Feature - -GeoJSon 'Feature' object - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**geometry** | Optional[Geometry] | No | | -**properties** | Dict[FeaturePropertyKey, Any] | Yes | A `Feature` object has a member with the name "properties". The value of the properties member is an object (any JSON object or a JSON null value). | -**id** | Optional[Any] | No | If a `Feature` has a commonly used identifier, that identifier SHOULD be included as a member of the Feature object with the name "id", and the value of this member is either a JSON string or number. | -**bbox** | Optional[BBox] | No | | -**type** | Literal["Feature"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FeatureCollection.md b/docs/v2/models/FeatureCollection.md deleted file mode 100644 index bbd34b15..00000000 --- a/docs/v2/models/FeatureCollection.md +++ /dev/null @@ -1,13 +0,0 @@ -# FeatureCollection - -GeoJSon 'FeatureCollection' object - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**features** | List[FeatureCollectionTypes] | Yes | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["FeatureCollection"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FeatureCollectionDict.md b/docs/v2/models/FeatureCollectionDict.md deleted file mode 100644 index f437f27c..00000000 --- a/docs/v2/models/FeatureCollectionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# FeatureCollectionDict - -GeoJSon 'FeatureCollection' object - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**features** | List[FeatureCollectionTypesDict] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["FeatureCollection"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FeatureCollectionTypes.md b/docs/v2/models/FeatureCollectionTypes.md deleted file mode 100644 index 00274b7f..00000000 --- a/docs/v2/models/FeatureCollectionTypes.md +++ /dev/null @@ -1,11 +0,0 @@ -# FeatureCollectionTypes - -FeatureCollectionTypes - -## Type -```python -Feature -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FeatureCollectionTypesDict.md b/docs/v2/models/FeatureCollectionTypesDict.md deleted file mode 100644 index cda1c2ed..00000000 --- a/docs/v2/models/FeatureCollectionTypesDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# FeatureCollectionTypesDict - -FeatureCollectionTypes - -## Type -```python -FeatureDict -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FeatureDict.md b/docs/v2/models/FeatureDict.md deleted file mode 100644 index c9b7d6f0..00000000 --- a/docs/v2/models/FeatureDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# FeatureDict - -GeoJSon 'Feature' object - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**geometry** | NotRequired[GeometryDict] | No | | -**properties** | Dict[FeaturePropertyKey, Any] | Yes | A `Feature` object has a member with the name "properties". The value of the properties member is an object (any JSON object or a JSON null value). | -**id** | NotRequired[Any] | No | If a `Feature` has a commonly used identifier, that identifier SHOULD be included as a member of the Feature object with the name "id", and the value of this member is either a JSON string or number. | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["Feature"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FeaturePropertyKey.md b/docs/v2/models/FeaturePropertyKey.md deleted file mode 100644 index a35292b2..00000000 --- a/docs/v2/models/FeaturePropertyKey.md +++ /dev/null @@ -1,11 +0,0 @@ -# FeaturePropertyKey - -FeaturePropertyKey - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FieldNameV1.md b/docs/v2/models/FieldNameV1.md deleted file mode 100644 index 082de963..00000000 --- a/docs/v2/models/FieldNameV1.md +++ /dev/null @@ -1,11 +0,0 @@ -# FieldNameV1 - -A reference to an Ontology object property with the form `properties.{propertyApiName}`. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/File.md b/docs/v2/models/File.md deleted file mode 100644 index e42c0df0..00000000 --- a/docs/v2/models/File.md +++ /dev/null @@ -1,14 +0,0 @@ -# File - -File - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**path** | FilePath | Yes | | -**transaction_rid** | TransactionRid | Yes | | -**size_bytes** | Optional[StrictStr] | No | | -**updated_time** | FileUpdatedTime | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FileDict.md b/docs/v2/models/FileDict.md deleted file mode 100644 index 70f12edf..00000000 --- a/docs/v2/models/FileDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# FileDict - -File - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**path** | FilePath | Yes | | -**transactionRid** | TransactionRid | Yes | | -**sizeBytes** | NotRequired[StrictStr] | No | | -**updatedTime** | FileUpdatedTime | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FilePath.md b/docs/v2/models/FilePath.md deleted file mode 100644 index cb1a1981..00000000 --- a/docs/v2/models/FilePath.md +++ /dev/null @@ -1,12 +0,0 @@ -# FilePath - -The path to a File within Foundry. Examples: `my-file.txt`, `path/to/my-file.jpg`, `dataframe.snappy.parquet`. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FileUpdatedTime.md b/docs/v2/models/FileUpdatedTime.md deleted file mode 100644 index d6a50b3b..00000000 --- a/docs/v2/models/FileUpdatedTime.md +++ /dev/null @@ -1,11 +0,0 @@ -# FileUpdatedTime - -FileUpdatedTime - -## Type -```python -datetime -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Filename.md b/docs/v2/models/Filename.md deleted file mode 100644 index 40037f76..00000000 --- a/docs/v2/models/Filename.md +++ /dev/null @@ -1,12 +0,0 @@ -# Filename - -The name of a File within Foundry. Examples: `my-file.txt`, `my-file.jpg`, `dataframe.snappy.parquet`. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FilesystemResource.md b/docs/v2/models/FilesystemResource.md deleted file mode 100644 index 9cb0b5ce..00000000 --- a/docs/v2/models/FilesystemResource.md +++ /dev/null @@ -1,10 +0,0 @@ -# FilesystemResource - -FilesystemResource - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FilesystemResourceDict.md b/docs/v2/models/FilesystemResourceDict.md deleted file mode 100644 index b731c21d..00000000 --- a/docs/v2/models/FilesystemResourceDict.md +++ /dev/null @@ -1,10 +0,0 @@ -# FilesystemResourceDict - -FilesystemResource - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FilterValue.md b/docs/v2/models/FilterValue.md deleted file mode 100644 index 16cacd6a..00000000 --- a/docs/v2/models/FilterValue.md +++ /dev/null @@ -1,13 +0,0 @@ -# FilterValue - -Represents the value of a property filter. For instance, false is the FilterValue in -`properties.{propertyApiName}.isNull=false`. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FloatType.md b/docs/v2/models/FloatType.md deleted file mode 100644 index 4f568b26..00000000 --- a/docs/v2/models/FloatType.md +++ /dev/null @@ -1,11 +0,0 @@ -# FloatType - -FloatType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["float"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FloatTypeDict.md b/docs/v2/models/FloatTypeDict.md deleted file mode 100644 index 95aef653..00000000 --- a/docs/v2/models/FloatTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# FloatTypeDict - -FloatType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["float"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Folder.md b/docs/v2/models/Folder.md deleted file mode 100644 index 5c8f6f18..00000000 --- a/docs/v2/models/Folder.md +++ /dev/null @@ -1,11 +0,0 @@ -# Folder - -Folder - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | FolderRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FolderDict.md b/docs/v2/models/FolderDict.md deleted file mode 100644 index 9f41e6ed..00000000 --- a/docs/v2/models/FolderDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# FolderDict - -Folder - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | FolderRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FolderRid.md b/docs/v2/models/FolderRid.md deleted file mode 100644 index a4d94cc4..00000000 --- a/docs/v2/models/FolderRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# FolderRid - -The unique resource identifier (RID) of a Folder. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ForceBuild.md b/docs/v2/models/ForceBuild.md deleted file mode 100644 index 4fceca57..00000000 --- a/docs/v2/models/ForceBuild.md +++ /dev/null @@ -1,11 +0,0 @@ -# ForceBuild - -Whether to ignore staleness information when running the build. - -## Type -```python -StrictBool -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FunctionRid.md b/docs/v2/models/FunctionRid.md deleted file mode 100644 index b768f697..00000000 --- a/docs/v2/models/FunctionRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# FunctionRid - -The unique resource identifier of a Function, useful for interacting with other Foundry APIs. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FunctionVersion.md b/docs/v2/models/FunctionVersion.md deleted file mode 100644 index 56c1aae8..00000000 --- a/docs/v2/models/FunctionVersion.md +++ /dev/null @@ -1,13 +0,0 @@ -# FunctionVersion - -The version of the given Function, written `..-`, where `-` is optional. -Examples: `1.2.3`, `1.2.3-rc1`. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Fuzzy.md b/docs/v2/models/Fuzzy.md deleted file mode 100644 index 1038f2ee..00000000 --- a/docs/v2/models/Fuzzy.md +++ /dev/null @@ -1,11 +0,0 @@ -# Fuzzy - -Setting fuzzy to `true` allows approximate matching in search queries that support it. - -## Type -```python -StrictBool -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/FuzzyV2.md b/docs/v2/models/FuzzyV2.md deleted file mode 100644 index f6092450..00000000 --- a/docs/v2/models/FuzzyV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# FuzzyV2 - -Setting fuzzy to `true` allows approximate matching in search queries that support it. - -## Type -```python -StrictBool -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GeoJsonObject.md b/docs/v2/models/GeoJsonObject.md deleted file mode 100644 index c0c19c8d..00000000 --- a/docs/v2/models/GeoJsonObject.md +++ /dev/null @@ -1,35 +0,0 @@ -# GeoJsonObject - -GeoJSon object - -The coordinate reference system for all GeoJSON coordinates is a -geographic coordinate reference system, using the World Geodetic System -1984 (WGS 84) datum, with longitude and latitude units of decimal -degrees. -This is equivalent to the coordinate reference system identified by the -Open Geospatial Consortium (OGC) URN -An OPTIONAL third-position element SHALL be the height in meters above -or below the WGS 84 reference ellipsoid. -In the absence of elevation values, applications sensitive to height or -depth SHOULD interpret positions as being at local ground or sea level. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[Feature](Feature.md) | Feature -[FeatureCollection](FeatureCollection.md) | FeatureCollection -[GeoPoint](GeoPoint.md) | Point -[MultiPoint](MultiPoint.md) | MultiPoint -[LineString](LineString.md) | LineString -[MultiLineString](MultiLineString.md) | MultiLineString -[Polygon](Polygon.md) | Polygon -[MultiPolygon](MultiPolygon.md) | MultiPolygon -[GeometryCollection](GeometryCollection.md) | GeometryCollection - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GeoJsonObjectDict.md b/docs/v2/models/GeoJsonObjectDict.md deleted file mode 100644 index 3a524d98..00000000 --- a/docs/v2/models/GeoJsonObjectDict.md +++ /dev/null @@ -1,35 +0,0 @@ -# GeoJsonObjectDict - -GeoJSon object - -The coordinate reference system for all GeoJSON coordinates is a -geographic coordinate reference system, using the World Geodetic System -1984 (WGS 84) datum, with longitude and latitude units of decimal -degrees. -This is equivalent to the coordinate reference system identified by the -Open Geospatial Consortium (OGC) URN -An OPTIONAL third-position element SHALL be the height in meters above -or below the WGS 84 reference ellipsoid. -In the absence of elevation values, applications sensitive to height or -depth SHOULD interpret positions as being at local ground or sea level. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[FeatureDict](FeatureDict.md) | Feature -[FeatureCollectionDict](FeatureCollectionDict.md) | FeatureCollection -[GeoPointDict](GeoPointDict.md) | Point -[MultiPointDict](MultiPointDict.md) | MultiPoint -[LineStringDict](LineStringDict.md) | LineString -[MultiLineStringDict](MultiLineStringDict.md) | MultiLineString -[PolygonDict](PolygonDict.md) | Polygon -[MultiPolygonDict](MultiPolygonDict.md) | MultiPolygon -[GeometryCollectionDict](GeometryCollectionDict.md) | GeometryCollection - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GeoPoint.md b/docs/v2/models/GeoPoint.md deleted file mode 100644 index 46f2b3e5..00000000 --- a/docs/v2/models/GeoPoint.md +++ /dev/null @@ -1,13 +0,0 @@ -# GeoPoint - -GeoPoint - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | Position | Yes | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["Point"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GeoPointDict.md b/docs/v2/models/GeoPointDict.md deleted file mode 100644 index 360b45b6..00000000 --- a/docs/v2/models/GeoPointDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GeoPointDict - -GeoPoint - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | Position | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["Point"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GeoPointType.md b/docs/v2/models/GeoPointType.md deleted file mode 100644 index 6e2dbfa9..00000000 --- a/docs/v2/models/GeoPointType.md +++ /dev/null @@ -1,11 +0,0 @@ -# GeoPointType - -GeoPointType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["geopoint"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GeoPointTypeDict.md b/docs/v2/models/GeoPointTypeDict.md deleted file mode 100644 index 69e0022e..00000000 --- a/docs/v2/models/GeoPointTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GeoPointTypeDict - -GeoPointType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["geopoint"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GeoShapeType.md b/docs/v2/models/GeoShapeType.md deleted file mode 100644 index a342582a..00000000 --- a/docs/v2/models/GeoShapeType.md +++ /dev/null @@ -1,11 +0,0 @@ -# GeoShapeType - -GeoShapeType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["geoshape"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GeoShapeTypeDict.md b/docs/v2/models/GeoShapeTypeDict.md deleted file mode 100644 index 9bcdce19..00000000 --- a/docs/v2/models/GeoShapeTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GeoShapeTypeDict - -GeoShapeType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["geoshape"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Geometry.md b/docs/v2/models/Geometry.md deleted file mode 100644 index 3400d6ba..00000000 --- a/docs/v2/models/Geometry.md +++ /dev/null @@ -1,21 +0,0 @@ -# Geometry - -Abstract type for all GeoJSon object except Feature and FeatureCollection - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[GeoPoint](GeoPoint.md) | Point -[MultiPoint](MultiPoint.md) | MultiPoint -[LineString](LineString.md) | LineString -[MultiLineString](MultiLineString.md) | MultiLineString -[Polygon](Polygon.md) | Polygon -[MultiPolygon](MultiPolygon.md) | MultiPolygon -[GeometryCollection](GeometryCollection.md) | GeometryCollection - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GeometryCollection.md b/docs/v2/models/GeometryCollection.md deleted file mode 100644 index 74612d15..00000000 --- a/docs/v2/models/GeometryCollection.md +++ /dev/null @@ -1,19 +0,0 @@ -# GeometryCollection - -GeoJSon geometry collection - -GeometryCollections composed of a single part or a number of parts of a -single type SHOULD be avoided when that single part or a single object -of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could -be used instead. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**geometries** | List[Geometry] | Yes | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["GeometryCollection"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GeometryCollectionDict.md b/docs/v2/models/GeometryCollectionDict.md deleted file mode 100644 index 0488dbed..00000000 --- a/docs/v2/models/GeometryCollectionDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# GeometryCollectionDict - -GeoJSon geometry collection - -GeometryCollections composed of a single part or a number of parts of a -single type SHOULD be avoided when that single part or a single object -of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could -be used instead. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**geometries** | List[GeometryDict] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["GeometryCollection"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GeometryDict.md b/docs/v2/models/GeometryDict.md deleted file mode 100644 index 933b2eaf..00000000 --- a/docs/v2/models/GeometryDict.md +++ /dev/null @@ -1,21 +0,0 @@ -# GeometryDict - -Abstract type for all GeoJSon object except Feature and FeatureCollection - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[GeoPointDict](GeoPointDict.md) | Point -[MultiPointDict](MultiPointDict.md) | MultiPoint -[LineStringDict](LineStringDict.md) | LineString -[MultiLineStringDict](MultiLineStringDict.md) | MultiLineString -[PolygonDict](PolygonDict.md) | Polygon -[MultiPolygonDict](MultiPolygonDict.md) | MultiPolygon -[GeometryCollectionDict](GeometryCollectionDict.md) | GeometryCollection - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GeotimeSeriesValue.md b/docs/v2/models/GeotimeSeriesValue.md deleted file mode 100644 index d8bfbe31..00000000 --- a/docs/v2/models/GeotimeSeriesValue.md +++ /dev/null @@ -1,13 +0,0 @@ -# GeotimeSeriesValue - -The underlying data values pointed to by a GeotimeSeriesReference. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**position** | Position | Yes | | -**timestamp** | datetime | Yes | | -**type** | Literal["geotimeSeriesValue"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GeotimeSeriesValueDict.md b/docs/v2/models/GeotimeSeriesValueDict.md deleted file mode 100644 index d412808d..00000000 --- a/docs/v2/models/GeotimeSeriesValueDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GeotimeSeriesValueDict - -The underlying data values pointed to by a GeotimeSeriesReference. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**position** | Position | Yes | | -**timestamp** | datetime | Yes | | -**type** | Literal["geotimeSeriesValue"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GetGroupsBatchRequestElement.md b/docs/v2/models/GetGroupsBatchRequestElement.md deleted file mode 100644 index 51767e15..00000000 --- a/docs/v2/models/GetGroupsBatchRequestElement.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetGroupsBatchRequestElement - -GetGroupsBatchRequestElement - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**group_id** | PrincipalId | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GetGroupsBatchRequestElementDict.md b/docs/v2/models/GetGroupsBatchRequestElementDict.md deleted file mode 100644 index faacd83b..00000000 --- a/docs/v2/models/GetGroupsBatchRequestElementDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetGroupsBatchRequestElementDict - -GetGroupsBatchRequestElement - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**groupId** | PrincipalId | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GetGroupsBatchResponse.md b/docs/v2/models/GetGroupsBatchResponse.md deleted file mode 100644 index c0c6b5ac..00000000 --- a/docs/v2/models/GetGroupsBatchResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetGroupsBatchResponse - -GetGroupsBatchResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | Dict[PrincipalId, Group] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GetGroupsBatchResponseDict.md b/docs/v2/models/GetGroupsBatchResponseDict.md deleted file mode 100644 index 2ec3517a..00000000 --- a/docs/v2/models/GetGroupsBatchResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetGroupsBatchResponseDict - -GetGroupsBatchResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | Dict[PrincipalId, GroupDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GetUsersBatchRequestElement.md b/docs/v2/models/GetUsersBatchRequestElement.md deleted file mode 100644 index 4a140992..00000000 --- a/docs/v2/models/GetUsersBatchRequestElement.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetUsersBatchRequestElement - -GetUsersBatchRequestElement - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**user_id** | PrincipalId | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GetUsersBatchRequestElementDict.md b/docs/v2/models/GetUsersBatchRequestElementDict.md deleted file mode 100644 index 969e766d..00000000 --- a/docs/v2/models/GetUsersBatchRequestElementDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetUsersBatchRequestElementDict - -GetUsersBatchRequestElement - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**userId** | PrincipalId | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GetUsersBatchResponse.md b/docs/v2/models/GetUsersBatchResponse.md deleted file mode 100644 index ccc57607..00000000 --- a/docs/v2/models/GetUsersBatchResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetUsersBatchResponse - -GetUsersBatchResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | Dict[PrincipalId, User] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GetUsersBatchResponseDict.md b/docs/v2/models/GetUsersBatchResponseDict.md deleted file mode 100644 index 66ca391d..00000000 --- a/docs/v2/models/GetUsersBatchResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GetUsersBatchResponseDict - -GetUsersBatchResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | Dict[PrincipalId, UserDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Group.md b/docs/v2/models/Group.md deleted file mode 100644 index 8d7ec022..00000000 --- a/docs/v2/models/Group.md +++ /dev/null @@ -1,16 +0,0 @@ -# Group - -Group - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | PrincipalId | Yes | | -**name** | GroupName | Yes | The name of the Group. | -**description** | Optional[StrictStr] | No | A description of the Group. | -**realm** | Realm | Yes | | -**organizations** | List[OrganizationRid] | Yes | The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed. | -**attributes** | Dict[AttributeName, AttributeValues] | Yes | A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GroupMember.md b/docs/v2/models/GroupMember.md deleted file mode 100644 index 127a0fe3..00000000 --- a/docs/v2/models/GroupMember.md +++ /dev/null @@ -1,12 +0,0 @@ -# GroupMember - -GroupMember - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**principal_type** | PrincipalType | Yes | | -**principal_id** | PrincipalId | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GroupMemberConstraint.md b/docs/v2/models/GroupMemberConstraint.md deleted file mode 100644 index ef35bdd6..00000000 --- a/docs/v2/models/GroupMemberConstraint.md +++ /dev/null @@ -1,12 +0,0 @@ -# GroupMemberConstraint - -The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["groupMember"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GroupMemberConstraintDict.md b/docs/v2/models/GroupMemberConstraintDict.md deleted file mode 100644 index 9e6002f6..00000000 --- a/docs/v2/models/GroupMemberConstraintDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# GroupMemberConstraintDict - -The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["groupMember"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GroupMemberDict.md b/docs/v2/models/GroupMemberDict.md deleted file mode 100644 index f6b9e03b..00000000 --- a/docs/v2/models/GroupMemberDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# GroupMemberDict - -GroupMember - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**principalType** | PrincipalType | Yes | | -**principalId** | PrincipalId | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GroupMembership.md b/docs/v2/models/GroupMembership.md deleted file mode 100644 index 470e5f9e..00000000 --- a/docs/v2/models/GroupMembership.md +++ /dev/null @@ -1,11 +0,0 @@ -# GroupMembership - -GroupMembership - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**group_id** | PrincipalId | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GroupMembershipDict.md b/docs/v2/models/GroupMembershipDict.md deleted file mode 100644 index 419cd8d6..00000000 --- a/docs/v2/models/GroupMembershipDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# GroupMembershipDict - -GroupMembership - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**groupId** | PrincipalId | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GroupMembershipExpiration.md b/docs/v2/models/GroupMembershipExpiration.md deleted file mode 100644 index 416f32d4..00000000 --- a/docs/v2/models/GroupMembershipExpiration.md +++ /dev/null @@ -1,11 +0,0 @@ -# GroupMembershipExpiration - -GroupMembershipExpiration - -## Type -```python -datetime -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GroupName.md b/docs/v2/models/GroupName.md deleted file mode 100644 index cf65034e..00000000 --- a/docs/v2/models/GroupName.md +++ /dev/null @@ -1,11 +0,0 @@ -# GroupName - -The name of the Group. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GroupSearchFilter.md b/docs/v2/models/GroupSearchFilter.md deleted file mode 100644 index daa8a72f..00000000 --- a/docs/v2/models/GroupSearchFilter.md +++ /dev/null @@ -1,12 +0,0 @@ -# GroupSearchFilter - -GroupSearchFilter - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | PrincipalFilterType | Yes | | -**value** | StrictStr | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GroupSearchFilterDict.md b/docs/v2/models/GroupSearchFilterDict.md deleted file mode 100644 index 1f6ac2d3..00000000 --- a/docs/v2/models/GroupSearchFilterDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# GroupSearchFilterDict - -GroupSearchFilter - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | PrincipalFilterType | Yes | | -**value** | StrictStr | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GtQuery.md b/docs/v2/models/GtQuery.md deleted file mode 100644 index 96673dd1..00000000 --- a/docs/v2/models/GtQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# GtQuery - -Returns objects where the specified field is greater than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GtQueryDict.md b/docs/v2/models/GtQueryDict.md deleted file mode 100644 index 32f7c238..00000000 --- a/docs/v2/models/GtQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GtQueryDict - -Returns objects where the specified field is greater than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GtQueryV2.md b/docs/v2/models/GtQueryV2.md deleted file mode 100644 index 6f031533..00000000 --- a/docs/v2/models/GtQueryV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# GtQueryV2 - -Returns objects where the specified field is greater than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GtQueryV2Dict.md b/docs/v2/models/GtQueryV2Dict.md deleted file mode 100644 index 04bd708a..00000000 --- a/docs/v2/models/GtQueryV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GtQueryV2Dict - -Returns objects where the specified field is greater than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GteQuery.md b/docs/v2/models/GteQuery.md deleted file mode 100644 index b46f10ad..00000000 --- a/docs/v2/models/GteQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# GteQuery - -Returns objects where the specified field is greater than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GteQueryDict.md b/docs/v2/models/GteQueryDict.md deleted file mode 100644 index d38dd6eb..00000000 --- a/docs/v2/models/GteQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GteQueryDict - -Returns objects where the specified field is greater than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GteQueryV2.md b/docs/v2/models/GteQueryV2.md deleted file mode 100644 index 9957e7e5..00000000 --- a/docs/v2/models/GteQueryV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# GteQueryV2 - -Returns objects where the specified field is greater than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/GteQueryV2Dict.md b/docs/v2/models/GteQueryV2Dict.md deleted file mode 100644 index e996223e..00000000 --- a/docs/v2/models/GteQueryV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# GteQueryV2Dict - -Returns objects where the specified field is greater than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["gte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Icon.md b/docs/v2/models/Icon.md deleted file mode 100644 index 5e19a231..00000000 --- a/docs/v2/models/Icon.md +++ /dev/null @@ -1,11 +0,0 @@ -# Icon - -A union currently only consisting of the BlueprintIcon (more icon types may be added in the future). - -## Type -```python -BlueprintIcon -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/IconDict.md b/docs/v2/models/IconDict.md deleted file mode 100644 index f0e941e4..00000000 --- a/docs/v2/models/IconDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# IconDict - -A union currently only consisting of the BlueprintIcon (more icon types may be added in the future). - -## Type -```python -BlueprintIconDict -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/IntegerType.md b/docs/v2/models/IntegerType.md deleted file mode 100644 index 06470aad..00000000 --- a/docs/v2/models/IntegerType.md +++ /dev/null @@ -1,11 +0,0 @@ -# IntegerType - -IntegerType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["integer"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/IntegerTypeDict.md b/docs/v2/models/IntegerTypeDict.md deleted file mode 100644 index 0139e02d..00000000 --- a/docs/v2/models/IntegerTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# IntegerTypeDict - -IntegerType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["integer"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/InterfaceLinkType.md b/docs/v2/models/InterfaceLinkType.md deleted file mode 100644 index c10c1de7..00000000 --- a/docs/v2/models/InterfaceLinkType.md +++ /dev/null @@ -1,19 +0,0 @@ -# InterfaceLinkType - -A link type constraint defined at the interface level where the implementation of the links is provided -by the implementing object types. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | InterfaceLinkTypeRid | Yes | | -**api_name** | InterfaceLinkTypeApiName | Yes | | -**display_name** | DisplayName | Yes | | -**description** | Optional[StrictStr] | No | The description of the interface link type. | -**linked_entity_api_name** | InterfaceLinkTypeLinkedEntityApiName | Yes | | -**cardinality** | InterfaceLinkTypeCardinality | Yes | | -**required** | StrictBool | Yes | Whether each implementing object type must declare at least one implementation of this link. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/InterfaceLinkTypeApiName.md b/docs/v2/models/InterfaceLinkTypeApiName.md deleted file mode 100644 index 827d6e2b..00000000 --- a/docs/v2/models/InterfaceLinkTypeApiName.md +++ /dev/null @@ -1,11 +0,0 @@ -# InterfaceLinkTypeApiName - -A string indicating the API name to use for the interface link. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/InterfaceLinkTypeCardinality.md b/docs/v2/models/InterfaceLinkTypeCardinality.md deleted file mode 100644 index fe821732..00000000 --- a/docs/v2/models/InterfaceLinkTypeCardinality.md +++ /dev/null @@ -1,13 +0,0 @@ -# InterfaceLinkTypeCardinality - -The cardinality of the link in the given direction. Cardinality can be "ONE", meaning an object can -link to zero or one other objects, or "MANY", meaning an object can link to any number of other objects. - - -| **Value** | -| --------- | -| `"ONE"` | -| `"MANY"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/InterfaceLinkTypeDict.md b/docs/v2/models/InterfaceLinkTypeDict.md deleted file mode 100644 index f6546a2f..00000000 --- a/docs/v2/models/InterfaceLinkTypeDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# InterfaceLinkTypeDict - -A link type constraint defined at the interface level where the implementation of the links is provided -by the implementing object types. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | InterfaceLinkTypeRid | Yes | | -**apiName** | InterfaceLinkTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | NotRequired[StrictStr] | No | The description of the interface link type. | -**linkedEntityApiName** | InterfaceLinkTypeLinkedEntityApiNameDict | Yes | | -**cardinality** | InterfaceLinkTypeCardinality | Yes | | -**required** | StrictBool | Yes | Whether each implementing object type must declare at least one implementation of this link. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/InterfaceLinkTypeLinkedEntityApiName.md b/docs/v2/models/InterfaceLinkTypeLinkedEntityApiName.md deleted file mode 100644 index ec59da8a..00000000 --- a/docs/v2/models/InterfaceLinkTypeLinkedEntityApiName.md +++ /dev/null @@ -1,16 +0,0 @@ -# InterfaceLinkTypeLinkedEntityApiName - -A reference to the linked entity. This can either be an object or an interface type. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[LinkedInterfaceTypeApiName](LinkedInterfaceTypeApiName.md) | interfaceTypeApiName -[LinkedObjectTypeApiName](LinkedObjectTypeApiName.md) | objectTypeApiName - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/InterfaceLinkTypeLinkedEntityApiNameDict.md b/docs/v2/models/InterfaceLinkTypeLinkedEntityApiNameDict.md deleted file mode 100644 index 861acf02..00000000 --- a/docs/v2/models/InterfaceLinkTypeLinkedEntityApiNameDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# InterfaceLinkTypeLinkedEntityApiNameDict - -A reference to the linked entity. This can either be an object or an interface type. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[LinkedInterfaceTypeApiNameDict](LinkedInterfaceTypeApiNameDict.md) | interfaceTypeApiName -[LinkedObjectTypeApiNameDict](LinkedObjectTypeApiNameDict.md) | objectTypeApiName - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/InterfaceLinkTypeRid.md b/docs/v2/models/InterfaceLinkTypeRid.md deleted file mode 100644 index 214adbaf..00000000 --- a/docs/v2/models/InterfaceLinkTypeRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# InterfaceLinkTypeRid - -The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/InterfaceType.md b/docs/v2/models/InterfaceType.md deleted file mode 100644 index 235d2362..00000000 --- a/docs/v2/models/InterfaceType.md +++ /dev/null @@ -1,17 +0,0 @@ -# InterfaceType - -Represents an interface type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | InterfaceTypeRid | Yes | | -**api_name** | InterfaceTypeApiName | Yes | | -**display_name** | DisplayName | Yes | | -**description** | Optional[StrictStr] | No | The description of the interface. | -**properties** | Dict[SharedPropertyTypeApiName, SharedPropertyType] | Yes | A map from a shared property type API name to the corresponding shared property type. The map describes the set of properties the interface has. A shared property type must be unique across all of the properties. | -**extends_interfaces** | List[InterfaceTypeApiName] | Yes | A list of interface API names that this interface extends. An interface can extend other interfaces to inherit their properties. | -**links** | Dict[InterfaceLinkTypeApiName, InterfaceLinkType] | Yes | A map from an interface link type API name to the corresponding interface link type. The map describes the set of link types the interface has. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/InterfaceTypeApiName.md b/docs/v2/models/InterfaceTypeApiName.md deleted file mode 100644 index 1022b061..00000000 --- a/docs/v2/models/InterfaceTypeApiName.md +++ /dev/null @@ -1,13 +0,0 @@ -# InterfaceTypeApiName - -The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface -type, use the `List interface types` endpoint or check the **Ontology Manager**. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/InterfaceTypeDict.md b/docs/v2/models/InterfaceTypeDict.md deleted file mode 100644 index 7daa7d48..00000000 --- a/docs/v2/models/InterfaceTypeDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# InterfaceTypeDict - -Represents an interface type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | InterfaceTypeRid | Yes | | -**apiName** | InterfaceTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | NotRequired[StrictStr] | No | The description of the interface. | -**properties** | Dict[SharedPropertyTypeApiName, SharedPropertyTypeDict] | Yes | A map from a shared property type API name to the corresponding shared property type. The map describes the set of properties the interface has. A shared property type must be unique across all of the properties. | -**extendsInterfaces** | List[InterfaceTypeApiName] | Yes | A list of interface API names that this interface extends. An interface can extend other interfaces to inherit their properties. | -**links** | Dict[InterfaceLinkTypeApiName, InterfaceLinkTypeDict] | Yes | A map from an interface link type API name to the corresponding interface link type. The map describes the set of link types the interface has. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/InterfaceTypeRid.md b/docs/v2/models/InterfaceTypeRid.md deleted file mode 100644 index 833d253c..00000000 --- a/docs/v2/models/InterfaceTypeRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# InterfaceTypeRid - -The unique resource identifier of an interface, useful for interacting with other Foundry APIs. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/IntersectsBoundingBoxQuery.md b/docs/v2/models/IntersectsBoundingBoxQuery.md deleted file mode 100644 index 8abb7a1f..00000000 --- a/docs/v2/models/IntersectsBoundingBoxQuery.md +++ /dev/null @@ -1,14 +0,0 @@ -# IntersectsBoundingBoxQuery - -Returns objects where the specified field intersects the bounding box provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | BoundingBoxValue | Yes | | -**type** | Literal["intersectsBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/IntersectsBoundingBoxQueryDict.md b/docs/v2/models/IntersectsBoundingBoxQueryDict.md deleted file mode 100644 index 19499a6f..00000000 --- a/docs/v2/models/IntersectsBoundingBoxQueryDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# IntersectsBoundingBoxQueryDict - -Returns objects where the specified field intersects the bounding box provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | BoundingBoxValueDict | Yes | | -**type** | Literal["intersectsBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/IntersectsPolygonQuery.md b/docs/v2/models/IntersectsPolygonQuery.md deleted file mode 100644 index 7817f90b..00000000 --- a/docs/v2/models/IntersectsPolygonQuery.md +++ /dev/null @@ -1,14 +0,0 @@ -# IntersectsPolygonQuery - -Returns objects where the specified field intersects the polygon provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PolygonValue | Yes | | -**type** | Literal["intersectsPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/IntersectsPolygonQueryDict.md b/docs/v2/models/IntersectsPolygonQueryDict.md deleted file mode 100644 index 85c6a01a..00000000 --- a/docs/v2/models/IntersectsPolygonQueryDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# IntersectsPolygonQueryDict - -Returns objects where the specified field intersects the polygon provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PolygonValueDict | Yes | | -**type** | Literal["intersectsPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/IrVersion.md b/docs/v2/models/IrVersion.md deleted file mode 100644 index d956abcc..00000000 --- a/docs/v2/models/IrVersion.md +++ /dev/null @@ -1,10 +0,0 @@ -# IrVersion - -IrVersion - -| **Value** | -| --------- | -| `"v1"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/IsNullQuery.md b/docs/v2/models/IsNullQuery.md deleted file mode 100644 index de075921..00000000 --- a/docs/v2/models/IsNullQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# IsNullQuery - -Returns objects based on the existence of the specified field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictBool | Yes | | -**type** | Literal["isNull"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/IsNullQueryDict.md b/docs/v2/models/IsNullQueryDict.md deleted file mode 100644 index 5f67c235..00000000 --- a/docs/v2/models/IsNullQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# IsNullQueryDict - -Returns objects based on the existence of the specified field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictBool | Yes | | -**type** | Literal["isNull"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/IsNullQueryV2.md b/docs/v2/models/IsNullQueryV2.md deleted file mode 100644 index 8712246f..00000000 --- a/docs/v2/models/IsNullQueryV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# IsNullQueryV2 - -Returns objects based on the existence of the specified field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictBool | Yes | | -**type** | Literal["isNull"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/IsNullQueryV2Dict.md b/docs/v2/models/IsNullQueryV2Dict.md deleted file mode 100644 index f59e4113..00000000 --- a/docs/v2/models/IsNullQueryV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# IsNullQueryV2Dict - -Returns objects based on the existence of the specified field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictBool | Yes | | -**type** | Literal["isNull"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/JobSucceededTrigger.md b/docs/v2/models/JobSucceededTrigger.md deleted file mode 100644 index 808cd087..00000000 --- a/docs/v2/models/JobSucceededTrigger.md +++ /dev/null @@ -1,15 +0,0 @@ -# JobSucceededTrigger - -Trigger whenever a job succeeds on the dataset and on the target -branch. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | Yes | | -**branch_name** | BranchName | Yes | | -**type** | Literal["jobSucceeded"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/JobSucceededTriggerDict.md b/docs/v2/models/JobSucceededTriggerDict.md deleted file mode 100644 index bfac9974..00000000 --- a/docs/v2/models/JobSucceededTriggerDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# JobSucceededTriggerDict - -Trigger whenever a job succeeds on the dataset and on the target -branch. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**datasetRid** | DatasetRid | Yes | | -**branchName** | BranchName | Yes | | -**type** | Literal["jobSucceeded"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LineString.md b/docs/v2/models/LineString.md deleted file mode 100644 index fa168921..00000000 --- a/docs/v2/models/LineString.md +++ /dev/null @@ -1,13 +0,0 @@ -# LineString - -LineString - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | Optional[LineStringCoordinates] | No | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["LineString"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LineStringCoordinates.md b/docs/v2/models/LineStringCoordinates.md deleted file mode 100644 index 80a7f8bf..00000000 --- a/docs/v2/models/LineStringCoordinates.md +++ /dev/null @@ -1,12 +0,0 @@ -# LineStringCoordinates - -GeoJSon fundamental geometry construct, array of two or more positions. - - -## Type -```python -List[Position] -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LineStringDict.md b/docs/v2/models/LineStringDict.md deleted file mode 100644 index 1ceac71b..00000000 --- a/docs/v2/models/LineStringDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LineStringDict - -LineString - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | NotRequired[LineStringCoordinates] | No | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["LineString"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinearRing.md b/docs/v2/models/LinearRing.md deleted file mode 100644 index 1b2068ba..00000000 --- a/docs/v2/models/LinearRing.md +++ /dev/null @@ -1,22 +0,0 @@ -# LinearRing - -A linear ring is a closed LineString with four or more positions. - -The first and last positions are equivalent, and they MUST contain -identical values; their representation SHOULD also be identical. - -A linear ring is the boundary of a surface or the boundary of a hole in -a surface. - -A linear ring MUST follow the right-hand rule with respect to the area -it bounds, i.e., exterior rings are counterclockwise, and holes are -clockwise. - - -## Type -```python -List[Position] -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinkSideObject.md b/docs/v2/models/LinkSideObject.md deleted file mode 100644 index c2d9edb2..00000000 --- a/docs/v2/models/LinkSideObject.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkSideObject - -LinkSideObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primary_key** | PropertyValue | Yes | | -**object_type** | ObjectTypeApiName | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinkSideObjectDict.md b/docs/v2/models/LinkSideObjectDict.md deleted file mode 100644 index c3a006a1..00000000 --- a/docs/v2/models/LinkSideObjectDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkSideObjectDict - -LinkSideObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primaryKey** | PropertyValue | Yes | | -**objectType** | ObjectTypeApiName | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinkTypeApiName.md b/docs/v2/models/LinkTypeApiName.md deleted file mode 100644 index 2cd24adb..00000000 --- a/docs/v2/models/LinkTypeApiName.md +++ /dev/null @@ -1,13 +0,0 @@ -# LinkTypeApiName - -The name of the link type in the API. To find the API name for your Link Type, check the **Ontology Manager** -application. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinkTypeRid.md b/docs/v2/models/LinkTypeRid.md deleted file mode 100644 index bee5ac5f..00000000 --- a/docs/v2/models/LinkTypeRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# LinkTypeRid - -LinkTypeRid - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinkTypeSide.md b/docs/v2/models/LinkTypeSide.md deleted file mode 100644 index 1973f68e..00000000 --- a/docs/v2/models/LinkTypeSide.md +++ /dev/null @@ -1,16 +0,0 @@ -# LinkTypeSide - -LinkTypeSide - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | LinkTypeApiName | Yes | | -**display_name** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**object_type_api_name** | ObjectTypeApiName | Yes | | -**cardinality** | LinkTypeSideCardinality | Yes | | -**foreign_key_property_api_name** | Optional[PropertyApiName] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinkTypeSideCardinality.md b/docs/v2/models/LinkTypeSideCardinality.md deleted file mode 100644 index bd4c7554..00000000 --- a/docs/v2/models/LinkTypeSideCardinality.md +++ /dev/null @@ -1,11 +0,0 @@ -# LinkTypeSideCardinality - -LinkTypeSideCardinality - -| **Value** | -| --------- | -| `"ONE"` | -| `"MANY"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinkTypeSideDict.md b/docs/v2/models/LinkTypeSideDict.md deleted file mode 100644 index 9a6eff0e..00000000 --- a/docs/v2/models/LinkTypeSideDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# LinkTypeSideDict - -LinkTypeSide - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | LinkTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**cardinality** | LinkTypeSideCardinality | Yes | | -**foreignKeyPropertyApiName** | NotRequired[PropertyApiName] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinkTypeSideV2.md b/docs/v2/models/LinkTypeSideV2.md deleted file mode 100644 index 21d92a0e..00000000 --- a/docs/v2/models/LinkTypeSideV2.md +++ /dev/null @@ -1,17 +0,0 @@ -# LinkTypeSideV2 - -LinkTypeSideV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | LinkTypeApiName | Yes | | -**display_name** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**object_type_api_name** | ObjectTypeApiName | Yes | | -**cardinality** | LinkTypeSideCardinality | Yes | | -**foreign_key_property_api_name** | Optional[PropertyApiName] | No | | -**link_type_rid** | LinkTypeRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinkTypeSideV2Dict.md b/docs/v2/models/LinkTypeSideV2Dict.md deleted file mode 100644 index 6f82cba9..00000000 --- a/docs/v2/models/LinkTypeSideV2Dict.md +++ /dev/null @@ -1,17 +0,0 @@ -# LinkTypeSideV2Dict - -LinkTypeSideV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | LinkTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**cardinality** | LinkTypeSideCardinality | Yes | | -**foreignKeyPropertyApiName** | NotRequired[PropertyApiName] | No | | -**linkTypeRid** | LinkTypeRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinkedInterfaceTypeApiName.md b/docs/v2/models/LinkedInterfaceTypeApiName.md deleted file mode 100644 index 14e61012..00000000 --- a/docs/v2/models/LinkedInterfaceTypeApiName.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedInterfaceTypeApiName - -A reference to the linked interface type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | InterfaceTypeApiName | Yes | | -**type** | Literal["interfaceTypeApiName"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinkedInterfaceTypeApiNameDict.md b/docs/v2/models/LinkedInterfaceTypeApiNameDict.md deleted file mode 100644 index 595c61b0..00000000 --- a/docs/v2/models/LinkedInterfaceTypeApiNameDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedInterfaceTypeApiNameDict - -A reference to the linked interface type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | InterfaceTypeApiName | Yes | | -**type** | Literal["interfaceTypeApiName"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinkedObjectTypeApiName.md b/docs/v2/models/LinkedObjectTypeApiName.md deleted file mode 100644 index c94f308e..00000000 --- a/docs/v2/models/LinkedObjectTypeApiName.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedObjectTypeApiName - -A reference to the linked object type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | ObjectTypeApiName | Yes | | -**type** | Literal["objectTypeApiName"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LinkedObjectTypeApiNameDict.md b/docs/v2/models/LinkedObjectTypeApiNameDict.md deleted file mode 100644 index d1f03c70..00000000 --- a/docs/v2/models/LinkedObjectTypeApiNameDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# LinkedObjectTypeApiNameDict - -A reference to the linked object type. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ObjectTypeApiName | Yes | | -**type** | Literal["objectTypeApiName"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListActionTypesResponse.md b/docs/v2/models/ListActionTypesResponse.md deleted file mode 100644 index 5fed4e0e..00000000 --- a/docs/v2/models/ListActionTypesResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListActionTypesResponse - -ListActionTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[ActionType] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListActionTypesResponseDict.md b/docs/v2/models/ListActionTypesResponseDict.md deleted file mode 100644 index 5ee89cd3..00000000 --- a/docs/v2/models/ListActionTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListActionTypesResponseDict - -ListActionTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[ActionTypeDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListActionTypesResponseV2.md b/docs/v2/models/ListActionTypesResponseV2.md deleted file mode 100644 index 44fb02f6..00000000 --- a/docs/v2/models/ListActionTypesResponseV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListActionTypesResponseV2 - -ListActionTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[ActionTypeV2] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListActionTypesResponseV2Dict.md b/docs/v2/models/ListActionTypesResponseV2Dict.md deleted file mode 100644 index 155eb68a..00000000 --- a/docs/v2/models/ListActionTypesResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListActionTypesResponseV2Dict - -ListActionTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[ActionTypeV2Dict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListAttachmentsResponseV2.md b/docs/v2/models/ListAttachmentsResponseV2.md deleted file mode 100644 index 501c350f..00000000 --- a/docs/v2/models/ListAttachmentsResponseV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListAttachmentsResponseV2 - -ListAttachmentsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[AttachmentV2] | Yes | | -**next_page_token** | Optional[PageToken] | No | | -**type** | Literal["multiple"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListAttachmentsResponseV2Dict.md b/docs/v2/models/ListAttachmentsResponseV2Dict.md deleted file mode 100644 index e067c740..00000000 --- a/docs/v2/models/ListAttachmentsResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListAttachmentsResponseV2Dict - -ListAttachmentsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[AttachmentV2Dict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | -**type** | Literal["multiple"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListBranchesResponse.md b/docs/v2/models/ListBranchesResponse.md deleted file mode 100644 index d7cd403f..00000000 --- a/docs/v2/models/ListBranchesResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListBranchesResponse - -ListBranchesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[Branch] | Yes | | -**next_page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListBranchesResponseDict.md b/docs/v2/models/ListBranchesResponseDict.md deleted file mode 100644 index 4414311b..00000000 --- a/docs/v2/models/ListBranchesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListBranchesResponseDict - -ListBranchesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[BranchDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListFilesResponse.md b/docs/v2/models/ListFilesResponse.md deleted file mode 100644 index 7287eaf4..00000000 --- a/docs/v2/models/ListFilesResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListFilesResponse - -ListFilesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[File] | Yes | | -**next_page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListFilesResponseDict.md b/docs/v2/models/ListFilesResponseDict.md deleted file mode 100644 index cee69fb1..00000000 --- a/docs/v2/models/ListFilesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListFilesResponseDict - -ListFilesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[FileDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListGroupMembersResponse.md b/docs/v2/models/ListGroupMembersResponse.md deleted file mode 100644 index fbfeb1d7..00000000 --- a/docs/v2/models/ListGroupMembersResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListGroupMembersResponse - -ListGroupMembersResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[GroupMember] | Yes | | -**next_page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListGroupMembersResponseDict.md b/docs/v2/models/ListGroupMembersResponseDict.md deleted file mode 100644 index a69851b4..00000000 --- a/docs/v2/models/ListGroupMembersResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListGroupMembersResponseDict - -ListGroupMembersResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[GroupMemberDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListGroupMembershipsResponse.md b/docs/v2/models/ListGroupMembershipsResponse.md deleted file mode 100644 index ac692c5b..00000000 --- a/docs/v2/models/ListGroupMembershipsResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListGroupMembershipsResponse - -ListGroupMembershipsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[GroupMembership] | Yes | | -**next_page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListGroupMembershipsResponseDict.md b/docs/v2/models/ListGroupMembershipsResponseDict.md deleted file mode 100644 index 6649d459..00000000 --- a/docs/v2/models/ListGroupMembershipsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListGroupMembershipsResponseDict - -ListGroupMembershipsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[GroupMembershipDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListGroupsResponse.md b/docs/v2/models/ListGroupsResponse.md deleted file mode 100644 index 05f9b399..00000000 --- a/docs/v2/models/ListGroupsResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListGroupsResponse - -ListGroupsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[Group] | Yes | | -**next_page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListGroupsResponseDict.md b/docs/v2/models/ListGroupsResponseDict.md deleted file mode 100644 index 0fbd0cc5..00000000 --- a/docs/v2/models/ListGroupsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListGroupsResponseDict - -ListGroupsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[GroupDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListInterfaceTypesResponse.md b/docs/v2/models/ListInterfaceTypesResponse.md deleted file mode 100644 index d16c2939..00000000 --- a/docs/v2/models/ListInterfaceTypesResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListInterfaceTypesResponse - -ListInterfaceTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[InterfaceType] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListInterfaceTypesResponseDict.md b/docs/v2/models/ListInterfaceTypesResponseDict.md deleted file mode 100644 index eed7b728..00000000 --- a/docs/v2/models/ListInterfaceTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListInterfaceTypesResponseDict - -ListInterfaceTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[InterfaceTypeDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListLinkedObjectsResponse.md b/docs/v2/models/ListLinkedObjectsResponse.md deleted file mode 100644 index 347a2690..00000000 --- a/docs/v2/models/ListLinkedObjectsResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListLinkedObjectsResponse - -ListLinkedObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[OntologyObject] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListLinkedObjectsResponseDict.md b/docs/v2/models/ListLinkedObjectsResponseDict.md deleted file mode 100644 index c410a7a1..00000000 --- a/docs/v2/models/ListLinkedObjectsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListLinkedObjectsResponseDict - -ListLinkedObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[OntologyObjectDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListLinkedObjectsResponseV2.md b/docs/v2/models/ListLinkedObjectsResponseV2.md deleted file mode 100644 index 94d1e2e8..00000000 --- a/docs/v2/models/ListLinkedObjectsResponseV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListLinkedObjectsResponseV2 - -ListLinkedObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | | -**next_page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListLinkedObjectsResponseV2Dict.md b/docs/v2/models/ListLinkedObjectsResponseV2Dict.md deleted file mode 100644 index eeea87e5..00000000 --- a/docs/v2/models/ListLinkedObjectsResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListLinkedObjectsResponseV2Dict - -ListLinkedObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListObjectTypesResponse.md b/docs/v2/models/ListObjectTypesResponse.md deleted file mode 100644 index 776ef4f5..00000000 --- a/docs/v2/models/ListObjectTypesResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListObjectTypesResponse - -ListObjectTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[ObjectType] | Yes | The list of object types in the current page. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListObjectTypesResponseDict.md b/docs/v2/models/ListObjectTypesResponseDict.md deleted file mode 100644 index 0e04b391..00000000 --- a/docs/v2/models/ListObjectTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListObjectTypesResponseDict - -ListObjectTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[ObjectTypeDict] | Yes | The list of object types in the current page. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListObjectTypesV2Response.md b/docs/v2/models/ListObjectTypesV2Response.md deleted file mode 100644 index 0e125f2e..00000000 --- a/docs/v2/models/ListObjectTypesV2Response.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListObjectTypesV2Response - -ListObjectTypesV2Response - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[ObjectTypeV2] | Yes | The list of object types in the current page. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListObjectTypesV2ResponseDict.md b/docs/v2/models/ListObjectTypesV2ResponseDict.md deleted file mode 100644 index cfe050d7..00000000 --- a/docs/v2/models/ListObjectTypesV2ResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListObjectTypesV2ResponseDict - -ListObjectTypesV2Response - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[ObjectTypeV2Dict] | Yes | The list of object types in the current page. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListObjectsResponse.md b/docs/v2/models/ListObjectsResponse.md deleted file mode 100644 index 267a85af..00000000 --- a/docs/v2/models/ListObjectsResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListObjectsResponse - -ListObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[OntologyObject] | Yes | The list of objects in the current page. | -**total_count** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListObjectsResponseDict.md b/docs/v2/models/ListObjectsResponseDict.md deleted file mode 100644 index bcfd12e7..00000000 --- a/docs/v2/models/ListObjectsResponseDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListObjectsResponseDict - -ListObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[OntologyObjectDict] | Yes | The list of objects in the current page. | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListObjectsResponseV2.md b/docs/v2/models/ListObjectsResponseV2.md deleted file mode 100644 index 66c197d9..00000000 --- a/docs/v2/models/ListObjectsResponseV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListObjectsResponseV2 - -ListObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[OntologyObjectV2] | Yes | The list of objects in the current page. | -**total_count** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListObjectsResponseV2Dict.md b/docs/v2/models/ListObjectsResponseV2Dict.md deleted file mode 100644 index 3d5cce70..00000000 --- a/docs/v2/models/ListObjectsResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ListObjectsResponseV2Dict - -ListObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[OntologyObjectV2] | Yes | The list of objects in the current page. | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListOntologiesResponse.md b/docs/v2/models/ListOntologiesResponse.md deleted file mode 100644 index 4f6bbb13..00000000 --- a/docs/v2/models/ListOntologiesResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListOntologiesResponse - -ListOntologiesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[Ontology] | Yes | The list of Ontologies the user has access to. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListOntologiesResponseDict.md b/docs/v2/models/ListOntologiesResponseDict.md deleted file mode 100644 index 343cec2d..00000000 --- a/docs/v2/models/ListOntologiesResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListOntologiesResponseDict - -ListOntologiesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyDict] | Yes | The list of Ontologies the user has access to. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListOntologiesV2Response.md b/docs/v2/models/ListOntologiesV2Response.md deleted file mode 100644 index 5ff5315d..00000000 --- a/docs/v2/models/ListOntologiesV2Response.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListOntologiesV2Response - -ListOntologiesV2Response - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyV2] | Yes | The list of Ontologies the user has access to. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListOntologiesV2ResponseDict.md b/docs/v2/models/ListOntologiesV2ResponseDict.md deleted file mode 100644 index 07078a34..00000000 --- a/docs/v2/models/ListOntologiesV2ResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ListOntologiesV2ResponseDict - -ListOntologiesV2Response - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyV2Dict] | Yes | The list of Ontologies the user has access to. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListOutgoingLinkTypesResponse.md b/docs/v2/models/ListOutgoingLinkTypesResponse.md deleted file mode 100644 index 8ff59e0c..00000000 --- a/docs/v2/models/ListOutgoingLinkTypesResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListOutgoingLinkTypesResponse - -ListOutgoingLinkTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[LinkTypeSide] | Yes | The list of link type sides in the current page. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListOutgoingLinkTypesResponseDict.md b/docs/v2/models/ListOutgoingLinkTypesResponseDict.md deleted file mode 100644 index 73099d9e..00000000 --- a/docs/v2/models/ListOutgoingLinkTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListOutgoingLinkTypesResponseDict - -ListOutgoingLinkTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[LinkTypeSideDict] | Yes | The list of link type sides in the current page. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListOutgoingLinkTypesResponseV2.md b/docs/v2/models/ListOutgoingLinkTypesResponseV2.md deleted file mode 100644 index 520f4fcf..00000000 --- a/docs/v2/models/ListOutgoingLinkTypesResponseV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListOutgoingLinkTypesResponseV2 - -ListOutgoingLinkTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[LinkTypeSideV2] | Yes | The list of link type sides in the current page. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListOutgoingLinkTypesResponseV2Dict.md b/docs/v2/models/ListOutgoingLinkTypesResponseV2Dict.md deleted file mode 100644 index d4a725c7..00000000 --- a/docs/v2/models/ListOutgoingLinkTypesResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListOutgoingLinkTypesResponseV2Dict - -ListOutgoingLinkTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[LinkTypeSideV2Dict] | Yes | The list of link type sides in the current page. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListQueryTypesResponse.md b/docs/v2/models/ListQueryTypesResponse.md deleted file mode 100644 index aa07a447..00000000 --- a/docs/v2/models/ListQueryTypesResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListQueryTypesResponse - -ListQueryTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[QueryType] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListQueryTypesResponseDict.md b/docs/v2/models/ListQueryTypesResponseDict.md deleted file mode 100644 index 386a6b87..00000000 --- a/docs/v2/models/ListQueryTypesResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListQueryTypesResponseDict - -ListQueryTypesResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[QueryTypeDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListQueryTypesResponseV2.md b/docs/v2/models/ListQueryTypesResponseV2.md deleted file mode 100644 index 2b931fcc..00000000 --- a/docs/v2/models/ListQueryTypesResponseV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListQueryTypesResponseV2 - -ListQueryTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**next_page_token** | Optional[PageToken] | No | | -**data** | List[QueryTypeV2] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListQueryTypesResponseV2Dict.md b/docs/v2/models/ListQueryTypesResponseV2Dict.md deleted file mode 100644 index b0aaab03..00000000 --- a/docs/v2/models/ListQueryTypesResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListQueryTypesResponseV2Dict - -ListQueryTypesResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**nextPageToken** | NotRequired[PageToken] | No | | -**data** | List[QueryTypeV2Dict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListUsersResponse.md b/docs/v2/models/ListUsersResponse.md deleted file mode 100644 index dfdf5293..00000000 --- a/docs/v2/models/ListUsersResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListUsersResponse - -ListUsersResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[User] | Yes | | -**next_page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListUsersResponseDict.md b/docs/v2/models/ListUsersResponseDict.md deleted file mode 100644 index 4c9407c5..00000000 --- a/docs/v2/models/ListUsersResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListUsersResponseDict - -ListUsersResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[UserDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListVersionsResponse.md b/docs/v2/models/ListVersionsResponse.md deleted file mode 100644 index c32dc5b9..00000000 --- a/docs/v2/models/ListVersionsResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListVersionsResponse - -ListVersionsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[Version] | Yes | | -**next_page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ListVersionsResponseDict.md b/docs/v2/models/ListVersionsResponseDict.md deleted file mode 100644 index d2edd6b0..00000000 --- a/docs/v2/models/ListVersionsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ListVersionsResponseDict - -ListVersionsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[VersionDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LoadObjectSetRequestV2.md b/docs/v2/models/LoadObjectSetRequestV2.md deleted file mode 100644 index 280fc81b..00000000 --- a/docs/v2/models/LoadObjectSetRequestV2.md +++ /dev/null @@ -1,16 +0,0 @@ -# LoadObjectSetRequestV2 - -Represents the API POST body when loading an `ObjectSet`. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_set** | ObjectSet | Yes | | -**order_by** | Optional[SearchOrderByV2] | No | | -**select** | List[SelectedPropertyApiName] | Yes | | -**page_token** | Optional[PageToken] | No | | -**page_size** | Optional[PageSize] | No | | -**exclude_rid** | Optional[StrictBool] | No | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LoadObjectSetRequestV2Dict.md b/docs/v2/models/LoadObjectSetRequestV2Dict.md deleted file mode 100644 index a3a92e81..00000000 --- a/docs/v2/models/LoadObjectSetRequestV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# LoadObjectSetRequestV2Dict - -Represents the API POST body when loading an `ObjectSet`. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | -**orderBy** | NotRequired[SearchOrderByV2Dict] | No | | -**select** | List[SelectedPropertyApiName] | Yes | | -**pageToken** | NotRequired[PageToken] | No | | -**pageSize** | NotRequired[PageSize] | No | | -**excludeRid** | NotRequired[StrictBool] | No | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LoadObjectSetResponseV2.md b/docs/v2/models/LoadObjectSetResponseV2.md deleted file mode 100644 index b213d7e5..00000000 --- a/docs/v2/models/LoadObjectSetResponseV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# LoadObjectSetResponseV2 - -Represents the API response when loading an `ObjectSet`. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | The list of objects in the current Page. | -**next_page_token** | Optional[PageToken] | No | | -**total_count** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LoadObjectSetResponseV2Dict.md b/docs/v2/models/LoadObjectSetResponseV2Dict.md deleted file mode 100644 index 2ef7912e..00000000 --- a/docs/v2/models/LoadObjectSetResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LoadObjectSetResponseV2Dict - -Represents the API response when loading an `ObjectSet`. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | The list of objects in the current Page. | -**nextPageToken** | NotRequired[PageToken] | No | | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LocalFilePath.md b/docs/v2/models/LocalFilePath.md deleted file mode 100644 index 7baffc6e..00000000 --- a/docs/v2/models/LocalFilePath.md +++ /dev/null @@ -1,10 +0,0 @@ -# LocalFilePath - -LocalFilePath - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LocalFilePathDict.md b/docs/v2/models/LocalFilePathDict.md deleted file mode 100644 index 8b0c3e66..00000000 --- a/docs/v2/models/LocalFilePathDict.md +++ /dev/null @@ -1,10 +0,0 @@ -# LocalFilePathDict - -LocalFilePath - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LogicRule.md b/docs/v2/models/LogicRule.md deleted file mode 100644 index 36f09cb0..00000000 --- a/docs/v2/models/LogicRule.md +++ /dev/null @@ -1,19 +0,0 @@ -# LogicRule - -LogicRule - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[CreateObjectRule](CreateObjectRule.md) | createObject -[ModifyObjectRule](ModifyObjectRule.md) | modifyObject -[DeleteObjectRule](DeleteObjectRule.md) | deleteObject -[CreateLinkRule](CreateLinkRule.md) | createLink -[DeleteLinkRule](DeleteLinkRule.md) | deleteLink - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LogicRuleDict.md b/docs/v2/models/LogicRuleDict.md deleted file mode 100644 index 0812fe46..00000000 --- a/docs/v2/models/LogicRuleDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# LogicRuleDict - -LogicRule - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[CreateObjectRuleDict](CreateObjectRuleDict.md) | createObject -[ModifyObjectRuleDict](ModifyObjectRuleDict.md) | modifyObject -[DeleteObjectRuleDict](DeleteObjectRuleDict.md) | deleteObject -[CreateLinkRuleDict](CreateLinkRuleDict.md) | createLink -[DeleteLinkRuleDict](DeleteLinkRuleDict.md) | deleteLink - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LongType.md b/docs/v2/models/LongType.md deleted file mode 100644 index 4051bda4..00000000 --- a/docs/v2/models/LongType.md +++ /dev/null @@ -1,11 +0,0 @@ -# LongType - -LongType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["long"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LongTypeDict.md b/docs/v2/models/LongTypeDict.md deleted file mode 100644 index 6da1ba20..00000000 --- a/docs/v2/models/LongTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# LongTypeDict - -LongType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["long"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LtQuery.md b/docs/v2/models/LtQuery.md deleted file mode 100644 index 5982572f..00000000 --- a/docs/v2/models/LtQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# LtQuery - -Returns objects where the specified field is less than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LtQueryDict.md b/docs/v2/models/LtQueryDict.md deleted file mode 100644 index b37cfa6e..00000000 --- a/docs/v2/models/LtQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LtQueryDict - -Returns objects where the specified field is less than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LtQueryV2.md b/docs/v2/models/LtQueryV2.md deleted file mode 100644 index ebbd0fd5..00000000 --- a/docs/v2/models/LtQueryV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# LtQueryV2 - -Returns objects where the specified field is less than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LtQueryV2Dict.md b/docs/v2/models/LtQueryV2Dict.md deleted file mode 100644 index 0a858bfd..00000000 --- a/docs/v2/models/LtQueryV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LtQueryV2Dict - -Returns objects where the specified field is less than a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lt"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LteQuery.md b/docs/v2/models/LteQuery.md deleted file mode 100644 index a5a8001d..00000000 --- a/docs/v2/models/LteQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# LteQuery - -Returns objects where the specified field is less than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LteQueryDict.md b/docs/v2/models/LteQueryDict.md deleted file mode 100644 index 13f5dfe6..00000000 --- a/docs/v2/models/LteQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LteQueryDict - -Returns objects where the specified field is less than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LteQueryV2.md b/docs/v2/models/LteQueryV2.md deleted file mode 100644 index 12bd773b..00000000 --- a/docs/v2/models/LteQueryV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# LteQueryV2 - -Returns objects where the specified field is less than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/LteQueryV2Dict.md b/docs/v2/models/LteQueryV2Dict.md deleted file mode 100644 index e0f18fe3..00000000 --- a/docs/v2/models/LteQueryV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# LteQueryV2Dict - -Returns objects where the specified field is less than or equal to a value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PropertyValue | Yes | | -**type** | Literal["lte"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ManualTarget.md b/docs/v2/models/ManualTarget.md deleted file mode 100644 index 4392cc51..00000000 --- a/docs/v2/models/ManualTarget.md +++ /dev/null @@ -1,12 +0,0 @@ -# ManualTarget - -Manually specify all datasets to build. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**dataset_rids** | List[DatasetRid] | Yes | | -**type** | Literal["manual"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ManualTargetDict.md b/docs/v2/models/ManualTargetDict.md deleted file mode 100644 index 8a3cf36c..00000000 --- a/docs/v2/models/ManualTargetDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ManualTargetDict - -Manually specify all datasets to build. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**datasetRids** | List[DatasetRid] | Yes | | -**type** | Literal["manual"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MarkingType.md b/docs/v2/models/MarkingType.md deleted file mode 100644 index fa19d5b5..00000000 --- a/docs/v2/models/MarkingType.md +++ /dev/null @@ -1,11 +0,0 @@ -# MarkingType - -MarkingType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["marking"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MarkingTypeDict.md b/docs/v2/models/MarkingTypeDict.md deleted file mode 100644 index 80f466a7..00000000 --- a/docs/v2/models/MarkingTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# MarkingTypeDict - -MarkingType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["marking"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MaxAggregation.md b/docs/v2/models/MaxAggregation.md deleted file mode 100644 index d763b5fb..00000000 --- a/docs/v2/models/MaxAggregation.md +++ /dev/null @@ -1,13 +0,0 @@ -# MaxAggregation - -Computes the maximum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**type** | Literal["max"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MaxAggregationDict.md b/docs/v2/models/MaxAggregationDict.md deleted file mode 100644 index beb03a0b..00000000 --- a/docs/v2/models/MaxAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MaxAggregationDict - -Computes the maximum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["max"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MaxAggregationV2.md b/docs/v2/models/MaxAggregationV2.md deleted file mode 100644 index ef3a3413..00000000 --- a/docs/v2/models/MaxAggregationV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# MaxAggregationV2 - -Computes the maximum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["max"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MaxAggregationV2Dict.md b/docs/v2/models/MaxAggregationV2Dict.md deleted file mode 100644 index 9af75c57..00000000 --- a/docs/v2/models/MaxAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# MaxAggregationV2Dict - -Computes the maximum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["max"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MediaSetRid.md b/docs/v2/models/MediaSetRid.md deleted file mode 100644 index 1c2c6c4c..00000000 --- a/docs/v2/models/MediaSetRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# MediaSetRid - -The Resource Identifier (RID) of a Media Set - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MediaType.md b/docs/v2/models/MediaType.md deleted file mode 100644 index 331f199a..00000000 --- a/docs/v2/models/MediaType.md +++ /dev/null @@ -1,13 +0,0 @@ -# MediaType - -The [media type](https://www.iana.org/assignments/media-types/media-types.xhtml) of the file or attachment. -Examples: `application/json`, `application/pdf`, `application/octet-stream`, `image/jpeg` - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MinAggregation.md b/docs/v2/models/MinAggregation.md deleted file mode 100644 index 67edb724..00000000 --- a/docs/v2/models/MinAggregation.md +++ /dev/null @@ -1,13 +0,0 @@ -# MinAggregation - -Computes the minimum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**type** | Literal["min"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MinAggregationDict.md b/docs/v2/models/MinAggregationDict.md deleted file mode 100644 index a519b2ed..00000000 --- a/docs/v2/models/MinAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MinAggregationDict - -Computes the minimum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["min"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MinAggregationV2.md b/docs/v2/models/MinAggregationV2.md deleted file mode 100644 index 9ce6da6b..00000000 --- a/docs/v2/models/MinAggregationV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# MinAggregationV2 - -Computes the minimum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["min"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MinAggregationV2Dict.md b/docs/v2/models/MinAggregationV2Dict.md deleted file mode 100644 index c375d0fb..00000000 --- a/docs/v2/models/MinAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# MinAggregationV2Dict - -Computes the minimum value for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["min"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ModifyObject.md b/docs/v2/models/ModifyObject.md deleted file mode 100644 index b6ee757f..00000000 --- a/docs/v2/models/ModifyObject.md +++ /dev/null @@ -1,13 +0,0 @@ -# ModifyObject - -ModifyObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primary_key** | PropertyValue | Yes | | -**object_type** | ObjectTypeApiName | Yes | | -**type** | Literal["modifyObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ModifyObjectDict.md b/docs/v2/models/ModifyObjectDict.md deleted file mode 100644 index 6c48f53c..00000000 --- a/docs/v2/models/ModifyObjectDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ModifyObjectDict - -ModifyObject - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**primaryKey** | PropertyValue | Yes | | -**objectType** | ObjectTypeApiName | Yes | | -**type** | Literal["modifyObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ModifyObjectRule.md b/docs/v2/models/ModifyObjectRule.md deleted file mode 100644 index 63b11e79..00000000 --- a/docs/v2/models/ModifyObjectRule.md +++ /dev/null @@ -1,12 +0,0 @@ -# ModifyObjectRule - -ModifyObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_type_api_name** | ObjectTypeApiName | Yes | | -**type** | Literal["modifyObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ModifyObjectRuleDict.md b/docs/v2/models/ModifyObjectRuleDict.md deleted file mode 100644 index f5797375..00000000 --- a/docs/v2/models/ModifyObjectRuleDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ModifyObjectRuleDict - -ModifyObjectRule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["modifyObject"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MultiLineString.md b/docs/v2/models/MultiLineString.md deleted file mode 100644 index fd9dd048..00000000 --- a/docs/v2/models/MultiLineString.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiLineString - -MultiLineString - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[LineStringCoordinates] | Yes | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["MultiLineString"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MultiLineStringDict.md b/docs/v2/models/MultiLineStringDict.md deleted file mode 100644 index e4e69c7b..00000000 --- a/docs/v2/models/MultiLineStringDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiLineStringDict - -MultiLineString - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[LineStringCoordinates] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["MultiLineString"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MultiPoint.md b/docs/v2/models/MultiPoint.md deleted file mode 100644 index c6a70516..00000000 --- a/docs/v2/models/MultiPoint.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiPoint - -MultiPoint - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[Position] | Yes | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["MultiPoint"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MultiPointDict.md b/docs/v2/models/MultiPointDict.md deleted file mode 100644 index 49e02241..00000000 --- a/docs/v2/models/MultiPointDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiPointDict - -MultiPoint - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[Position] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["MultiPoint"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MultiPolygon.md b/docs/v2/models/MultiPolygon.md deleted file mode 100644 index 693165e5..00000000 --- a/docs/v2/models/MultiPolygon.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiPolygon - -MultiPolygon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[List[LinearRing]] | Yes | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["MultiPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/MultiPolygonDict.md b/docs/v2/models/MultiPolygonDict.md deleted file mode 100644 index d7a54329..00000000 --- a/docs/v2/models/MultiPolygonDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# MultiPolygonDict - -MultiPolygon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[List[LinearRing]] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["MultiPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/NestedQueryAggregation.md b/docs/v2/models/NestedQueryAggregation.md deleted file mode 100644 index c0ed5611..00000000 --- a/docs/v2/models/NestedQueryAggregation.md +++ /dev/null @@ -1,12 +0,0 @@ -# NestedQueryAggregation - -NestedQueryAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key** | Any | Yes | | -**groups** | List[QueryAggregation] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/NestedQueryAggregationDict.md b/docs/v2/models/NestedQueryAggregationDict.md deleted file mode 100644 index a9011dcb..00000000 --- a/docs/v2/models/NestedQueryAggregationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# NestedQueryAggregationDict - -NestedQueryAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key** | Any | Yes | | -**groups** | List[QueryAggregationDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/NewLogicTrigger.md b/docs/v2/models/NewLogicTrigger.md deleted file mode 100644 index b258586b..00000000 --- a/docs/v2/models/NewLogicTrigger.md +++ /dev/null @@ -1,15 +0,0 @@ -# NewLogicTrigger - -Trigger whenever a new JobSpec is put on the dataset and on -that branch. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**branch_name** | BranchName | Yes | | -**dataset_rid** | DatasetRid | Yes | | -**type** | Literal["newLogic"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/NewLogicTriggerDict.md b/docs/v2/models/NewLogicTriggerDict.md deleted file mode 100644 index 226f45fe..00000000 --- a/docs/v2/models/NewLogicTriggerDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# NewLogicTriggerDict - -Trigger whenever a new JobSpec is put on the dataset and on -that branch. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**branchName** | BranchName | Yes | | -**datasetRid** | DatasetRid | Yes | | -**type** | Literal["newLogic"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/NotQuery.md b/docs/v2/models/NotQuery.md deleted file mode 100644 index 8a69bfb5..00000000 --- a/docs/v2/models/NotQuery.md +++ /dev/null @@ -1,12 +0,0 @@ -# NotQuery - -Returns objects where the query is not satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | SearchJsonQuery | Yes | | -**type** | Literal["not"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/NotQueryDict.md b/docs/v2/models/NotQueryDict.md deleted file mode 100644 index 675eaca1..00000000 --- a/docs/v2/models/NotQueryDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# NotQueryDict - -Returns objects where the query is not satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | SearchJsonQueryDict | Yes | | -**type** | Literal["not"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/NotQueryV2.md b/docs/v2/models/NotQueryV2.md deleted file mode 100644 index a136e846..00000000 --- a/docs/v2/models/NotQueryV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# NotQueryV2 - -Returns objects where the query is not satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | SearchJsonQueryV2 | Yes | | -**type** | Literal["not"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/NotQueryV2Dict.md b/docs/v2/models/NotQueryV2Dict.md deleted file mode 100644 index 8fa23e14..00000000 --- a/docs/v2/models/NotQueryV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# NotQueryV2Dict - -Returns objects where the query is not satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | SearchJsonQueryV2Dict | Yes | | -**type** | Literal["not"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/NotificationsEnabled.md b/docs/v2/models/NotificationsEnabled.md deleted file mode 100644 index 85e3e6f3..00000000 --- a/docs/v2/models/NotificationsEnabled.md +++ /dev/null @@ -1,11 +0,0 @@ -# NotificationsEnabled - -Whether to receive a notification at the end of scheduled builds. - -## Type -```python -StrictBool -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/NullType.md b/docs/v2/models/NullType.md deleted file mode 100644 index 30833e74..00000000 --- a/docs/v2/models/NullType.md +++ /dev/null @@ -1,11 +0,0 @@ -# NullType - -NullType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["null"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/NullTypeDict.md b/docs/v2/models/NullTypeDict.md deleted file mode 100644 index 03156949..00000000 --- a/docs/v2/models/NullTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# NullTypeDict - -NullType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["null"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectEdit.md b/docs/v2/models/ObjectEdit.md deleted file mode 100644 index 6590c5d1..00000000 --- a/docs/v2/models/ObjectEdit.md +++ /dev/null @@ -1,17 +0,0 @@ -# ObjectEdit - -ObjectEdit - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AddObject](AddObject.md) | addObject -[ModifyObject](ModifyObject.md) | modifyObject -[AddLink](AddLink.md) | addLink - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectEditDict.md b/docs/v2/models/ObjectEditDict.md deleted file mode 100644 index bb39479c..00000000 --- a/docs/v2/models/ObjectEditDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ObjectEditDict - -ObjectEdit - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AddObjectDict](AddObjectDict.md) | addObject -[ModifyObjectDict](ModifyObjectDict.md) | modifyObject -[AddLinkDict](AddLinkDict.md) | addLink - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectEdits.md b/docs/v2/models/ObjectEdits.md deleted file mode 100644 index d051d67b..00000000 --- a/docs/v2/models/ObjectEdits.md +++ /dev/null @@ -1,17 +0,0 @@ -# ObjectEdits - -ObjectEdits - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**edits** | List[ObjectEdit] | Yes | | -**added_object_count** | StrictInt | Yes | | -**modified_objects_count** | StrictInt | Yes | | -**deleted_objects_count** | StrictInt | Yes | | -**added_links_count** | StrictInt | Yes | | -**deleted_links_count** | StrictInt | Yes | | -**type** | Literal["edits"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectEditsDict.md b/docs/v2/models/ObjectEditsDict.md deleted file mode 100644 index 6bfb55fe..00000000 --- a/docs/v2/models/ObjectEditsDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ObjectEditsDict - -ObjectEdits - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**edits** | List[ObjectEditDict] | Yes | | -**addedObjectCount** | StrictInt | Yes | | -**modifiedObjectsCount** | StrictInt | Yes | | -**deletedObjectsCount** | StrictInt | Yes | | -**addedLinksCount** | StrictInt | Yes | | -**deletedLinksCount** | StrictInt | Yes | | -**type** | Literal["edits"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectPrimaryKey.md b/docs/v2/models/ObjectPrimaryKey.md deleted file mode 100644 index 1425f7da..00000000 --- a/docs/v2/models/ObjectPrimaryKey.md +++ /dev/null @@ -1,11 +0,0 @@ -# ObjectPrimaryKey - -ObjectPrimaryKey - -## Type -```python -Dict[PropertyApiName, PropertyValue] -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectPropertyType.md b/docs/v2/models/ObjectPropertyType.md deleted file mode 100644 index 897cc7b6..00000000 --- a/docs/v2/models/ObjectPropertyType.md +++ /dev/null @@ -1,32 +0,0 @@ -# ObjectPropertyType - -A union of all the types supported by Ontology Object properties. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[OntologyObjectArrayType](OntologyObjectArrayType.md) | array -[AttachmentType](AttachmentType.md) | attachment -[BooleanType](BooleanType.md) | boolean -[ByteType](ByteType.md) | byte -[DateType](DateType.md) | date -[DecimalType](DecimalType.md) | decimal -[DoubleType](DoubleType.md) | double -[FloatType](FloatType.md) | float -[GeoPointType](GeoPointType.md) | geopoint -[GeoShapeType](GeoShapeType.md) | geoshape -[IntegerType](IntegerType.md) | integer -[LongType](LongType.md) | long -[MarkingType](MarkingType.md) | marking -[ShortType](ShortType.md) | short -[StringType](StringType.md) | string -[TimestampType](TimestampType.md) | timestamp -[TimeseriesType](TimeseriesType.md) | timeseries - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectPropertyTypeDict.md b/docs/v2/models/ObjectPropertyTypeDict.md deleted file mode 100644 index 6ccb5e7f..00000000 --- a/docs/v2/models/ObjectPropertyTypeDict.md +++ /dev/null @@ -1,32 +0,0 @@ -# ObjectPropertyTypeDict - -A union of all the types supported by Ontology Object properties. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[OntologyObjectArrayTypeDict](OntologyObjectArrayTypeDict.md) | array -[AttachmentTypeDict](AttachmentTypeDict.md) | attachment -[BooleanTypeDict](BooleanTypeDict.md) | boolean -[ByteTypeDict](ByteTypeDict.md) | byte -[DateTypeDict](DateTypeDict.md) | date -[DecimalTypeDict](DecimalTypeDict.md) | decimal -[DoubleTypeDict](DoubleTypeDict.md) | double -[FloatTypeDict](FloatTypeDict.md) | float -[GeoPointTypeDict](GeoPointTypeDict.md) | geopoint -[GeoShapeTypeDict](GeoShapeTypeDict.md) | geoshape -[IntegerTypeDict](IntegerTypeDict.md) | integer -[LongTypeDict](LongTypeDict.md) | long -[MarkingTypeDict](MarkingTypeDict.md) | marking -[ShortTypeDict](ShortTypeDict.md) | short -[StringTypeDict](StringTypeDict.md) | string -[TimestampTypeDict](TimestampTypeDict.md) | timestamp -[TimeseriesTypeDict](TimeseriesTypeDict.md) | timeseries - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectPropertyValueConstraint.md b/docs/v2/models/ObjectPropertyValueConstraint.md deleted file mode 100644 index a9b354e7..00000000 --- a/docs/v2/models/ObjectPropertyValueConstraint.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectPropertyValueConstraint - -The parameter value must be a property value of an object found within an object set. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["objectPropertyValue"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectPropertyValueConstraintDict.md b/docs/v2/models/ObjectPropertyValueConstraintDict.md deleted file mode 100644 index 4f72f575..00000000 --- a/docs/v2/models/ObjectPropertyValueConstraintDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectPropertyValueConstraintDict - -The parameter value must be a property value of an object found within an object set. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["objectPropertyValue"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectQueryResultConstraint.md b/docs/v2/models/ObjectQueryResultConstraint.md deleted file mode 100644 index cfb8e1f6..00000000 --- a/docs/v2/models/ObjectQueryResultConstraint.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectQueryResultConstraint - -The parameter value must be the primary key of an object found within an object set. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["objectQueryResult"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectQueryResultConstraintDict.md b/docs/v2/models/ObjectQueryResultConstraintDict.md deleted file mode 100644 index e474aed4..00000000 --- a/docs/v2/models/ObjectQueryResultConstraintDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectQueryResultConstraintDict - -The parameter value must be the primary key of an object found within an object set. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["objectQueryResult"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectRid.md b/docs/v2/models/ObjectRid.md deleted file mode 100644 index 572662ef..00000000 --- a/docs/v2/models/ObjectRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectRid - -The unique resource identifier of an object, useful for interacting with other Foundry APIs. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSet.md b/docs/v2/models/ObjectSet.md deleted file mode 100644 index b107ba3a..00000000 --- a/docs/v2/models/ObjectSet.md +++ /dev/null @@ -1,22 +0,0 @@ -# ObjectSet - -Represents the definition of an `ObjectSet` in the `Ontology`. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectSetBaseType](ObjectSetBaseType.md) | base -[ObjectSetStaticType](ObjectSetStaticType.md) | static -[ObjectSetReferenceType](ObjectSetReferenceType.md) | reference -[ObjectSetFilterType](ObjectSetFilterType.md) | filter -[ObjectSetUnionType](ObjectSetUnionType.md) | union -[ObjectSetIntersectionType](ObjectSetIntersectionType.md) | intersect -[ObjectSetSubtractType](ObjectSetSubtractType.md) | subtract -[ObjectSetSearchAroundType](ObjectSetSearchAroundType.md) | searchAround - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetBaseType.md b/docs/v2/models/ObjectSetBaseType.md deleted file mode 100644 index 9777270f..00000000 --- a/docs/v2/models/ObjectSetBaseType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetBaseType - -ObjectSetBaseType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_type** | StrictStr | Yes | | -**type** | Literal["base"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetBaseTypeDict.md b/docs/v2/models/ObjectSetBaseTypeDict.md deleted file mode 100644 index b7cd8e24..00000000 --- a/docs/v2/models/ObjectSetBaseTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetBaseTypeDict - -ObjectSetBaseType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectType** | StrictStr | Yes | | -**type** | Literal["base"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetDict.md b/docs/v2/models/ObjectSetDict.md deleted file mode 100644 index 689b02c1..00000000 --- a/docs/v2/models/ObjectSetDict.md +++ /dev/null @@ -1,22 +0,0 @@ -# ObjectSetDict - -Represents the definition of an `ObjectSet` in the `Ontology`. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectSetBaseTypeDict](ObjectSetBaseTypeDict.md) | base -[ObjectSetStaticTypeDict](ObjectSetStaticTypeDict.md) | static -[ObjectSetReferenceTypeDict](ObjectSetReferenceTypeDict.md) | reference -[ObjectSetFilterTypeDict](ObjectSetFilterTypeDict.md) | filter -[ObjectSetUnionTypeDict](ObjectSetUnionTypeDict.md) | union -[ObjectSetIntersectionTypeDict](ObjectSetIntersectionTypeDict.md) | intersect -[ObjectSetSubtractTypeDict](ObjectSetSubtractTypeDict.md) | subtract -[ObjectSetSearchAroundTypeDict](ObjectSetSearchAroundTypeDict.md) | searchAround - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetFilterType.md b/docs/v2/models/ObjectSetFilterType.md deleted file mode 100644 index 47b5474b..00000000 --- a/docs/v2/models/ObjectSetFilterType.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetFilterType - -ObjectSetFilterType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_set** | ObjectSet | Yes | | -**where** | SearchJsonQueryV2 | Yes | | -**type** | Literal["filter"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetFilterTypeDict.md b/docs/v2/models/ObjectSetFilterTypeDict.md deleted file mode 100644 index 4885e8b2..00000000 --- a/docs/v2/models/ObjectSetFilterTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetFilterTypeDict - -ObjectSetFilterType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | -**where** | SearchJsonQueryV2Dict | Yes | | -**type** | Literal["filter"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetIntersectionType.md b/docs/v2/models/ObjectSetIntersectionType.md deleted file mode 100644 index 11e16ee3..00000000 --- a/docs/v2/models/ObjectSetIntersectionType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetIntersectionType - -ObjectSetIntersectionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_sets** | List[ObjectSet] | Yes | | -**type** | Literal["intersect"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetIntersectionTypeDict.md b/docs/v2/models/ObjectSetIntersectionTypeDict.md deleted file mode 100644 index bc6a18a3..00000000 --- a/docs/v2/models/ObjectSetIntersectionTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetIntersectionTypeDict - -ObjectSetIntersectionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSets** | List[ObjectSetDict] | Yes | | -**type** | Literal["intersect"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetReferenceType.md b/docs/v2/models/ObjectSetReferenceType.md deleted file mode 100644 index b34461c0..00000000 --- a/docs/v2/models/ObjectSetReferenceType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetReferenceType - -ObjectSetReferenceType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**reference** | RID | Yes | | -**type** | Literal["reference"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetReferenceTypeDict.md b/docs/v2/models/ObjectSetReferenceTypeDict.md deleted file mode 100644 index 81abeea4..00000000 --- a/docs/v2/models/ObjectSetReferenceTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetReferenceTypeDict - -ObjectSetReferenceType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**reference** | RID | Yes | | -**type** | Literal["reference"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetRid.md b/docs/v2/models/ObjectSetRid.md deleted file mode 100644 index a3ecefd2..00000000 --- a/docs/v2/models/ObjectSetRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ObjectSetRid - -ObjectSetRid - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetSearchAroundType.md b/docs/v2/models/ObjectSetSearchAroundType.md deleted file mode 100644 index a6d3b2c4..00000000 --- a/docs/v2/models/ObjectSetSearchAroundType.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetSearchAroundType - -ObjectSetSearchAroundType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_set** | ObjectSet | Yes | | -**link** | LinkTypeApiName | Yes | | -**type** | Literal["searchAround"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetSearchAroundTypeDict.md b/docs/v2/models/ObjectSetSearchAroundTypeDict.md deleted file mode 100644 index 6f3f5bc6..00000000 --- a/docs/v2/models/ObjectSetSearchAroundTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetSearchAroundTypeDict - -ObjectSetSearchAroundType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | -**link** | LinkTypeApiName | Yes | | -**type** | Literal["searchAround"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetStaticType.md b/docs/v2/models/ObjectSetStaticType.md deleted file mode 100644 index 3a3fd722..00000000 --- a/docs/v2/models/ObjectSetStaticType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetStaticType - -ObjectSetStaticType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objects** | List[ObjectRid] | Yes | | -**type** | Literal["static"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetStaticTypeDict.md b/docs/v2/models/ObjectSetStaticTypeDict.md deleted file mode 100644 index 1bc31f81..00000000 --- a/docs/v2/models/ObjectSetStaticTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetStaticTypeDict - -ObjectSetStaticType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objects** | List[ObjectRid] | Yes | | -**type** | Literal["static"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetStreamSubscribeRequest.md b/docs/v2/models/ObjectSetStreamSubscribeRequest.md deleted file mode 100644 index 8be7d450..00000000 --- a/docs/v2/models/ObjectSetStreamSubscribeRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetStreamSubscribeRequest - -ObjectSetStreamSubscribeRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_set** | ObjectSet | Yes | | -**property_set** | List[SelectedPropertyApiName] | Yes | | -**reference_set** | List[SelectedPropertyApiName] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetStreamSubscribeRequestDict.md b/docs/v2/models/ObjectSetStreamSubscribeRequestDict.md deleted file mode 100644 index dc0f4510..00000000 --- a/docs/v2/models/ObjectSetStreamSubscribeRequestDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetStreamSubscribeRequestDict - -ObjectSetStreamSubscribeRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSet** | ObjectSetDict | Yes | | -**propertySet** | List[SelectedPropertyApiName] | Yes | | -**referenceSet** | List[SelectedPropertyApiName] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetStreamSubscribeRequests.md b/docs/v2/models/ObjectSetStreamSubscribeRequests.md deleted file mode 100644 index b9732763..00000000 --- a/docs/v2/models/ObjectSetStreamSubscribeRequests.md +++ /dev/null @@ -1,14 +0,0 @@ -# ObjectSetStreamSubscribeRequests - -The list of object sets that should be subscribed to. A client can stop subscribing to an object set -by removing the request from subsequent ObjectSetStreamSubscribeRequests. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | RequestId | Yes | | -**requests** | List[ObjectSetStreamSubscribeRequest] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetStreamSubscribeRequestsDict.md b/docs/v2/models/ObjectSetStreamSubscribeRequestsDict.md deleted file mode 100644 index 7a72614b..00000000 --- a/docs/v2/models/ObjectSetStreamSubscribeRequestsDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ObjectSetStreamSubscribeRequestsDict - -The list of object sets that should be subscribed to. A client can stop subscribing to an object set -by removing the request from subsequent ObjectSetStreamSubscribeRequests. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | RequestId | Yes | | -**requests** | List[ObjectSetStreamSubscribeRequestDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetSubscribeResponse.md b/docs/v2/models/ObjectSetSubscribeResponse.md deleted file mode 100644 index 7abcb51f..00000000 --- a/docs/v2/models/ObjectSetSubscribeResponse.md +++ /dev/null @@ -1,17 +0,0 @@ -# ObjectSetSubscribeResponse - -ObjectSetSubscribeResponse - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[SubscriptionSuccess](SubscriptionSuccess.md) | success -[SubscriptionError](SubscriptionError.md) | error -[QosError](QosError.md) | qos - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetSubscribeResponseDict.md b/docs/v2/models/ObjectSetSubscribeResponseDict.md deleted file mode 100644 index 7e954c74..00000000 --- a/docs/v2/models/ObjectSetSubscribeResponseDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# ObjectSetSubscribeResponseDict - -ObjectSetSubscribeResponse - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[SubscriptionSuccessDict](SubscriptionSuccessDict.md) | success -[SubscriptionErrorDict](SubscriptionErrorDict.md) | error -[QosErrorDict](QosErrorDict.md) | qos - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetSubscribeResponses.md b/docs/v2/models/ObjectSetSubscribeResponses.md deleted file mode 100644 index 4ce15dcd..00000000 --- a/docs/v2/models/ObjectSetSubscribeResponses.md +++ /dev/null @@ -1,14 +0,0 @@ -# ObjectSetSubscribeResponses - -Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**responses** | List[ObjectSetSubscribeResponse] | Yes | | -**id** | RequestId | Yes | | -**type** | Literal["subscribeResponses"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetSubscribeResponsesDict.md b/docs/v2/models/ObjectSetSubscribeResponsesDict.md deleted file mode 100644 index e083f93d..00000000 --- a/docs/v2/models/ObjectSetSubscribeResponsesDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ObjectSetSubscribeResponsesDict - -Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**responses** | List[ObjectSetSubscribeResponseDict] | Yes | | -**id** | RequestId | Yes | | -**type** | Literal["subscribeResponses"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetSubtractType.md b/docs/v2/models/ObjectSetSubtractType.md deleted file mode 100644 index dcc9b46f..00000000 --- a/docs/v2/models/ObjectSetSubtractType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetSubtractType - -ObjectSetSubtractType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_sets** | List[ObjectSet] | Yes | | -**type** | Literal["subtract"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetSubtractTypeDict.md b/docs/v2/models/ObjectSetSubtractTypeDict.md deleted file mode 100644 index 81d8f875..00000000 --- a/docs/v2/models/ObjectSetSubtractTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetSubtractTypeDict - -ObjectSetSubtractType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSets** | List[ObjectSetDict] | Yes | | -**type** | Literal["subtract"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetUnionType.md b/docs/v2/models/ObjectSetUnionType.md deleted file mode 100644 index f4654f4b..00000000 --- a/docs/v2/models/ObjectSetUnionType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetUnionType - -ObjectSetUnionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_sets** | List[ObjectSet] | Yes | | -**type** | Literal["union"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetUnionTypeDict.md b/docs/v2/models/ObjectSetUnionTypeDict.md deleted file mode 100644 index 92f4a938..00000000 --- a/docs/v2/models/ObjectSetUnionTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectSetUnionTypeDict - -ObjectSetUnionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectSets** | List[ObjectSetDict] | Yes | | -**type** | Literal["union"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetUpdate.md b/docs/v2/models/ObjectSetUpdate.md deleted file mode 100644 index af2a6195..00000000 --- a/docs/v2/models/ObjectSetUpdate.md +++ /dev/null @@ -1,16 +0,0 @@ -# ObjectSetUpdate - -ObjectSetUpdate - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectUpdate](ObjectUpdate.md) | object -[ReferenceUpdate](ReferenceUpdate.md) | reference - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetUpdateDict.md b/docs/v2/models/ObjectSetUpdateDict.md deleted file mode 100644 index 05b54735..00000000 --- a/docs/v2/models/ObjectSetUpdateDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ObjectSetUpdateDict - -ObjectSetUpdate - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectUpdateDict](ObjectUpdateDict.md) | object -[ReferenceUpdateDict](ReferenceUpdateDict.md) | reference - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetUpdates.md b/docs/v2/models/ObjectSetUpdates.md deleted file mode 100644 index 0d032886..00000000 --- a/docs/v2/models/ObjectSetUpdates.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetUpdates - -ObjectSetUpdates - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**updates** | List[ObjectSetUpdate] | Yes | | -**type** | Literal["objectSetChanged"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectSetUpdatesDict.md b/docs/v2/models/ObjectSetUpdatesDict.md deleted file mode 100644 index eb6d1cdb..00000000 --- a/docs/v2/models/ObjectSetUpdatesDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectSetUpdatesDict - -ObjectSetUpdates - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**updates** | List[ObjectSetUpdateDict] | Yes | | -**type** | Literal["objectSetChanged"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectState.md b/docs/v2/models/ObjectState.md deleted file mode 100644 index 4d5b671f..00000000 --- a/docs/v2/models/ObjectState.md +++ /dev/null @@ -1,15 +0,0 @@ -# ObjectState - -Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was -added to the set or the object has updated and was previously in the set. REMOVED indicates that the object -was removed from the set due to the object being deleted or the object no longer meets the object set -definition. - - -| **Value** | -| --------- | -| `"ADDED_OR_UPDATED"` | -| `"REMOVED"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectType.md b/docs/v2/models/ObjectType.md deleted file mode 100644 index b90a6940..00000000 --- a/docs/v2/models/ObjectType.md +++ /dev/null @@ -1,18 +0,0 @@ -# ObjectType - -Represents an object type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | ObjectTypeApiName | Yes | | -**display_name** | Optional[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**description** | Optional[StrictStr] | No | The description of the object type. | -**visibility** | Optional[ObjectTypeVisibility] | No | | -**primary_key** | List[PropertyApiName] | Yes | The primary key of the object. This is a list of properties that can be used to uniquely identify the object. | -**properties** | Dict[PropertyApiName, Property] | Yes | A map of the properties of the object type. | -**rid** | ObjectTypeRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectTypeApiName.md b/docs/v2/models/ObjectTypeApiName.md deleted file mode 100644 index f6c43024..00000000 --- a/docs/v2/models/ObjectTypeApiName.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectTypeApiName - -The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the -`List object types` endpoint or check the **Ontology Manager**. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectTypeDict.md b/docs/v2/models/ObjectTypeDict.md deleted file mode 100644 index 01616b1e..00000000 --- a/docs/v2/models/ObjectTypeDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# ObjectTypeDict - -Represents an object type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ObjectTypeApiName | Yes | | -**displayName** | NotRequired[DisplayName] | No | | -**status** | ReleaseStatus | Yes | | -**description** | NotRequired[StrictStr] | No | The description of the object type. | -**visibility** | NotRequired[ObjectTypeVisibility] | No | | -**primaryKey** | List[PropertyApiName] | Yes | The primary key of the object. This is a list of properties that can be used to uniquely identify the object. | -**properties** | Dict[PropertyApiName, PropertyDict] | Yes | A map of the properties of the object type. | -**rid** | ObjectTypeRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectTypeEdits.md b/docs/v2/models/ObjectTypeEdits.md deleted file mode 100644 index 6dc846c5..00000000 --- a/docs/v2/models/ObjectTypeEdits.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectTypeEdits - -ObjectTypeEdits - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**edited_object_types** | List[ObjectTypeApiName] | Yes | | -**type** | Literal["largeScaleEdits"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectTypeEditsDict.md b/docs/v2/models/ObjectTypeEditsDict.md deleted file mode 100644 index 2f13c343..00000000 --- a/docs/v2/models/ObjectTypeEditsDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectTypeEditsDict - -ObjectTypeEdits - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**editedObjectTypes** | List[ObjectTypeApiName] | Yes | | -**type** | Literal["largeScaleEdits"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectTypeFullMetadata.md b/docs/v2/models/ObjectTypeFullMetadata.md deleted file mode 100644 index 1bc77ebc..00000000 --- a/docs/v2/models/ObjectTypeFullMetadata.md +++ /dev/null @@ -1,15 +0,0 @@ -# ObjectTypeFullMetadata - -ObjectTypeFullMetadata - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_type** | ObjectTypeV2 | Yes | | -**link_types** | List[LinkTypeSideV2] | Yes | | -**implements_interfaces** | List[InterfaceTypeApiName] | Yes | A list of interfaces that this object type implements. | -**implements_interfaces2** | Dict[InterfaceTypeApiName, ObjectTypeInterfaceImplementation] | Yes | A list of interfaces that this object type implements and how it implements them. | -**shared_property_type_mapping** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | A map from shared property type API name to backing local property API name for the shared property types present on this object type. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectTypeFullMetadataDict.md b/docs/v2/models/ObjectTypeFullMetadataDict.md deleted file mode 100644 index 2ae990ef..00000000 --- a/docs/v2/models/ObjectTypeFullMetadataDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# ObjectTypeFullMetadataDict - -ObjectTypeFullMetadata - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectType** | ObjectTypeV2Dict | Yes | | -**linkTypes** | List[LinkTypeSideV2Dict] | Yes | | -**implementsInterfaces** | List[InterfaceTypeApiName] | Yes | A list of interfaces that this object type implements. | -**implementsInterfaces2** | Dict[InterfaceTypeApiName, ObjectTypeInterfaceImplementationDict] | Yes | A list of interfaces that this object type implements and how it implements them. | -**sharedPropertyTypeMapping** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | A map from shared property type API name to backing local property API name for the shared property types present on this object type. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectTypeInterfaceImplementation.md b/docs/v2/models/ObjectTypeInterfaceImplementation.md deleted file mode 100644 index 27063644..00000000 --- a/docs/v2/models/ObjectTypeInterfaceImplementation.md +++ /dev/null @@ -1,11 +0,0 @@ -# ObjectTypeInterfaceImplementation - -ObjectTypeInterfaceImplementation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**properties** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectTypeInterfaceImplementationDict.md b/docs/v2/models/ObjectTypeInterfaceImplementationDict.md deleted file mode 100644 index d6202f1e..00000000 --- a/docs/v2/models/ObjectTypeInterfaceImplementationDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ObjectTypeInterfaceImplementationDict - -ObjectTypeInterfaceImplementation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**properties** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectTypeRid.md b/docs/v2/models/ObjectTypeRid.md deleted file mode 100644 index 9e0d9821..00000000 --- a/docs/v2/models/ObjectTypeRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ObjectTypeRid - -The unique resource identifier of an object type, useful for interacting with other Foundry APIs. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectTypeV2.md b/docs/v2/models/ObjectTypeV2.md deleted file mode 100644 index cab97112..00000000 --- a/docs/v2/models/ObjectTypeV2.md +++ /dev/null @@ -1,21 +0,0 @@ -# ObjectTypeV2 - -Represents an object type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | ObjectTypeApiName | Yes | | -**display_name** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**description** | Optional[StrictStr] | No | The description of the object type. | -**plural_display_name** | StrictStr | Yes | The plural display name of the object type. | -**icon** | Icon | Yes | | -**primary_key** | PropertyApiName | Yes | | -**properties** | Dict[PropertyApiName, PropertyV2] | Yes | A map of the properties of the object type. | -**rid** | ObjectTypeRid | Yes | | -**title_property** | PropertyApiName | Yes | | -**visibility** | Optional[ObjectTypeVisibility] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectTypeV2Dict.md b/docs/v2/models/ObjectTypeV2Dict.md deleted file mode 100644 index dde03b13..00000000 --- a/docs/v2/models/ObjectTypeV2Dict.md +++ /dev/null @@ -1,21 +0,0 @@ -# ObjectTypeV2Dict - -Represents an object type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | ObjectTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**status** | ReleaseStatus | Yes | | -**description** | NotRequired[StrictStr] | No | The description of the object type. | -**pluralDisplayName** | StrictStr | Yes | The plural display name of the object type. | -**icon** | IconDict | Yes | | -**primaryKey** | PropertyApiName | Yes | | -**properties** | Dict[PropertyApiName, PropertyV2Dict] | Yes | A map of the properties of the object type. | -**rid** | ObjectTypeRid | Yes | | -**titleProperty** | PropertyApiName | Yes | | -**visibility** | NotRequired[ObjectTypeVisibility] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectTypeVisibility.md b/docs/v2/models/ObjectTypeVisibility.md deleted file mode 100644 index 6a8df6e7..00000000 --- a/docs/v2/models/ObjectTypeVisibility.md +++ /dev/null @@ -1,12 +0,0 @@ -# ObjectTypeVisibility - -The suggested visibility of the object type. - -| **Value** | -| --------- | -| `"NORMAL"` | -| `"PROMINENT"` | -| `"HIDDEN"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectUpdate.md b/docs/v2/models/ObjectUpdate.md deleted file mode 100644 index 2046f462..00000000 --- a/docs/v2/models/ObjectUpdate.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectUpdate - -ObjectUpdate - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object** | OntologyObjectV2 | Yes | | -**state** | ObjectState | Yes | | -**type** | Literal["object"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ObjectUpdateDict.md b/docs/v2/models/ObjectUpdateDict.md deleted file mode 100644 index 9cbad1e4..00000000 --- a/docs/v2/models/ObjectUpdateDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ObjectUpdateDict - -ObjectUpdate - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object** | OntologyObjectV2 | Yes | | -**state** | ObjectState | Yes | | -**type** | Literal["object"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OneOfConstraint.md b/docs/v2/models/OneOfConstraint.md deleted file mode 100644 index b399d6bc..00000000 --- a/docs/v2/models/OneOfConstraint.md +++ /dev/null @@ -1,14 +0,0 @@ -# OneOfConstraint - -The parameter has a manually predefined set of options. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**options** | List[ParameterOption] | Yes | | -**other_values_allowed** | StrictBool | Yes | A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**. | -**type** | Literal["oneOf"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OneOfConstraintDict.md b/docs/v2/models/OneOfConstraintDict.md deleted file mode 100644 index d9878cc8..00000000 --- a/docs/v2/models/OneOfConstraintDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# OneOfConstraintDict - -The parameter has a manually predefined set of options. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**options** | List[ParameterOptionDict] | Yes | | -**otherValuesAllowed** | StrictBool | Yes | A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**. | -**type** | Literal["oneOf"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Ontology.md b/docs/v2/models/Ontology.md deleted file mode 100644 index adf598db..00000000 --- a/docs/v2/models/Ontology.md +++ /dev/null @@ -1,14 +0,0 @@ -# Ontology - -Metadata about an Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | OntologyApiName | Yes | | -**display_name** | DisplayName | Yes | | -**description** | StrictStr | Yes | | -**rid** | OntologyRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyApiName.md b/docs/v2/models/OntologyApiName.md deleted file mode 100644 index 7dd95554..00000000 --- a/docs/v2/models/OntologyApiName.md +++ /dev/null @@ -1,11 +0,0 @@ -# OntologyApiName - -OntologyApiName - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyArrayType.md b/docs/v2/models/OntologyArrayType.md deleted file mode 100644 index c1b2820f..00000000 --- a/docs/v2/models/OntologyArrayType.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyArrayType - -OntologyArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**item_type** | OntologyDataType | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyArrayTypeDict.md b/docs/v2/models/OntologyArrayTypeDict.md deleted file mode 100644 index 382ce385..00000000 --- a/docs/v2/models/OntologyArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyArrayTypeDict - -OntologyArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**itemType** | OntologyDataTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyDataType.md b/docs/v2/models/OntologyDataType.md deleted file mode 100644 index fb93f724..00000000 --- a/docs/v2/models/OntologyDataType.md +++ /dev/null @@ -1,36 +0,0 @@ -# OntologyDataType - -A union of all the primitive types used by Palantir's Ontology-based products. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AnyType](AnyType.md) | any -[BinaryType](BinaryType.md) | binary -[BooleanType](BooleanType.md) | boolean -[ByteType](ByteType.md) | byte -[DateType](DateType.md) | date -[DecimalType](DecimalType.md) | decimal -[DoubleType](DoubleType.md) | double -[FloatType](FloatType.md) | float -[IntegerType](IntegerType.md) | integer -[LongType](LongType.md) | long -[MarkingType](MarkingType.md) | marking -[ShortType](ShortType.md) | short -[StringType](StringType.md) | string -[TimestampType](TimestampType.md) | timestamp -[OntologyArrayType](OntologyArrayType.md) | array -[OntologyMapType](OntologyMapType.md) | map -[OntologySetType](OntologySetType.md) | set -[OntologyStructType](OntologyStructType.md) | struct -[OntologyObjectType](OntologyObjectType.md) | object -[OntologyObjectSetType](OntologyObjectSetType.md) | objectSet -[UnsupportedType](UnsupportedType.md) | unsupported - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyDataTypeDict.md b/docs/v2/models/OntologyDataTypeDict.md deleted file mode 100644 index dbf7c485..00000000 --- a/docs/v2/models/OntologyDataTypeDict.md +++ /dev/null @@ -1,36 +0,0 @@ -# OntologyDataTypeDict - -A union of all the primitive types used by Palantir's Ontology-based products. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AnyTypeDict](AnyTypeDict.md) | any -[BinaryTypeDict](BinaryTypeDict.md) | binary -[BooleanTypeDict](BooleanTypeDict.md) | boolean -[ByteTypeDict](ByteTypeDict.md) | byte -[DateTypeDict](DateTypeDict.md) | date -[DecimalTypeDict](DecimalTypeDict.md) | decimal -[DoubleTypeDict](DoubleTypeDict.md) | double -[FloatTypeDict](FloatTypeDict.md) | float -[IntegerTypeDict](IntegerTypeDict.md) | integer -[LongTypeDict](LongTypeDict.md) | long -[MarkingTypeDict](MarkingTypeDict.md) | marking -[ShortTypeDict](ShortTypeDict.md) | short -[StringTypeDict](StringTypeDict.md) | string -[TimestampTypeDict](TimestampTypeDict.md) | timestamp -[OntologyArrayTypeDict](OntologyArrayTypeDict.md) | array -[OntologyMapTypeDict](OntologyMapTypeDict.md) | map -[OntologySetTypeDict](OntologySetTypeDict.md) | set -[OntologyStructTypeDict](OntologyStructTypeDict.md) | struct -[OntologyObjectTypeDict](OntologyObjectTypeDict.md) | object -[OntologyObjectSetTypeDict](OntologyObjectSetTypeDict.md) | objectSet -[UnsupportedTypeDict](UnsupportedTypeDict.md) | unsupported - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyDict.md b/docs/v2/models/OntologyDict.md deleted file mode 100644 index fbd3d621..00000000 --- a/docs/v2/models/OntologyDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# OntologyDict - -Metadata about an Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | OntologyApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | StrictStr | Yes | | -**rid** | OntologyRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyFullMetadata.md b/docs/v2/models/OntologyFullMetadata.md deleted file mode 100644 index 2a04cbb1..00000000 --- a/docs/v2/models/OntologyFullMetadata.md +++ /dev/null @@ -1,16 +0,0 @@ -# OntologyFullMetadata - -OntologyFullMetadata - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**ontology** | OntologyV2 | Yes | | -**object_types** | Dict[ObjectTypeApiName, ObjectTypeFullMetadata] | Yes | | -**action_types** | Dict[ActionTypeApiName, ActionTypeV2] | Yes | | -**query_types** | Dict[QueryApiName, QueryTypeV2] | Yes | | -**interface_types** | Dict[InterfaceTypeApiName, InterfaceType] | Yes | | -**shared_property_types** | Dict[SharedPropertyTypeApiName, SharedPropertyType] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyFullMetadataDict.md b/docs/v2/models/OntologyFullMetadataDict.md deleted file mode 100644 index 67934d87..00000000 --- a/docs/v2/models/OntologyFullMetadataDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# OntologyFullMetadataDict - -OntologyFullMetadata - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**ontology** | OntologyV2Dict | Yes | | -**objectTypes** | Dict[ObjectTypeApiName, ObjectTypeFullMetadataDict] | Yes | | -**actionTypes** | Dict[ActionTypeApiName, ActionTypeV2Dict] | Yes | | -**queryTypes** | Dict[QueryApiName, QueryTypeV2Dict] | Yes | | -**interfaceTypes** | Dict[InterfaceTypeApiName, InterfaceTypeDict] | Yes | | -**sharedPropertyTypes** | Dict[SharedPropertyTypeApiName, SharedPropertyTypeDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyIdentifier.md b/docs/v2/models/OntologyIdentifier.md deleted file mode 100644 index 827cf024..00000000 --- a/docs/v2/models/OntologyIdentifier.md +++ /dev/null @@ -1,11 +0,0 @@ -# OntologyIdentifier - -Either an ontology rid or an ontology api name. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyMapType.md b/docs/v2/models/OntologyMapType.md deleted file mode 100644 index 115b2195..00000000 --- a/docs/v2/models/OntologyMapType.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyMapType - -OntologyMapType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key_type** | OntologyDataType | Yes | | -**value_type** | OntologyDataType | Yes | | -**type** | Literal["map"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyMapTypeDict.md b/docs/v2/models/OntologyMapTypeDict.md deleted file mode 100644 index bd4d2d3b..00000000 --- a/docs/v2/models/OntologyMapTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyMapTypeDict - -OntologyMapType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyType** | OntologyDataTypeDict | Yes | | -**valueType** | OntologyDataTypeDict | Yes | | -**type** | Literal["map"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyObject.md b/docs/v2/models/OntologyObject.md deleted file mode 100644 index af5a6e71..00000000 --- a/docs/v2/models/OntologyObject.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyObject - -Represents an object in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**properties** | Dict[PropertyApiName, Optional[PropertyValue]] | Yes | A map of the property values of the object. | -**rid** | ObjectRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyObjectArrayType.md b/docs/v2/models/OntologyObjectArrayType.md deleted file mode 100644 index 5ad9b874..00000000 --- a/docs/v2/models/OntologyObjectArrayType.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyObjectArrayType - -OntologyObjectArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**sub_type** | ObjectPropertyType | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyObjectArrayTypeDict.md b/docs/v2/models/OntologyObjectArrayTypeDict.md deleted file mode 100644 index 7a986f7f..00000000 --- a/docs/v2/models/OntologyObjectArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyObjectArrayTypeDict - -OntologyObjectArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | ObjectPropertyTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyObjectDict.md b/docs/v2/models/OntologyObjectDict.md deleted file mode 100644 index 35c0bfe0..00000000 --- a/docs/v2/models/OntologyObjectDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyObjectDict - -Represents an object in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**properties** | Dict[PropertyApiName, Optional[PropertyValue]] | Yes | A map of the property values of the object. | -**rid** | ObjectRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyObjectSetType.md b/docs/v2/models/OntologyObjectSetType.md deleted file mode 100644 index bd0fbeca..00000000 --- a/docs/v2/models/OntologyObjectSetType.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyObjectSetType - -OntologyObjectSetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_api_name** | Optional[ObjectTypeApiName] | No | | -**object_type_api_name** | Optional[ObjectTypeApiName] | No | | -**type** | Literal["objectSet"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyObjectSetTypeDict.md b/docs/v2/models/OntologyObjectSetTypeDict.md deleted file mode 100644 index dbdae79b..00000000 --- a/docs/v2/models/OntologyObjectSetTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyObjectSetTypeDict - -OntologyObjectSetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectApiName** | NotRequired[ObjectTypeApiName] | No | | -**objectTypeApiName** | NotRequired[ObjectTypeApiName] | No | | -**type** | Literal["objectSet"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyObjectType.md b/docs/v2/models/OntologyObjectType.md deleted file mode 100644 index c11493b3..00000000 --- a/docs/v2/models/OntologyObjectType.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyObjectType - -OntologyObjectType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_api_name** | ObjectTypeApiName | Yes | | -**object_type_api_name** | ObjectTypeApiName | Yes | | -**type** | Literal["object"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyObjectTypeDict.md b/docs/v2/models/OntologyObjectTypeDict.md deleted file mode 100644 index e4f9a2ac..00000000 --- a/docs/v2/models/OntologyObjectTypeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyObjectTypeDict - -OntologyObjectType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectApiName** | ObjectTypeApiName | Yes | | -**objectTypeApiName** | ObjectTypeApiName | Yes | | -**type** | Literal["object"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyObjectV2.md b/docs/v2/models/OntologyObjectV2.md deleted file mode 100644 index 21530244..00000000 --- a/docs/v2/models/OntologyObjectV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# OntologyObjectV2 - -Represents an object in the Ontology. - -## Type -```python -Dict[PropertyApiName, PropertyValue] -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyRid.md b/docs/v2/models/OntologyRid.md deleted file mode 100644 index 84ea8d95..00000000 --- a/docs/v2/models/OntologyRid.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyRid - -The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the -`List ontologies` endpoint or check the **Ontology Manager**. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologySetType.md b/docs/v2/models/OntologySetType.md deleted file mode 100644 index 2a699883..00000000 --- a/docs/v2/models/OntologySetType.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologySetType - -OntologySetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**item_type** | OntologyDataType | Yes | | -**type** | Literal["set"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologySetTypeDict.md b/docs/v2/models/OntologySetTypeDict.md deleted file mode 100644 index 5a847cc3..00000000 --- a/docs/v2/models/OntologySetTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologySetTypeDict - -OntologySetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**itemType** | OntologyDataTypeDict | Yes | | -**type** | Literal["set"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyStructField.md b/docs/v2/models/OntologyStructField.md deleted file mode 100644 index dde43223..00000000 --- a/docs/v2/models/OntologyStructField.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyStructField - -OntologyStructField - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StructFieldName | Yes | | -**field_type** | OntologyDataType | Yes | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyStructFieldDict.md b/docs/v2/models/OntologyStructFieldDict.md deleted file mode 100644 index 4c0d26f5..00000000 --- a/docs/v2/models/OntologyStructFieldDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# OntologyStructFieldDict - -OntologyStructField - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StructFieldName | Yes | | -**fieldType** | OntologyDataTypeDict | Yes | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyStructType.md b/docs/v2/models/OntologyStructType.md deleted file mode 100644 index c4c39f67..00000000 --- a/docs/v2/models/OntologyStructType.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyStructType - -OntologyStructType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[OntologyStructField] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyStructTypeDict.md b/docs/v2/models/OntologyStructTypeDict.md deleted file mode 100644 index ea46bfaf..00000000 --- a/docs/v2/models/OntologyStructTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OntologyStructTypeDict - -OntologyStructType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[OntologyStructFieldDict] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyV2.md b/docs/v2/models/OntologyV2.md deleted file mode 100644 index 1bec08c8..00000000 --- a/docs/v2/models/OntologyV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# OntologyV2 - -Metadata about an Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | OntologyApiName | Yes | | -**display_name** | DisplayName | Yes | | -**description** | StrictStr | Yes | | -**rid** | OntologyRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OntologyV2Dict.md b/docs/v2/models/OntologyV2Dict.md deleted file mode 100644 index b172692a..00000000 --- a/docs/v2/models/OntologyV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# OntologyV2Dict - -Metadata about an Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | OntologyApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | StrictStr | Yes | | -**rid** | OntologyRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OrQuery.md b/docs/v2/models/OrQuery.md deleted file mode 100644 index 12da81b8..00000000 --- a/docs/v2/models/OrQuery.md +++ /dev/null @@ -1,12 +0,0 @@ -# OrQuery - -Returns objects where at least 1 query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQuery] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OrQueryDict.md b/docs/v2/models/OrQueryDict.md deleted file mode 100644 index cc2a5064..00000000 --- a/docs/v2/models/OrQueryDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OrQueryDict - -Returns objects where at least 1 query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryDict] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OrQueryV2.md b/docs/v2/models/OrQueryV2.md deleted file mode 100644 index 03bff98c..00000000 --- a/docs/v2/models/OrQueryV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# OrQueryV2 - -Returns objects where at least 1 query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryV2] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OrQueryV2Dict.md b/docs/v2/models/OrQueryV2Dict.md deleted file mode 100644 index dc8044cb..00000000 --- a/docs/v2/models/OrQueryV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OrQueryV2Dict - -Returns objects where at least 1 query is satisfied. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**value** | List[SearchJsonQueryV2Dict] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OrTrigger.md b/docs/v2/models/OrTrigger.md deleted file mode 100644 index 0ff3364d..00000000 --- a/docs/v2/models/OrTrigger.md +++ /dev/null @@ -1,12 +0,0 @@ -# OrTrigger - -Trigger whenever any of the given triggers emit an event. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**triggers** | List[Trigger] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OrTriggerDict.md b/docs/v2/models/OrTriggerDict.md deleted file mode 100644 index 322da3c1..00000000 --- a/docs/v2/models/OrTriggerDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# OrTriggerDict - -Trigger whenever any of the given triggers emit an event. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**triggers** | List[TriggerDict] | Yes | | -**type** | Literal["or"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OrderBy.md b/docs/v2/models/OrderBy.md deleted file mode 100644 index 4b3a65f2..00000000 --- a/docs/v2/models/OrderBy.md +++ /dev/null @@ -1,21 +0,0 @@ -# OrderBy - -A command representing the list of properties to order by. Properties should be delimited by commas and -prefixed by `p` or `properties`. The format expected format is -`orderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...` - -By default, the ordering for a property is ascending, and this can be explicitly specified by appending -`:asc` (for ascending) or `:desc` (for descending). - -Example: use `orderBy=properties.lastName:asc` to order by a single property, -`orderBy=properties.lastName,properties.firstName,properties.age:desc` to order by multiple properties. -You may also use the shorthand `p` instead of `properties` such as `orderBy=p.lastName:asc`. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OrderByDirection.md b/docs/v2/models/OrderByDirection.md deleted file mode 100644 index 0f05890d..00000000 --- a/docs/v2/models/OrderByDirection.md +++ /dev/null @@ -1,11 +0,0 @@ -# OrderByDirection - -OrderByDirection - -| **Value** | -| --------- | -| `"ASC"` | -| `"DESC"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/OrganizationRid.md b/docs/v2/models/OrganizationRid.md deleted file mode 100644 index b415e440..00000000 --- a/docs/v2/models/OrganizationRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# OrganizationRid - -OrganizationRid - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PageSize.md b/docs/v2/models/PageSize.md deleted file mode 100644 index 6b61ae34..00000000 --- a/docs/v2/models/PageSize.md +++ /dev/null @@ -1,11 +0,0 @@ -# PageSize - -The page size to use for the endpoint. - -## Type -```python -StrictInt -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PageToken.md b/docs/v2/models/PageToken.md deleted file mode 100644 index f7676b6e..00000000 --- a/docs/v2/models/PageToken.md +++ /dev/null @@ -1,13 +0,0 @@ -# PageToken - -The page token indicates where to start paging. This should be omitted from the first page's request. - To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response - and populate the next request's `pageToken` field with it. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Parameter.md b/docs/v2/models/Parameter.md deleted file mode 100644 index 185f582b..00000000 --- a/docs/v2/models/Parameter.md +++ /dev/null @@ -1,14 +0,0 @@ -# Parameter - -Details about a parameter of an action or query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | Optional[StrictStr] | No | | -**base_type** | ValueType | Yes | | -**data_type** | Optional[OntologyDataType] | No | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ParameterDict.md b/docs/v2/models/ParameterDict.md deleted file mode 100644 index f975c554..00000000 --- a/docs/v2/models/ParameterDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ParameterDict - -Details about a parameter of an action or query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[StrictStr] | No | | -**baseType** | ValueType | Yes | | -**dataType** | NotRequired[OntologyDataTypeDict] | No | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ParameterEvaluatedConstraint.md b/docs/v2/models/ParameterEvaluatedConstraint.md deleted file mode 100644 index 9050099f..00000000 --- a/docs/v2/models/ParameterEvaluatedConstraint.md +++ /dev/null @@ -1,40 +0,0 @@ -# ParameterEvaluatedConstraint - -A constraint that an action parameter value must satisfy in order to be considered valid. -Constraints can be configured on action parameters in the **Ontology Manager**. -Applicable constraints are determined dynamically based on parameter inputs. -Parameter values are evaluated against the final set of constraints. - -The type of the constraint. -| Type | Description | -|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | -| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | -| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | -| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | -| `oneOf` | The parameter has a manually predefined set of options. | -| `range` | The parameter value must be within the defined range. | -| `stringLength` | The parameter value must have a length within the defined range. | -| `stringRegexMatch` | The parameter value must match a predefined regular expression. | -| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ArraySizeConstraint](ArraySizeConstraint.md) | arraySize -[GroupMemberConstraint](GroupMemberConstraint.md) | groupMember -[ObjectPropertyValueConstraint](ObjectPropertyValueConstraint.md) | objectPropertyValue -[ObjectQueryResultConstraint](ObjectQueryResultConstraint.md) | objectQueryResult -[OneOfConstraint](OneOfConstraint.md) | oneOf -[RangeConstraint](RangeConstraint.md) | range -[StringLengthConstraint](StringLengthConstraint.md) | stringLength -[StringRegexMatchConstraint](StringRegexMatchConstraint.md) | stringRegexMatch -[UnevaluableConstraint](UnevaluableConstraint.md) | unevaluable - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ParameterEvaluatedConstraintDict.md b/docs/v2/models/ParameterEvaluatedConstraintDict.md deleted file mode 100644 index e42b5359..00000000 --- a/docs/v2/models/ParameterEvaluatedConstraintDict.md +++ /dev/null @@ -1,40 +0,0 @@ -# ParameterEvaluatedConstraintDict - -A constraint that an action parameter value must satisfy in order to be considered valid. -Constraints can be configured on action parameters in the **Ontology Manager**. -Applicable constraints are determined dynamically based on parameter inputs. -Parameter values are evaluated against the final set of constraints. - -The type of the constraint. -| Type | Description | -|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | -| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | -| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | -| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | -| `oneOf` | The parameter has a manually predefined set of options. | -| `range` | The parameter value must be within the defined range. | -| `stringLength` | The parameter value must have a length within the defined range. | -| `stringRegexMatch` | The parameter value must match a predefined regular expression. | -| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ArraySizeConstraintDict](ArraySizeConstraintDict.md) | arraySize -[GroupMemberConstraintDict](GroupMemberConstraintDict.md) | groupMember -[ObjectPropertyValueConstraintDict](ObjectPropertyValueConstraintDict.md) | objectPropertyValue -[ObjectQueryResultConstraintDict](ObjectQueryResultConstraintDict.md) | objectQueryResult -[OneOfConstraintDict](OneOfConstraintDict.md) | oneOf -[RangeConstraintDict](RangeConstraintDict.md) | range -[StringLengthConstraintDict](StringLengthConstraintDict.md) | stringLength -[StringRegexMatchConstraintDict](StringRegexMatchConstraintDict.md) | stringRegexMatch -[UnevaluableConstraintDict](UnevaluableConstraintDict.md) | unevaluable - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ParameterEvaluationResult.md b/docs/v2/models/ParameterEvaluationResult.md deleted file mode 100644 index aef5efd5..00000000 --- a/docs/v2/models/ParameterEvaluationResult.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterEvaluationResult - -Represents the validity of a parameter against the configured constraints. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**evaluated_constraints** | List[ParameterEvaluatedConstraint] | Yes | | -**required** | StrictBool | Yes | Represents whether the parameter is a required input to the action. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ParameterEvaluationResultDict.md b/docs/v2/models/ParameterEvaluationResultDict.md deleted file mode 100644 index 4035f0d8..00000000 --- a/docs/v2/models/ParameterEvaluationResultDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterEvaluationResultDict - -Represents the validity of a parameter against the configured constraints. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**evaluatedConstraints** | List[ParameterEvaluatedConstraintDict] | Yes | | -**required** | StrictBool | Yes | Represents whether the parameter is a required input to the action. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ParameterId.md b/docs/v2/models/ParameterId.md deleted file mode 100644 index 86e4bb47..00000000 --- a/docs/v2/models/ParameterId.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterId - -The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied. -Parameters can be viewed and managed in the **Ontology Manager**. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ParameterOption.md b/docs/v2/models/ParameterOption.md deleted file mode 100644 index 93e04c87..00000000 --- a/docs/v2/models/ParameterOption.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterOption - -A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**display_name** | Optional[DisplayName] | No | | -**value** | Optional[Any] | No | An allowed configured value for a parameter within an action. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ParameterOptionDict.md b/docs/v2/models/ParameterOptionDict.md deleted file mode 100644 index a315538f..00000000 --- a/docs/v2/models/ParameterOptionDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ParameterOptionDict - -A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**displayName** | NotRequired[DisplayName] | No | | -**value** | NotRequired[Any] | No | An allowed configured value for a parameter within an action. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PhraseQuery.md b/docs/v2/models/PhraseQuery.md deleted file mode 100644 index 01866a20..00000000 --- a/docs/v2/models/PhraseQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# PhraseQuery - -Returns objects where the specified field contains the provided value as a substring. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["phrase"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PhraseQueryDict.md b/docs/v2/models/PhraseQueryDict.md deleted file mode 100644 index e0cafb79..00000000 --- a/docs/v2/models/PhraseQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PhraseQueryDict - -Returns objects where the specified field contains the provided value as a substring. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["phrase"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Polygon.md b/docs/v2/models/Polygon.md deleted file mode 100644 index e95b21dd..00000000 --- a/docs/v2/models/Polygon.md +++ /dev/null @@ -1,13 +0,0 @@ -# Polygon - -Polygon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[LinearRing] | Yes | | -**bbox** | Optional[BBox] | No | | -**type** | Literal["Polygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PolygonDict.md b/docs/v2/models/PolygonDict.md deleted file mode 100644 index d180bb2e..00000000 --- a/docs/v2/models/PolygonDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PolygonDict - -Polygon - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**coordinates** | List[LinearRing] | Yes | | -**bbox** | NotRequired[BBox] | No | | -**type** | Literal["Polygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PolygonValue.md b/docs/v2/models/PolygonValue.md deleted file mode 100644 index 18609434..00000000 --- a/docs/v2/models/PolygonValue.md +++ /dev/null @@ -1,11 +0,0 @@ -# PolygonValue - -PolygonValue - -## Type -```python -Polygon -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PolygonValueDict.md b/docs/v2/models/PolygonValueDict.md deleted file mode 100644 index 8cfef079..00000000 --- a/docs/v2/models/PolygonValueDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# PolygonValueDict - -PolygonValue - -## Type -```python -PolygonDict -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Position.md b/docs/v2/models/Position.md deleted file mode 100644 index 62cee5ce..00000000 --- a/docs/v2/models/Position.md +++ /dev/null @@ -1,25 +0,0 @@ -# Position - -GeoJSon fundamental geometry construct. - -A position is an array of numbers. There MUST be two or more elements. -The first two elements are longitude and latitude, precisely in that order and using decimal numbers. -Altitude or elevation MAY be included as an optional third element. - -Implementations SHOULD NOT extend positions beyond three elements -because the semantics of extra elements are unspecified and ambiguous. -Historically, some implementations have used a fourth element to carry -a linear referencing measure (sometimes denoted as "M") or a numerical -timestamp, but in most situations a parser will not be able to properly -interpret these values. The interpretation and meaning of additional -elements is beyond the scope of this specification, and additional -elements MAY be ignored by parsers. - - -## Type -```python -List[Coordinate] -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PrefixQuery.md b/docs/v2/models/PrefixQuery.md deleted file mode 100644 index 19e9a584..00000000 --- a/docs/v2/models/PrefixQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# PrefixQuery - -Returns objects where the specified field starts with the provided value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["prefix"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PrefixQueryDict.md b/docs/v2/models/PrefixQueryDict.md deleted file mode 100644 index d7e66b86..00000000 --- a/docs/v2/models/PrefixQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PrefixQueryDict - -Returns objects where the specified field starts with the provided value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["prefix"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PreviewMode.md b/docs/v2/models/PreviewMode.md deleted file mode 100644 index 7c2631e0..00000000 --- a/docs/v2/models/PreviewMode.md +++ /dev/null @@ -1,11 +0,0 @@ -# PreviewMode - -Enables the use of preview functionality. - -## Type -```python -StrictBool -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PrimaryKeyValue.md b/docs/v2/models/PrimaryKeyValue.md deleted file mode 100644 index 1d8a737b..00000000 --- a/docs/v2/models/PrimaryKeyValue.md +++ /dev/null @@ -1,11 +0,0 @@ -# PrimaryKeyValue - -Represents the primary key value that is used as a unique identifier for an object. - -## Type -```python -Any -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PrincipalFilterType.md b/docs/v2/models/PrincipalFilterType.md deleted file mode 100644 index b8c9f75e..00000000 --- a/docs/v2/models/PrincipalFilterType.md +++ /dev/null @@ -1,10 +0,0 @@ -# PrincipalFilterType - -PrincipalFilterType - -| **Value** | -| --------- | -| `"queryString"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PrincipalId.md b/docs/v2/models/PrincipalId.md deleted file mode 100644 index 4878628d..00000000 --- a/docs/v2/models/PrincipalId.md +++ /dev/null @@ -1,11 +0,0 @@ -# PrincipalId - -The ID of a Foundry Group or User. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PrincipalType.md b/docs/v2/models/PrincipalType.md deleted file mode 100644 index f3045ad4..00000000 --- a/docs/v2/models/PrincipalType.md +++ /dev/null @@ -1,11 +0,0 @@ -# PrincipalType - -PrincipalType - -| **Value** | -| --------- | -| `"USER"` | -| `"GROUP"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Project.md b/docs/v2/models/Project.md deleted file mode 100644 index dfe9acd7..00000000 --- a/docs/v2/models/Project.md +++ /dev/null @@ -1,11 +0,0 @@ -# Project - -Project - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ProjectRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ProjectDict.md b/docs/v2/models/ProjectDict.md deleted file mode 100644 index 6f2c97b9..00000000 --- a/docs/v2/models/ProjectDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectDict - -Project - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ProjectRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ProjectRid.md b/docs/v2/models/ProjectRid.md deleted file mode 100644 index 313106f2..00000000 --- a/docs/v2/models/ProjectRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProjectRid - -The unique resource identifier (RID) of a Project. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ProjectScope.md b/docs/v2/models/ProjectScope.md deleted file mode 100644 index 140c0faf..00000000 --- a/docs/v2/models/ProjectScope.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectScope - -The schedule will only build resources in the following projects. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**project_rids** | List[ProjectRid] | Yes | | -**type** | Literal["project"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ProjectScopeDict.md b/docs/v2/models/ProjectScopeDict.md deleted file mode 100644 index bebb3ce4..00000000 --- a/docs/v2/models/ProjectScopeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ProjectScopeDict - -The schedule will only build resources in the following projects. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**projectRids** | List[ProjectRid] | Yes | | -**type** | Literal["project"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Property.md b/docs/v2/models/Property.md deleted file mode 100644 index a877ca2a..00000000 --- a/docs/v2/models/Property.md +++ /dev/null @@ -1,13 +0,0 @@ -# Property - -Details about some property of an object. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | Optional[StrictStr] | No | | -**display_name** | Optional[DisplayName] | No | | -**base_type** | ValueType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PropertyApiName.md b/docs/v2/models/PropertyApiName.md deleted file mode 100644 index 4e02bb7f..00000000 --- a/docs/v2/models/PropertyApiName.md +++ /dev/null @@ -1,13 +0,0 @@ -# PropertyApiName - -The name of the property in the API. To find the API name for your property, use the `Get object type` -endpoint or check the **Ontology Manager**. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PropertyDict.md b/docs/v2/models/PropertyDict.md deleted file mode 100644 index 578b29e5..00000000 --- a/docs/v2/models/PropertyDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PropertyDict - -Details about some property of an object. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[StrictStr] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**baseType** | ValueType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PropertyFilter.md b/docs/v2/models/PropertyFilter.md deleted file mode 100644 index 93e1d3f2..00000000 --- a/docs/v2/models/PropertyFilter.md +++ /dev/null @@ -1,36 +0,0 @@ -# PropertyFilter - -Represents a filter used on properties. - -Endpoints that accept this supports optional parameters that have the form: -`properties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString}` to filter the returned objects. -For instance, you may use `properties.firstName.eq=John` to find objects that contain a property called -"firstName" that has the exact value of "John". - -The following are a list of supported property filters: - -- `properties.{propertyApiName}.contains` - supported on arrays and can be used to filter array properties - that have at least one of the provided values. If multiple query parameters are provided, then objects - that have any of the given values for the specified property will be matched. -- `properties.{propertyApiName}.eq` - used to filter objects that have the exact value for the provided - property. If multiple query parameters are provided, then objects that have any of the given values - will be matched. For instance, if the user provides a request by doing - `?properties.firstName.eq=John&properties.firstName.eq=Anna`, then objects that have a firstName property - of either John or Anna will be matched. This filter is supported on all property types except Arrays. -- `properties.{propertyApiName}.neq` - used to filter objects that do not have the provided property values. - Similar to the `eq` filter, if multiple values are provided, then objects that have any of the given values - will be excluded from the result. -- `properties.{propertyApiName}.lt`, `properties.{propertyApiName}.lte`, `properties.{propertyApiName}.gt` - `properties.{propertyApiName}.gte` - represent less than, less than or equal to, greater than, and greater - than or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal. -- `properties.{propertyApiName}.isNull` - used to filter objects where the provided property is (or is not) null. - This filter is supported on all property types. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PropertyId.md b/docs/v2/models/PropertyId.md deleted file mode 100644 index 8999f7c8..00000000 --- a/docs/v2/models/PropertyId.md +++ /dev/null @@ -1,13 +0,0 @@ -# PropertyId - -The immutable ID of a property. Property IDs are only used to identify properties in the **Ontology Manager** -application and assign them API names. In every other case, API names should be used instead of property IDs. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PropertyV2.md b/docs/v2/models/PropertyV2.md deleted file mode 100644 index f225bba0..00000000 --- a/docs/v2/models/PropertyV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# PropertyV2 - -Details about some property of an object. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | Optional[StrictStr] | No | | -**display_name** | Optional[DisplayName] | No | | -**data_type** | ObjectPropertyType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PropertyV2Dict.md b/docs/v2/models/PropertyV2Dict.md deleted file mode 100644 index 57ed13fa..00000000 --- a/docs/v2/models/PropertyV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# PropertyV2Dict - -Details about some property of an object. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[StrictStr] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**dataType** | ObjectPropertyTypeDict | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PropertyValue.md b/docs/v2/models/PropertyValue.md deleted file mode 100644 index 1078c37c..00000000 --- a/docs/v2/models/PropertyValue.md +++ /dev/null @@ -1,32 +0,0 @@ -# PropertyValue - -Represents the value of a property in the following format. - -| Type | JSON encoding | Example | -|----------- |-------------------------------------------------------|----------------------------------------------------------------------------------------------------| -| Array | array | `["alpha", "bravo", "charlie"]` | -| Attachment | JSON encoded `AttachmentProperty` object | `{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}` | -| Boolean | boolean | `true` | -| Byte | number | `31` | -| Date | ISO 8601 extended local date string | `"2021-05-01"` | -| Decimal | string | `"2.718281828"` | -| Double | number | `3.14159265` | -| Float | number | `3.14159265` | -| GeoPoint | geojson | `{"type":"Point","coordinates":[102.0,0.5]}` | -| GeoShape | geojson | `{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` | -| Integer | number | `238940` | -| Long | string | `"58319870951433"` | -| Short | number | `8739` | -| String | string | `"Call me Ishmael"` | -| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | - -Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings. - - -## Type -```python -Any -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/PropertyValueEscapedString.md b/docs/v2/models/PropertyValueEscapedString.md deleted file mode 100644 index 175f6a9f..00000000 --- a/docs/v2/models/PropertyValueEscapedString.md +++ /dev/null @@ -1,11 +0,0 @@ -# PropertyValueEscapedString - -Represents the value of a property in string format. This is used in URL parameters. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QosError.md b/docs/v2/models/QosError.md deleted file mode 100644 index 1949fe93..00000000 --- a/docs/v2/models/QosError.md +++ /dev/null @@ -1,12 +0,0 @@ -# QosError - -An error indicating that the subscribe request should be attempted on a different node. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["qos"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QosErrorDict.md b/docs/v2/models/QosErrorDict.md deleted file mode 100644 index cfac9dfc..00000000 --- a/docs/v2/models/QosErrorDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QosErrorDict - -An error indicating that the subscribe request should be attempted on a different node. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["qos"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryAggregation.md b/docs/v2/models/QueryAggregation.md deleted file mode 100644 index 6e628ccd..00000000 --- a/docs/v2/models/QueryAggregation.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryAggregation - -QueryAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key** | Any | Yes | | -**value** | Any | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryAggregationDict.md b/docs/v2/models/QueryAggregationDict.md deleted file mode 100644 index 31e22ed1..00000000 --- a/docs/v2/models/QueryAggregationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryAggregationDict - -QueryAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key** | Any | Yes | | -**value** | Any | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryAggregationKeyType.md b/docs/v2/models/QueryAggregationKeyType.md deleted file mode 100644 index 386b8d9c..00000000 --- a/docs/v2/models/QueryAggregationKeyType.md +++ /dev/null @@ -1,22 +0,0 @@ -# QueryAggregationKeyType - -A union of all the types supported by query aggregation keys. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[BooleanType](BooleanType.md) | boolean -[DateType](DateType.md) | date -[DoubleType](DoubleType.md) | double -[IntegerType](IntegerType.md) | integer -[StringType](StringType.md) | string -[TimestampType](TimestampType.md) | timestamp -[QueryAggregationRangeType](QueryAggregationRangeType.md) | range - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryAggregationKeyTypeDict.md b/docs/v2/models/QueryAggregationKeyTypeDict.md deleted file mode 100644 index 9d994df2..00000000 --- a/docs/v2/models/QueryAggregationKeyTypeDict.md +++ /dev/null @@ -1,22 +0,0 @@ -# QueryAggregationKeyTypeDict - -A union of all the types supported by query aggregation keys. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[BooleanTypeDict](BooleanTypeDict.md) | boolean -[DateTypeDict](DateTypeDict.md) | date -[DoubleTypeDict](DoubleTypeDict.md) | double -[IntegerTypeDict](IntegerTypeDict.md) | integer -[StringTypeDict](StringTypeDict.md) | string -[TimestampTypeDict](TimestampTypeDict.md) | timestamp -[QueryAggregationRangeTypeDict](QueryAggregationRangeTypeDict.md) | range - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryAggregationRange.md b/docs/v2/models/QueryAggregationRange.md deleted file mode 100644 index f15b6075..00000000 --- a/docs/v2/models/QueryAggregationRange.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryAggregationRange - -Specifies a range from an inclusive start value to an exclusive end value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**start_value** | Optional[Any] | No | Inclusive start. | -**end_value** | Optional[Any] | No | Exclusive end. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryAggregationRangeDict.md b/docs/v2/models/QueryAggregationRangeDict.md deleted file mode 100644 index a2ac9eb3..00000000 --- a/docs/v2/models/QueryAggregationRangeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryAggregationRangeDict - -Specifies a range from an inclusive start value to an exclusive end value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**startValue** | NotRequired[Any] | No | Inclusive start. | -**endValue** | NotRequired[Any] | No | Exclusive end. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryAggregationRangeSubType.md b/docs/v2/models/QueryAggregationRangeSubType.md deleted file mode 100644 index 5ff6e9f3..00000000 --- a/docs/v2/models/QueryAggregationRangeSubType.md +++ /dev/null @@ -1,19 +0,0 @@ -# QueryAggregationRangeSubType - -A union of all the types supported by query aggregation ranges. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[DateType](DateType.md) | date -[DoubleType](DoubleType.md) | double -[IntegerType](IntegerType.md) | integer -[TimestampType](TimestampType.md) | timestamp - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryAggregationRangeSubTypeDict.md b/docs/v2/models/QueryAggregationRangeSubTypeDict.md deleted file mode 100644 index 7dec6a70..00000000 --- a/docs/v2/models/QueryAggregationRangeSubTypeDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# QueryAggregationRangeSubTypeDict - -A union of all the types supported by query aggregation ranges. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[DateTypeDict](DateTypeDict.md) | date -[DoubleTypeDict](DoubleTypeDict.md) | double -[IntegerTypeDict](IntegerTypeDict.md) | integer -[TimestampTypeDict](TimestampTypeDict.md) | timestamp - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryAggregationRangeType.md b/docs/v2/models/QueryAggregationRangeType.md deleted file mode 100644 index d51f04fd..00000000 --- a/docs/v2/models/QueryAggregationRangeType.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryAggregationRangeType - -QueryAggregationRangeType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**sub_type** | QueryAggregationRangeSubType | Yes | | -**type** | Literal["range"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryAggregationRangeTypeDict.md b/docs/v2/models/QueryAggregationRangeTypeDict.md deleted file mode 100644 index f79b0d5f..00000000 --- a/docs/v2/models/QueryAggregationRangeTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryAggregationRangeTypeDict - -QueryAggregationRangeType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | QueryAggregationRangeSubTypeDict | Yes | | -**type** | Literal["range"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryAggregationValueType.md b/docs/v2/models/QueryAggregationValueType.md deleted file mode 100644 index c2826ffb..00000000 --- a/docs/v2/models/QueryAggregationValueType.md +++ /dev/null @@ -1,18 +0,0 @@ -# QueryAggregationValueType - -A union of all the types supported by query aggregation keys. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[DateType](DateType.md) | date -[DoubleType](DoubleType.md) | double -[TimestampType](TimestampType.md) | timestamp - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryAggregationValueTypeDict.md b/docs/v2/models/QueryAggregationValueTypeDict.md deleted file mode 100644 index 763b09b7..00000000 --- a/docs/v2/models/QueryAggregationValueTypeDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# QueryAggregationValueTypeDict - -A union of all the types supported by query aggregation keys. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[DateTypeDict](DateTypeDict.md) | date -[DoubleTypeDict](DoubleTypeDict.md) | double -[TimestampTypeDict](TimestampTypeDict.md) | timestamp - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryApiName.md b/docs/v2/models/QueryApiName.md deleted file mode 100644 index 17bb44c5..00000000 --- a/docs/v2/models/QueryApiName.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryApiName - -The name of the Query in the API. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryArrayType.md b/docs/v2/models/QueryArrayType.md deleted file mode 100644 index b546877a..00000000 --- a/docs/v2/models/QueryArrayType.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryArrayType - -QueryArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**sub_type** | QueryDataType | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryArrayTypeDict.md b/docs/v2/models/QueryArrayTypeDict.md deleted file mode 100644 index 067b7b01..00000000 --- a/docs/v2/models/QueryArrayTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryArrayTypeDict - -QueryArrayType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | QueryDataTypeDict | Yes | | -**type** | Literal["array"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryDataType.md b/docs/v2/models/QueryDataType.md deleted file mode 100644 index 69318022..00000000 --- a/docs/v2/models/QueryDataType.md +++ /dev/null @@ -1,34 +0,0 @@ -# QueryDataType - -A union of all the types supported by Ontology Query parameters or outputs. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[QueryArrayType](QueryArrayType.md) | array -[AttachmentType](AttachmentType.md) | attachment -[BooleanType](BooleanType.md) | boolean -[DateType](DateType.md) | date -[DoubleType](DoubleType.md) | double -[FloatType](FloatType.md) | float -[IntegerType](IntegerType.md) | integer -[LongType](LongType.md) | long -[OntologyObjectSetType](OntologyObjectSetType.md) | objectSet -[OntologyObjectType](OntologyObjectType.md) | object -[QuerySetType](QuerySetType.md) | set -[StringType](StringType.md) | string -[QueryStructType](QueryStructType.md) | struct -[ThreeDimensionalAggregation](ThreeDimensionalAggregation.md) | threeDimensionalAggregation -[TimestampType](TimestampType.md) | timestamp -[TwoDimensionalAggregation](TwoDimensionalAggregation.md) | twoDimensionalAggregation -[QueryUnionType](QueryUnionType.md) | union -[NullType](NullType.md) | null -[UnsupportedType](UnsupportedType.md) | unsupported - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryDataTypeDict.md b/docs/v2/models/QueryDataTypeDict.md deleted file mode 100644 index 5d5a56e5..00000000 --- a/docs/v2/models/QueryDataTypeDict.md +++ /dev/null @@ -1,34 +0,0 @@ -# QueryDataTypeDict - -A union of all the types supported by Ontology Query parameters or outputs. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[QueryArrayTypeDict](QueryArrayTypeDict.md) | array -[AttachmentTypeDict](AttachmentTypeDict.md) | attachment -[BooleanTypeDict](BooleanTypeDict.md) | boolean -[DateTypeDict](DateTypeDict.md) | date -[DoubleTypeDict](DoubleTypeDict.md) | double -[FloatTypeDict](FloatTypeDict.md) | float -[IntegerTypeDict](IntegerTypeDict.md) | integer -[LongTypeDict](LongTypeDict.md) | long -[OntologyObjectSetTypeDict](OntologyObjectSetTypeDict.md) | objectSet -[OntologyObjectTypeDict](OntologyObjectTypeDict.md) | object -[QuerySetTypeDict](QuerySetTypeDict.md) | set -[StringTypeDict](StringTypeDict.md) | string -[QueryStructTypeDict](QueryStructTypeDict.md) | struct -[ThreeDimensionalAggregationDict](ThreeDimensionalAggregationDict.md) | threeDimensionalAggregation -[TimestampTypeDict](TimestampTypeDict.md) | timestamp -[TwoDimensionalAggregationDict](TwoDimensionalAggregationDict.md) | twoDimensionalAggregation -[QueryUnionTypeDict](QueryUnionTypeDict.md) | union -[NullTypeDict](NullTypeDict.md) | null -[UnsupportedTypeDict](UnsupportedTypeDict.md) | unsupported - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryOutputV2.md b/docs/v2/models/QueryOutputV2.md deleted file mode 100644 index 60d9d20c..00000000 --- a/docs/v2/models/QueryOutputV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryOutputV2 - -Details about the output of a query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data_type** | QueryDataType | Yes | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryOutputV2Dict.md b/docs/v2/models/QueryOutputV2Dict.md deleted file mode 100644 index 5f987c03..00000000 --- a/docs/v2/models/QueryOutputV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryOutputV2Dict - -Details about the output of a query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**dataType** | QueryDataTypeDict | Yes | | -**required** | StrictBool | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryParameterV2.md b/docs/v2/models/QueryParameterV2.md deleted file mode 100644 index 49b84e40..00000000 --- a/docs/v2/models/QueryParameterV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryParameterV2 - -Details about a parameter of a query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | Optional[StrictStr] | No | | -**data_type** | QueryDataType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryParameterV2Dict.md b/docs/v2/models/QueryParameterV2Dict.md deleted file mode 100644 index 054641ed..00000000 --- a/docs/v2/models/QueryParameterV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryParameterV2Dict - -Details about a parameter of a query. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**description** | NotRequired[StrictStr] | No | | -**dataType** | QueryDataTypeDict | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryRuntimeErrorParameter.md b/docs/v2/models/QueryRuntimeErrorParameter.md deleted file mode 100644 index 709cb429..00000000 --- a/docs/v2/models/QueryRuntimeErrorParameter.md +++ /dev/null @@ -1,11 +0,0 @@ -# QueryRuntimeErrorParameter - -QueryRuntimeErrorParameter - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QuerySetType.md b/docs/v2/models/QuerySetType.md deleted file mode 100644 index 1873681a..00000000 --- a/docs/v2/models/QuerySetType.md +++ /dev/null @@ -1,12 +0,0 @@ -# QuerySetType - -QuerySetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**sub_type** | QueryDataType | Yes | | -**type** | Literal["set"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QuerySetTypeDict.md b/docs/v2/models/QuerySetTypeDict.md deleted file mode 100644 index 60b1de88..00000000 --- a/docs/v2/models/QuerySetTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QuerySetTypeDict - -QuerySetType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**subType** | QueryDataTypeDict | Yes | | -**type** | Literal["set"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryStructField.md b/docs/v2/models/QueryStructField.md deleted file mode 100644 index 8d0630c5..00000000 --- a/docs/v2/models/QueryStructField.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryStructField - -QueryStructField - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StructFieldName | Yes | | -**field_type** | QueryDataType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryStructFieldDict.md b/docs/v2/models/QueryStructFieldDict.md deleted file mode 100644 index 8076e413..00000000 --- a/docs/v2/models/QueryStructFieldDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryStructFieldDict - -QueryStructField - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**name** | StructFieldName | Yes | | -**fieldType** | QueryDataTypeDict | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryStructType.md b/docs/v2/models/QueryStructType.md deleted file mode 100644 index e58283f0..00000000 --- a/docs/v2/models/QueryStructType.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryStructType - -QueryStructType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[QueryStructField] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryStructTypeDict.md b/docs/v2/models/QueryStructTypeDict.md deleted file mode 100644 index dc00e16c..00000000 --- a/docs/v2/models/QueryStructTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryStructTypeDict - -QueryStructType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[QueryStructFieldDict] | Yes | | -**type** | Literal["struct"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryThreeDimensionalAggregation.md b/docs/v2/models/QueryThreeDimensionalAggregation.md deleted file mode 100644 index 91314428..00000000 --- a/docs/v2/models/QueryThreeDimensionalAggregation.md +++ /dev/null @@ -1,11 +0,0 @@ -# QueryThreeDimensionalAggregation - -QueryThreeDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**groups** | List[NestedQueryAggregation] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryThreeDimensionalAggregationDict.md b/docs/v2/models/QueryThreeDimensionalAggregationDict.md deleted file mode 100644 index b9a0f784..00000000 --- a/docs/v2/models/QueryThreeDimensionalAggregationDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# QueryThreeDimensionalAggregationDict - -QueryThreeDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**groups** | List[NestedQueryAggregationDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryTwoDimensionalAggregation.md b/docs/v2/models/QueryTwoDimensionalAggregation.md deleted file mode 100644 index d9082cea..00000000 --- a/docs/v2/models/QueryTwoDimensionalAggregation.md +++ /dev/null @@ -1,11 +0,0 @@ -# QueryTwoDimensionalAggregation - -QueryTwoDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**groups** | List[QueryAggregation] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryTwoDimensionalAggregationDict.md b/docs/v2/models/QueryTwoDimensionalAggregationDict.md deleted file mode 100644 index afcde89b..00000000 --- a/docs/v2/models/QueryTwoDimensionalAggregationDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# QueryTwoDimensionalAggregationDict - -QueryTwoDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**groups** | List[QueryAggregationDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryType.md b/docs/v2/models/QueryType.md deleted file mode 100644 index 8fe7829a..00000000 --- a/docs/v2/models/QueryType.md +++ /dev/null @@ -1,17 +0,0 @@ -# QueryType - -Represents a query type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | QueryApiName | Yes | | -**description** | Optional[StrictStr] | No | | -**display_name** | Optional[DisplayName] | No | | -**parameters** | Dict[ParameterId, Parameter] | Yes | | -**output** | Optional[OntologyDataType] | No | | -**rid** | FunctionRid | Yes | | -**version** | FunctionVersion | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryTypeDict.md b/docs/v2/models/QueryTypeDict.md deleted file mode 100644 index e1e68b0f..00000000 --- a/docs/v2/models/QueryTypeDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# QueryTypeDict - -Represents a query type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | QueryApiName | Yes | | -**description** | NotRequired[StrictStr] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**parameters** | Dict[ParameterId, ParameterDict] | Yes | | -**output** | NotRequired[OntologyDataTypeDict] | No | | -**rid** | FunctionRid | Yes | | -**version** | FunctionVersion | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryTypeV2.md b/docs/v2/models/QueryTypeV2.md deleted file mode 100644 index f6081964..00000000 --- a/docs/v2/models/QueryTypeV2.md +++ /dev/null @@ -1,17 +0,0 @@ -# QueryTypeV2 - -Represents a query type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**api_name** | QueryApiName | Yes | | -**description** | Optional[StrictStr] | No | | -**display_name** | Optional[DisplayName] | No | | -**parameters** | Dict[ParameterId, QueryParameterV2] | Yes | | -**output** | QueryDataType | Yes | | -**rid** | FunctionRid | Yes | | -**version** | FunctionVersion | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryTypeV2Dict.md b/docs/v2/models/QueryTypeV2Dict.md deleted file mode 100644 index 47fe6a63..00000000 --- a/docs/v2/models/QueryTypeV2Dict.md +++ /dev/null @@ -1,17 +0,0 @@ -# QueryTypeV2Dict - -Represents a query type in the Ontology. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**apiName** | QueryApiName | Yes | | -**description** | NotRequired[StrictStr] | No | | -**displayName** | NotRequired[DisplayName] | No | | -**parameters** | Dict[ParameterId, QueryParameterV2Dict] | Yes | | -**output** | QueryDataTypeDict | Yes | | -**rid** | FunctionRid | Yes | | -**version** | FunctionVersion | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryUnionType.md b/docs/v2/models/QueryUnionType.md deleted file mode 100644 index 12540941..00000000 --- a/docs/v2/models/QueryUnionType.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryUnionType - -QueryUnionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**union_types** | List[QueryDataType] | Yes | | -**type** | Literal["union"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/QueryUnionTypeDict.md b/docs/v2/models/QueryUnionTypeDict.md deleted file mode 100644 index 1ea5d1b1..00000000 --- a/docs/v2/models/QueryUnionTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# QueryUnionTypeDict - -QueryUnionType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**unionTypes** | List[QueryDataTypeDict] | Yes | | -**type** | Literal["union"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RangeConstraint.md b/docs/v2/models/RangeConstraint.md deleted file mode 100644 index 367e0462..00000000 --- a/docs/v2/models/RangeConstraint.md +++ /dev/null @@ -1,16 +0,0 @@ -# RangeConstraint - -The parameter value must be within the defined range. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | Optional[Any] | No | Less than | -**lte** | Optional[Any] | No | Less than or equal | -**gt** | Optional[Any] | No | Greater than | -**gte** | Optional[Any] | No | Greater than or equal | -**type** | Literal["range"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RangeConstraintDict.md b/docs/v2/models/RangeConstraintDict.md deleted file mode 100644 index 7fc1ee4b..00000000 --- a/docs/v2/models/RangeConstraintDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# RangeConstraintDict - -The parameter value must be within the defined range. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Less than | -**lte** | NotRequired[Any] | No | Less than or equal | -**gt** | NotRequired[Any] | No | Greater than | -**gte** | NotRequired[Any] | No | Greater than or equal | -**type** | Literal["range"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Realm.md b/docs/v2/models/Realm.md deleted file mode 100644 index 0bc90b2d..00000000 --- a/docs/v2/models/Realm.md +++ /dev/null @@ -1,13 +0,0 @@ -# Realm - -Identifies which Realm a User or Group is a member of. -The `palantir-internal-realm` is used for Users or Groups that are created in Foundry by administrators and not associated with any SSO provider. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Reason.md b/docs/v2/models/Reason.md deleted file mode 100644 index ffd5d2ba..00000000 --- a/docs/v2/models/Reason.md +++ /dev/null @@ -1,12 +0,0 @@ -# Reason - -Reason - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**reason** | ReasonType | Yes | | -**type** | Literal["reason"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ReasonDict.md b/docs/v2/models/ReasonDict.md deleted file mode 100644 index a64b514d..00000000 --- a/docs/v2/models/ReasonDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReasonDict - -Reason - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**reason** | ReasonType | Yes | | -**type** | Literal["reason"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ReasonType.md b/docs/v2/models/ReasonType.md deleted file mode 100644 index 2093a214..00000000 --- a/docs/v2/models/ReasonType.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReasonType - -Represents the reason a subscription was closed. - - -| **Value** | -| --------- | -| `"USER_CLOSED"` | -| `"CHANNEL_CLOSED"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ReferenceUpdate.md b/docs/v2/models/ReferenceUpdate.md deleted file mode 100644 index 7105a66a..00000000 --- a/docs/v2/models/ReferenceUpdate.md +++ /dev/null @@ -1,18 +0,0 @@ -# ReferenceUpdate - -The updated data value associated with an object instance's external reference. The object instance -is uniquely identified by an object type and a primary key. Note that the value of the property -field returns a dereferenced value rather than the reference itself. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**object_type** | ObjectTypeApiName | Yes | | -**primary_key** | ObjectPrimaryKey | Yes | | -**property** | PropertyApiName | Yes | | -**value** | ReferenceValue | Yes | | -**type** | Literal["reference"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ReferenceUpdateDict.md b/docs/v2/models/ReferenceUpdateDict.md deleted file mode 100644 index 757a64d0..00000000 --- a/docs/v2/models/ReferenceUpdateDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# ReferenceUpdateDict - -The updated data value associated with an object instance's external reference. The object instance -is uniquely identified by an object type and a primary key. Note that the value of the property -field returns a dereferenced value rather than the reference itself. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**objectType** | ObjectTypeApiName | Yes | | -**primaryKey** | ObjectPrimaryKey | Yes | | -**property** | PropertyApiName | Yes | | -**value** | ReferenceValueDict | Yes | | -**type** | Literal["reference"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ReferenceValue.md b/docs/v2/models/ReferenceValue.md deleted file mode 100644 index 83c73701..00000000 --- a/docs/v2/models/ReferenceValue.md +++ /dev/null @@ -1,11 +0,0 @@ -# ReferenceValue - -Resolved data values pointed to by a reference. - -## Type -```python -GeotimeSeriesValue -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ReferenceValueDict.md b/docs/v2/models/ReferenceValueDict.md deleted file mode 100644 index b12aee2f..00000000 --- a/docs/v2/models/ReferenceValueDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ReferenceValueDict - -Resolved data values pointed to by a reference. - -## Type -```python -GeotimeSeriesValueDict -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RefreshObjectSet.md b/docs/v2/models/RefreshObjectSet.md deleted file mode 100644 index 54dba384..00000000 --- a/docs/v2/models/RefreshObjectSet.md +++ /dev/null @@ -1,14 +0,0 @@ -# RefreshObjectSet - -The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**object_type** | ObjectTypeApiName | Yes | | -**type** | Literal["refreshObjectSet"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RefreshObjectSetDict.md b/docs/v2/models/RefreshObjectSetDict.md deleted file mode 100644 index 50384e1f..00000000 --- a/docs/v2/models/RefreshObjectSetDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# RefreshObjectSetDict - -The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**objectType** | ObjectTypeApiName | Yes | | -**type** | Literal["refreshObjectSet"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RelativeTime.md b/docs/v2/models/RelativeTime.md deleted file mode 100644 index ec0120ca..00000000 --- a/docs/v2/models/RelativeTime.md +++ /dev/null @@ -1,14 +0,0 @@ -# RelativeTime - -A relative time, such as "3 days before" or "2 hours after" the current moment. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**when** | RelativeTimeRelation | Yes | | -**value** | StrictInt | Yes | | -**unit** | RelativeTimeSeriesTimeUnit | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RelativeTimeDict.md b/docs/v2/models/RelativeTimeDict.md deleted file mode 100644 index 489bbb20..00000000 --- a/docs/v2/models/RelativeTimeDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# RelativeTimeDict - -A relative time, such as "3 days before" or "2 hours after" the current moment. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**when** | RelativeTimeRelation | Yes | | -**value** | StrictInt | Yes | | -**unit** | RelativeTimeSeriesTimeUnit | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RelativeTimeRange.md b/docs/v2/models/RelativeTimeRange.md deleted file mode 100644 index 8d6dd937..00000000 --- a/docs/v2/models/RelativeTimeRange.md +++ /dev/null @@ -1,14 +0,0 @@ -# RelativeTimeRange - -A relative time range for a time series query. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**start_time** | Optional[RelativeTime] | No | | -**end_time** | Optional[RelativeTime] | No | | -**type** | Literal["relative"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RelativeTimeRangeDict.md b/docs/v2/models/RelativeTimeRangeDict.md deleted file mode 100644 index b6458836..00000000 --- a/docs/v2/models/RelativeTimeRangeDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# RelativeTimeRangeDict - -A relative time range for a time series query. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**startTime** | NotRequired[RelativeTimeDict] | No | | -**endTime** | NotRequired[RelativeTimeDict] | No | | -**type** | Literal["relative"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RelativeTimeRelation.md b/docs/v2/models/RelativeTimeRelation.md deleted file mode 100644 index 354930b3..00000000 --- a/docs/v2/models/RelativeTimeRelation.md +++ /dev/null @@ -1,11 +0,0 @@ -# RelativeTimeRelation - -RelativeTimeRelation - -| **Value** | -| --------- | -| `"BEFORE"` | -| `"AFTER"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RelativeTimeSeriesTimeUnit.md b/docs/v2/models/RelativeTimeSeriesTimeUnit.md deleted file mode 100644 index 8b68ec37..00000000 --- a/docs/v2/models/RelativeTimeSeriesTimeUnit.md +++ /dev/null @@ -1,17 +0,0 @@ -# RelativeTimeSeriesTimeUnit - -RelativeTimeSeriesTimeUnit - -| **Value** | -| --------- | -| `"MILLISECONDS"` | -| `"SECONDS"` | -| `"MINUTES"` | -| `"HOURS"` | -| `"DAYS"` | -| `"WEEKS"` | -| `"MONTHS"` | -| `"YEARS"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ReleaseStatus.md b/docs/v2/models/ReleaseStatus.md deleted file mode 100644 index 400247b0..00000000 --- a/docs/v2/models/ReleaseStatus.md +++ /dev/null @@ -1,12 +0,0 @@ -# ReleaseStatus - -The release status of the entity. - -| **Value** | -| --------- | -| `"ACTIVE"` | -| `"EXPERIMENTAL"` | -| `"DEPRECATED"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RemoveGroupMembersRequest.md b/docs/v2/models/RemoveGroupMembersRequest.md deleted file mode 100644 index 8912bd75..00000000 --- a/docs/v2/models/RemoveGroupMembersRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# RemoveGroupMembersRequest - -RemoveGroupMembersRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**principal_ids** | List[PrincipalId] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RemoveGroupMembersRequestDict.md b/docs/v2/models/RemoveGroupMembersRequestDict.md deleted file mode 100644 index c50375f4..00000000 --- a/docs/v2/models/RemoveGroupMembersRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# RemoveGroupMembersRequestDict - -RemoveGroupMembersRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**principalIds** | List[PrincipalId] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RequestId.md b/docs/v2/models/RequestId.md deleted file mode 100644 index c606137f..00000000 --- a/docs/v2/models/RequestId.md +++ /dev/null @@ -1,11 +0,0 @@ -# RequestId - -Unique request id - -## Type -```python -UUID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Resource.md b/docs/v2/models/Resource.md deleted file mode 100644 index 16db83ad..00000000 --- a/docs/v2/models/Resource.md +++ /dev/null @@ -1,24 +0,0 @@ -# Resource - -Resource - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ResourceRid | Yes | | -**display_name** | ResourceDisplayName | Yes | The display name of the Resource | -**description** | Optional[StrictStr] | No | The description of the Resource | -**documentation** | Optional[StrictStr] | No | The documentation associated with the Resource | -**path** | ResourcePath | Yes | The full path to the resource, including the resource name itself | -**type** | ResourceType | Yes | The type of the Resource derived from the Resource Identifier (RID). | -**created_by** | CreatedBy | Yes | The user that created the Resource. | -**updated_by** | UpdatedBy | Yes | The user that last updated the Resource. | -**created_time** | CreatedTime | Yes | The timestamp that the Resource was last created. | -**updated_time** | UpdatedTime | Yes | The timestamp that the Resource was last modified. For folders, this includes any of its descendants. For top level folders (spaces and projects), this is not updated by child updates for performance reasons. | -**trashed** | TrashedStatus | Yes | The trash status of the resource. If trashed, a resource can either be directly trashed or one of its ancestors can be trashed. | -**parent_folder_rid** | FolderRid | Yes | The parent folder Resource Identifier (RID). For projects, this will be the Space RID. | -**project_rid** | ProjectRid | Yes | The Project Resource Identifier (RID) that the Resource lives in. If the Resource itself is a Project, this value will still be populated with the Project RID. | -**space_rid** | SpaceRid | Yes | The Space Resource Identifier (RID) that the Resource lives in. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ResourceDict.md b/docs/v2/models/ResourceDict.md deleted file mode 100644 index 158e27fa..00000000 --- a/docs/v2/models/ResourceDict.md +++ /dev/null @@ -1,24 +0,0 @@ -# ResourceDict - -Resource - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ResourceRid | Yes | | -**displayName** | ResourceDisplayName | Yes | The display name of the Resource | -**description** | NotRequired[StrictStr] | No | The description of the Resource | -**documentation** | NotRequired[StrictStr] | No | The documentation associated with the Resource | -**path** | ResourcePath | Yes | The full path to the resource, including the resource name itself | -**type** | ResourceType | Yes | The type of the Resource derived from the Resource Identifier (RID). | -**createdBy** | CreatedBy | Yes | The user that created the Resource. | -**updatedBy** | UpdatedBy | Yes | The user that last updated the Resource. | -**createdTime** | CreatedTime | Yes | The timestamp that the Resource was last created. | -**updatedTime** | UpdatedTime | Yes | The timestamp that the Resource was last modified. For folders, this includes any of its descendants. For top level folders (spaces and projects), this is not updated by child updates for performance reasons. | -**trashed** | TrashedStatus | Yes | The trash status of the resource. If trashed, a resource can either be directly trashed or one of its ancestors can be trashed. | -**parentFolderRid** | FolderRid | Yes | The parent folder Resource Identifier (RID). For projects, this will be the Space RID. | -**projectRid** | ProjectRid | Yes | The Project Resource Identifier (RID) that the Resource lives in. If the Resource itself is a Project, this value will still be populated with the Project RID. | -**spaceRid** | SpaceRid | Yes | The Space Resource Identifier (RID) that the Resource lives in. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ResourceDisplayName.md b/docs/v2/models/ResourceDisplayName.md deleted file mode 100644 index d9bcdc33..00000000 --- a/docs/v2/models/ResourceDisplayName.md +++ /dev/null @@ -1,11 +0,0 @@ -# ResourceDisplayName - -The display name of the Resource - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ResourcePath.md b/docs/v2/models/ResourcePath.md deleted file mode 100644 index 8f5db17b..00000000 --- a/docs/v2/models/ResourcePath.md +++ /dev/null @@ -1,11 +0,0 @@ -# ResourcePath - -The full path to the resource, including the resource name itself - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ResourceRid.md b/docs/v2/models/ResourceRid.md deleted file mode 100644 index d210ef4b..00000000 --- a/docs/v2/models/ResourceRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ResourceRid - -The unique resource identifier (RID) of a Resource. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ResourceType.md b/docs/v2/models/ResourceType.md deleted file mode 100644 index d2f0d9c7..00000000 --- a/docs/v2/models/ResourceType.md +++ /dev/null @@ -1,58 +0,0 @@ -# ResourceType - -The type of a resource. - -| **Value** | -| --------- | -| `"Academy_Tutorial"` | -| `"Artifacts_Repository"` | -| `"Automate_Automation"` | -| `"Builder_Pipeline"` | -| `"Carbon_Workspace"` | -| `"Cipher_Channel"` | -| `"Code_Repository"` | -| `"Code_Workbook"` | -| `"Code_Workspace"` | -| `"Connectivity_Agent"` | -| `"Connectivity_Source"` | -| `"Connectivity_VirtualTable"` | -| `"Contour_Analysis"` | -| `"Data_Lineage_Graph"` | -| `"Datasets_Dataset"` | -| `"Filesystem_Document"` | -| `"Filesystem_Folder"` | -| `"Filesystem_Image"` | -| `"Filesystem_Project"` | -| `"Filesystem_Space"` | -| `"Filesystem_WebLink"` | -| `"Foundry_Form"` | -| `"Foundry_Report"` | -| `"Foundry_Template"` | -| `"FoundryRules_Workflow"` | -| `"Fusion_Document"` | -| `"Logic_Function"` | -| `"Machinery_ProcessGraph"` | -| `"Maps_Layer"` | -| `"Maps_Map"` | -| `"Marketplace_Installation"` | -| `"Marketplace_LocalStore"` | -| `"Marketplace_RemoteStore"` | -| `"Media_Set"` | -| `"Modeling_Model"` | -| `"Modeling_ModelVersion"` | -| `"Modeling_Objective"` | -| `"Monitoring_MonitoringView"` | -| `"Notepad_Document"` | -| `"Notepad_Template"` | -| `"ObjectExploration_Exploration"` | -| `"ObjectExploration_Layout"` | -| `"Quiver_Analysis"` | -| `"Slate_Application"` | -| `"SolutionDesigner_Diagram"` | -| `"ThirdPartyApplication_ThirdPartyApplication"` | -| `"Unknown"` | -| `"Vertex_Graph"` | -| `"Workshop_Module"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RetryBackoffDuration.md b/docs/v2/models/RetryBackoffDuration.md deleted file mode 100644 index 18b897e6..00000000 --- a/docs/v2/models/RetryBackoffDuration.md +++ /dev/null @@ -1,12 +0,0 @@ -# RetryBackoffDuration - -The duration to wait before retrying after a Job fails. - - -## Type -```python -Duration -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RetryBackoffDurationDict.md b/docs/v2/models/RetryBackoffDurationDict.md deleted file mode 100644 index e16c98ef..00000000 --- a/docs/v2/models/RetryBackoffDurationDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# RetryBackoffDurationDict - -The duration to wait before retrying after a Job fails. - - -## Type -```python -DurationDict -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/RetryCount.md b/docs/v2/models/RetryCount.md deleted file mode 100644 index ec7ed837..00000000 --- a/docs/v2/models/RetryCount.md +++ /dev/null @@ -1,14 +0,0 @@ -# RetryCount - -The number of retry attempts for failed Jobs within the Build. A Job's failure is not considered final until -all retries have been attempted or an error occurs indicating that retries cannot be performed. Be aware, -not all types of failures can be retried. - - -## Type -```python -StrictInt -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ReturnEditsMode.md b/docs/v2/models/ReturnEditsMode.md deleted file mode 100644 index 3d08ba54..00000000 --- a/docs/v2/models/ReturnEditsMode.md +++ /dev/null @@ -1,11 +0,0 @@ -# ReturnEditsMode - -ReturnEditsMode - -| **Value** | -| --------- | -| `"ALL"` | -| `"NONE"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Schedule.md b/docs/v2/models/Schedule.md deleted file mode 100644 index 390275c6..00000000 --- a/docs/v2/models/Schedule.md +++ /dev/null @@ -1,22 +0,0 @@ -# Schedule - -Schedule - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ScheduleRid | Yes | | -**display_name** | Optional[StrictStr] | No | | -**description** | Optional[StrictStr] | No | | -**current_version_rid** | ScheduleVersionRid | Yes | The RID of the current schedule version | -**created_time** | CreatedTime | Yes | | -**created_by** | CreatedBy | Yes | | -**updated_time** | UpdatedTime | Yes | | -**updated_by** | UpdatedBy | Yes | | -**paused** | SchedulePaused | Yes | | -**trigger** | Optional[Trigger] | No | The schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty. | -**action** | Action | Yes | | -**scope_mode** | ScopeMode | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SchedulePaused.md b/docs/v2/models/SchedulePaused.md deleted file mode 100644 index 0e143574..00000000 --- a/docs/v2/models/SchedulePaused.md +++ /dev/null @@ -1,11 +0,0 @@ -# SchedulePaused - -SchedulePaused - -## Type -```python -StrictBool -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRid.md b/docs/v2/models/ScheduleRid.md deleted file mode 100644 index bc5bffc8..00000000 --- a/docs/v2/models/ScheduleRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ScheduleRid - -The Resource Identifier (RID) of a Schedule. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunError.md b/docs/v2/models/ScheduleRunError.md deleted file mode 100644 index b756fb7e..00000000 --- a/docs/v2/models/ScheduleRunError.md +++ /dev/null @@ -1,13 +0,0 @@ -# ScheduleRunError - -An error occurred attempting to run the schedule. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**error_name** | ScheduleRunErrorName | Yes | | -**description** | StrictStr | Yes | | -**type** | Literal["error"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunErrorDict.md b/docs/v2/models/ScheduleRunErrorDict.md deleted file mode 100644 index a0fa2c1e..00000000 --- a/docs/v2/models/ScheduleRunErrorDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ScheduleRunErrorDict - -An error occurred attempting to run the schedule. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**errorName** | ScheduleRunErrorName | Yes | | -**description** | StrictStr | Yes | | -**type** | Literal["error"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunErrorName.md b/docs/v2/models/ScheduleRunErrorName.md deleted file mode 100644 index be465782..00000000 --- a/docs/v2/models/ScheduleRunErrorName.md +++ /dev/null @@ -1,16 +0,0 @@ -# ScheduleRunErrorName - -ScheduleRunErrorName - -| **Value** | -| --------- | -| `"TargetResolutionFailure"` | -| `"CyclicDependency"` | -| `"IncompatibleTargets"` | -| `"PermissionDenied"` | -| `"JobSpecNotFound"` | -| `"ScheduleOwnerNotFound"` | -| `"Internal"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunIgnored.md b/docs/v2/models/ScheduleRunIgnored.md deleted file mode 100644 index 42330450..00000000 --- a/docs/v2/models/ScheduleRunIgnored.md +++ /dev/null @@ -1,12 +0,0 @@ -# ScheduleRunIgnored - -The schedule is not running as all targets are up-to-date. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["ignored"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunIgnoredDict.md b/docs/v2/models/ScheduleRunIgnoredDict.md deleted file mode 100644 index dee3ecee..00000000 --- a/docs/v2/models/ScheduleRunIgnoredDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ScheduleRunIgnoredDict - -The schedule is not running as all targets are up-to-date. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["ignored"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunResult.md b/docs/v2/models/ScheduleRunResult.md deleted file mode 100644 index 91a09e50..00000000 --- a/docs/v2/models/ScheduleRunResult.md +++ /dev/null @@ -1,19 +0,0 @@ -# ScheduleRunResult - -The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, -ignored if all targets are up-to-date or error. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ScheduleRunSubmitted](ScheduleRunSubmitted.md) | submitted -[ScheduleRunIgnored](ScheduleRunIgnored.md) | ignored -[ScheduleRunError](ScheduleRunError.md) | error - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunResultDict.md b/docs/v2/models/ScheduleRunResultDict.md deleted file mode 100644 index 0f4f51af..00000000 --- a/docs/v2/models/ScheduleRunResultDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# ScheduleRunResultDict - -The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, -ignored if all targets are up-to-date or error. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ScheduleRunSubmittedDict](ScheduleRunSubmittedDict.md) | submitted -[ScheduleRunIgnoredDict](ScheduleRunIgnoredDict.md) | ignored -[ScheduleRunErrorDict](ScheduleRunErrorDict.md) | error - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunRid.md b/docs/v2/models/ScheduleRunRid.md deleted file mode 100644 index ab78a1f7..00000000 --- a/docs/v2/models/ScheduleRunRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ScheduleRunRid - -The RID of a schedule run - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunSubmitted.md b/docs/v2/models/ScheduleRunSubmitted.md deleted file mode 100644 index 295df56d..00000000 --- a/docs/v2/models/ScheduleRunSubmitted.md +++ /dev/null @@ -1,12 +0,0 @@ -# ScheduleRunSubmitted - -The schedule has been successfully triggered. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**build_rid** | BuildRid | Yes | | -**type** | Literal["submitted"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleRunSubmittedDict.md b/docs/v2/models/ScheduleRunSubmittedDict.md deleted file mode 100644 index 6bf7c843..00000000 --- a/docs/v2/models/ScheduleRunSubmittedDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# ScheduleRunSubmittedDict - -The schedule has been successfully triggered. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**buildRid** | BuildRid | Yes | | -**type** | Literal["submitted"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleSucceededTrigger.md b/docs/v2/models/ScheduleSucceededTrigger.md deleted file mode 100644 index 374d0e30..00000000 --- a/docs/v2/models/ScheduleSucceededTrigger.md +++ /dev/null @@ -1,14 +0,0 @@ -# ScheduleSucceededTrigger - -Trigger whenever the specified schedule completes its action -successfully. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**schedule_rid** | ScheduleRid | Yes | | -**type** | Literal["scheduleSucceeded"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleSucceededTriggerDict.md b/docs/v2/models/ScheduleSucceededTriggerDict.md deleted file mode 100644 index ec402931..00000000 --- a/docs/v2/models/ScheduleSucceededTriggerDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# ScheduleSucceededTriggerDict - -Trigger whenever the specified schedule completes its action -successfully. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**scheduleRid** | ScheduleRid | Yes | | -**type** | Literal["scheduleSucceeded"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleVersion.md b/docs/v2/models/ScheduleVersion.md deleted file mode 100644 index 184d0098..00000000 --- a/docs/v2/models/ScheduleVersion.md +++ /dev/null @@ -1,11 +0,0 @@ -# ScheduleVersion - -ScheduleVersion - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ScheduleVersionRid | Yes | The RID of a schedule version | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleVersionDict.md b/docs/v2/models/ScheduleVersionDict.md deleted file mode 100644 index 7c1c58a7..00000000 --- a/docs/v2/models/ScheduleVersionDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ScheduleVersionDict - -ScheduleVersion - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ScheduleVersionRid | Yes | The RID of a schedule version | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScheduleVersionRid.md b/docs/v2/models/ScheduleVersionRid.md deleted file mode 100644 index 3deb69c5..00000000 --- a/docs/v2/models/ScheduleVersionRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ScheduleVersionRid - -The RID of a schedule version - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScopeMode.md b/docs/v2/models/ScopeMode.md deleted file mode 100644 index b460c113..00000000 --- a/docs/v2/models/ScopeMode.md +++ /dev/null @@ -1,16 +0,0 @@ -# ScopeMode - -The boundaries for the schedule build. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[UserScope](UserScope.md) | user -[ProjectScope](ProjectScope.md) | project - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ScopeModeDict.md b/docs/v2/models/ScopeModeDict.md deleted file mode 100644 index 88ecb4cd..00000000 --- a/docs/v2/models/ScopeModeDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# ScopeModeDict - -The boundaries for the schedule build. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[UserScopeDict](UserScopeDict.md) | user -[ProjectScopeDict](ProjectScopeDict.md) | project - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SdkPackageName.md b/docs/v2/models/SdkPackageName.md deleted file mode 100644 index 40346fff..00000000 --- a/docs/v2/models/SdkPackageName.md +++ /dev/null @@ -1,11 +0,0 @@ -# SdkPackageName - -SdkPackageName - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchGroupsRequest.md b/docs/v2/models/SearchGroupsRequest.md deleted file mode 100644 index eaaef127..00000000 --- a/docs/v2/models/SearchGroupsRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchGroupsRequest - -SearchGroupsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**where** | GroupSearchFilter | Yes | | -**page_size** | Optional[PageSize] | No | | -**page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchGroupsRequestDict.md b/docs/v2/models/SearchGroupsRequestDict.md deleted file mode 100644 index f01be6f3..00000000 --- a/docs/v2/models/SearchGroupsRequestDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchGroupsRequestDict - -SearchGroupsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**where** | GroupSearchFilterDict | Yes | | -**pageSize** | NotRequired[PageSize] | No | | -**pageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchGroupsResponse.md b/docs/v2/models/SearchGroupsResponse.md deleted file mode 100644 index f07b1fe3..00000000 --- a/docs/v2/models/SearchGroupsResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchGroupsResponse - -SearchGroupsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[Group] | Yes | | -**next_page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchGroupsResponseDict.md b/docs/v2/models/SearchGroupsResponseDict.md deleted file mode 100644 index cbb52354..00000000 --- a/docs/v2/models/SearchGroupsResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchGroupsResponseDict - -SearchGroupsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[GroupDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchJsonQuery.md b/docs/v2/models/SearchJsonQuery.md deleted file mode 100644 index 537e73b3..00000000 --- a/docs/v2/models/SearchJsonQuery.md +++ /dev/null @@ -1,28 +0,0 @@ -# SearchJsonQuery - -SearchJsonQuery - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[LtQuery](LtQuery.md) | lt -[GtQuery](GtQuery.md) | gt -[LteQuery](LteQuery.md) | lte -[GteQuery](GteQuery.md) | gte -[EqualsQuery](EqualsQuery.md) | eq -[IsNullQuery](IsNullQuery.md) | isNull -[ContainsQuery](ContainsQuery.md) | contains -[AndQuery](AndQuery.md) | and -[OrQuery](OrQuery.md) | or -[NotQuery](NotQuery.md) | not -[PrefixQuery](PrefixQuery.md) | prefix -[PhraseQuery](PhraseQuery.md) | phrase -[AnyTermQuery](AnyTermQuery.md) | anyTerm -[AllTermsQuery](AllTermsQuery.md) | allTerms - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchJsonQueryDict.md b/docs/v2/models/SearchJsonQueryDict.md deleted file mode 100644 index 652a2d91..00000000 --- a/docs/v2/models/SearchJsonQueryDict.md +++ /dev/null @@ -1,28 +0,0 @@ -# SearchJsonQueryDict - -SearchJsonQuery - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[LtQueryDict](LtQueryDict.md) | lt -[GtQueryDict](GtQueryDict.md) | gt -[LteQueryDict](LteQueryDict.md) | lte -[GteQueryDict](GteQueryDict.md) | gte -[EqualsQueryDict](EqualsQueryDict.md) | eq -[IsNullQueryDict](IsNullQueryDict.md) | isNull -[ContainsQueryDict](ContainsQueryDict.md) | contains -[AndQueryDict](AndQueryDict.md) | and -[OrQueryDict](OrQueryDict.md) | or -[NotQueryDict](NotQueryDict.md) | not -[PrefixQueryDict](PrefixQueryDict.md) | prefix -[PhraseQueryDict](PhraseQueryDict.md) | phrase -[AnyTermQueryDict](AnyTermQueryDict.md) | anyTerm -[AllTermsQueryDict](AllTermsQueryDict.md) | allTerms - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchJsonQueryV2.md b/docs/v2/models/SearchJsonQueryV2.md deleted file mode 100644 index fc92ce74..00000000 --- a/docs/v2/models/SearchJsonQueryV2.md +++ /dev/null @@ -1,36 +0,0 @@ -# SearchJsonQueryV2 - -SearchJsonQueryV2 - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[LtQueryV2](LtQueryV2.md) | lt -[GtQueryV2](GtQueryV2.md) | gt -[LteQueryV2](LteQueryV2.md) | lte -[GteQueryV2](GteQueryV2.md) | gte -[EqualsQueryV2](EqualsQueryV2.md) | eq -[IsNullQueryV2](IsNullQueryV2.md) | isNull -[ContainsQueryV2](ContainsQueryV2.md) | contains -[AndQueryV2](AndQueryV2.md) | and -[OrQueryV2](OrQueryV2.md) | or -[NotQueryV2](NotQueryV2.md) | not -[StartsWithQuery](StartsWithQuery.md) | startsWith -[ContainsAllTermsInOrderQuery](ContainsAllTermsInOrderQuery.md) | containsAllTermsInOrder -[ContainsAllTermsInOrderPrefixLastTerm](ContainsAllTermsInOrderPrefixLastTerm.md) | containsAllTermsInOrderPrefixLastTerm -[ContainsAnyTermQuery](ContainsAnyTermQuery.md) | containsAnyTerm -[ContainsAllTermsQuery](ContainsAllTermsQuery.md) | containsAllTerms -[WithinDistanceOfQuery](WithinDistanceOfQuery.md) | withinDistanceOf -[WithinBoundingBoxQuery](WithinBoundingBoxQuery.md) | withinBoundingBox -[IntersectsBoundingBoxQuery](IntersectsBoundingBoxQuery.md) | intersectsBoundingBox -[DoesNotIntersectBoundingBoxQuery](DoesNotIntersectBoundingBoxQuery.md) | doesNotIntersectBoundingBox -[WithinPolygonQuery](WithinPolygonQuery.md) | withinPolygon -[IntersectsPolygonQuery](IntersectsPolygonQuery.md) | intersectsPolygon -[DoesNotIntersectPolygonQuery](DoesNotIntersectPolygonQuery.md) | doesNotIntersectPolygon - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchJsonQueryV2Dict.md b/docs/v2/models/SearchJsonQueryV2Dict.md deleted file mode 100644 index a640accc..00000000 --- a/docs/v2/models/SearchJsonQueryV2Dict.md +++ /dev/null @@ -1,36 +0,0 @@ -# SearchJsonQueryV2Dict - -SearchJsonQueryV2 - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[LtQueryV2Dict](LtQueryV2Dict.md) | lt -[GtQueryV2Dict](GtQueryV2Dict.md) | gt -[LteQueryV2Dict](LteQueryV2Dict.md) | lte -[GteQueryV2Dict](GteQueryV2Dict.md) | gte -[EqualsQueryV2Dict](EqualsQueryV2Dict.md) | eq -[IsNullQueryV2Dict](IsNullQueryV2Dict.md) | isNull -[ContainsQueryV2Dict](ContainsQueryV2Dict.md) | contains -[AndQueryV2Dict](AndQueryV2Dict.md) | and -[OrQueryV2Dict](OrQueryV2Dict.md) | or -[NotQueryV2Dict](NotQueryV2Dict.md) | not -[StartsWithQueryDict](StartsWithQueryDict.md) | startsWith -[ContainsAllTermsInOrderQueryDict](ContainsAllTermsInOrderQueryDict.md) | containsAllTermsInOrder -[ContainsAllTermsInOrderPrefixLastTermDict](ContainsAllTermsInOrderPrefixLastTermDict.md) | containsAllTermsInOrderPrefixLastTerm -[ContainsAnyTermQueryDict](ContainsAnyTermQueryDict.md) | containsAnyTerm -[ContainsAllTermsQueryDict](ContainsAllTermsQueryDict.md) | containsAllTerms -[WithinDistanceOfQueryDict](WithinDistanceOfQueryDict.md) | withinDistanceOf -[WithinBoundingBoxQueryDict](WithinBoundingBoxQueryDict.md) | withinBoundingBox -[IntersectsBoundingBoxQueryDict](IntersectsBoundingBoxQueryDict.md) | intersectsBoundingBox -[DoesNotIntersectBoundingBoxQueryDict](DoesNotIntersectBoundingBoxQueryDict.md) | doesNotIntersectBoundingBox -[WithinPolygonQueryDict](WithinPolygonQueryDict.md) | withinPolygon -[IntersectsPolygonQueryDict](IntersectsPolygonQueryDict.md) | intersectsPolygon -[DoesNotIntersectPolygonQueryDict](DoesNotIntersectPolygonQueryDict.md) | doesNotIntersectPolygon - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchObjectsForInterfaceRequest.md b/docs/v2/models/SearchObjectsForInterfaceRequest.md deleted file mode 100644 index 0f5e0767..00000000 --- a/docs/v2/models/SearchObjectsForInterfaceRequest.md +++ /dev/null @@ -1,19 +0,0 @@ -# SearchObjectsForInterfaceRequest - -SearchObjectsForInterfaceRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**where** | Optional[SearchJsonQueryV2] | No | | -**order_by** | Optional[SearchOrderByV2] | No | | -**augmented_properties** | Dict[ObjectTypeApiName, List[PropertyApiName]] | Yes | A map from object type API name to a list of property type API names. For each returned object, if the object’s object type is a key in the map, then we augment the response for that object type with the list of properties specified in the value. | -**augmented_shared_property_types** | Dict[InterfaceTypeApiName, List[SharedPropertyTypeApiName]] | Yes | A map from interface type API name to a list of shared property type API names. For each returned object, if the object implements an interface that is a key in the map, then we augment the response for that object type with the list of properties specified in the value. | -**selected_shared_property_types** | List[SharedPropertyTypeApiName] | Yes | A list of shared property type API names of the interface type that should be included in the response. Omit this parameter to include all properties of the interface type in the response. | -**selected_object_types** | List[ObjectTypeApiName] | Yes | A list of object type API names that should be included in the response. If non-empty, object types that are not mentioned will not be included in the response even if they implement the specified interface. Omit the parameter to include all object types. | -**other_interface_types** | List[InterfaceTypeApiName] | Yes | A list of interface type API names. Object types must implement all the mentioned interfaces in order to be included in the response. | -**page_size** | Optional[PageSize] | No | | -**page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchObjectsForInterfaceRequestDict.md b/docs/v2/models/SearchObjectsForInterfaceRequestDict.md deleted file mode 100644 index 1c559fea..00000000 --- a/docs/v2/models/SearchObjectsForInterfaceRequestDict.md +++ /dev/null @@ -1,19 +0,0 @@ -# SearchObjectsForInterfaceRequestDict - -SearchObjectsForInterfaceRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**where** | NotRequired[SearchJsonQueryV2Dict] | No | | -**orderBy** | NotRequired[SearchOrderByV2Dict] | No | | -**augmentedProperties** | Dict[ObjectTypeApiName, List[PropertyApiName]] | Yes | A map from object type API name to a list of property type API names. For each returned object, if the object’s object type is a key in the map, then we augment the response for that object type with the list of properties specified in the value. | -**augmentedSharedPropertyTypes** | Dict[InterfaceTypeApiName, List[SharedPropertyTypeApiName]] | Yes | A map from interface type API name to a list of shared property type API names. For each returned object, if the object implements an interface that is a key in the map, then we augment the response for that object type with the list of properties specified in the value. | -**selectedSharedPropertyTypes** | List[SharedPropertyTypeApiName] | Yes | A list of shared property type API names of the interface type that should be included in the response. Omit this parameter to include all properties of the interface type in the response. | -**selectedObjectTypes** | List[ObjectTypeApiName] | Yes | A list of object type API names that should be included in the response. If non-empty, object types that are not mentioned will not be included in the response even if they implement the specified interface. Omit the parameter to include all object types. | -**otherInterfaceTypes** | List[InterfaceTypeApiName] | Yes | A list of interface type API names. Object types must implement all the mentioned interfaces in order to be included in the response. | -**pageSize** | NotRequired[PageSize] | No | | -**pageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchObjectsRequest.md b/docs/v2/models/SearchObjectsRequest.md deleted file mode 100644 index 1f38b717..00000000 --- a/docs/v2/models/SearchObjectsRequest.md +++ /dev/null @@ -1,15 +0,0 @@ -# SearchObjectsRequest - -SearchObjectsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | SearchJsonQuery | Yes | | -**order_by** | Optional[SearchOrderBy] | No | | -**page_size** | Optional[PageSize] | No | | -**page_token** | Optional[PageToken] | No | | -**fields** | List[PropertyApiName] | Yes | The API names of the object type properties to include in the response. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchObjectsRequestDict.md b/docs/v2/models/SearchObjectsRequestDict.md deleted file mode 100644 index 57fd5bf6..00000000 --- a/docs/v2/models/SearchObjectsRequestDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# SearchObjectsRequestDict - -SearchObjectsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**query** | SearchJsonQueryDict | Yes | | -**orderBy** | NotRequired[SearchOrderByDict] | No | | -**pageSize** | NotRequired[PageSize] | No | | -**pageToken** | NotRequired[PageToken] | No | | -**fields** | List[PropertyApiName] | Yes | The API names of the object type properties to include in the response. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchObjectsRequestV2.md b/docs/v2/models/SearchObjectsRequestV2.md deleted file mode 100644 index c49f2f56..00000000 --- a/docs/v2/models/SearchObjectsRequestV2.md +++ /dev/null @@ -1,16 +0,0 @@ -# SearchObjectsRequestV2 - -SearchObjectsRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**where** | Optional[SearchJsonQueryV2] | No | | -**order_by** | Optional[SearchOrderByV2] | No | | -**page_size** | Optional[PageSize] | No | | -**page_token** | Optional[PageToken] | No | | -**select** | List[PropertyApiName] | Yes | The API names of the object type properties to include in the response. | -**exclude_rid** | Optional[StrictBool] | No | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchObjectsRequestV2Dict.md b/docs/v2/models/SearchObjectsRequestV2Dict.md deleted file mode 100644 index fc362f71..00000000 --- a/docs/v2/models/SearchObjectsRequestV2Dict.md +++ /dev/null @@ -1,16 +0,0 @@ -# SearchObjectsRequestV2Dict - -SearchObjectsRequestV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**where** | NotRequired[SearchJsonQueryV2Dict] | No | | -**orderBy** | NotRequired[SearchOrderByV2Dict] | No | | -**pageSize** | NotRequired[PageSize] | No | | -**pageToken** | NotRequired[PageToken] | No | | -**select** | List[PropertyApiName] | Yes | The API names of the object type properties to include in the response. | -**excludeRid** | NotRequired[StrictBool] | No | A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchObjectsResponse.md b/docs/v2/models/SearchObjectsResponse.md deleted file mode 100644 index 2a08a77c..00000000 --- a/docs/v2/models/SearchObjectsResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchObjectsResponse - -SearchObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObject] | Yes | | -**next_page_token** | Optional[PageToken] | No | | -**total_count** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchObjectsResponseDict.md b/docs/v2/models/SearchObjectsResponseDict.md deleted file mode 100644 index 8495582f..00000000 --- a/docs/v2/models/SearchObjectsResponseDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchObjectsResponseDict - -SearchObjectsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchObjectsResponseV2.md b/docs/v2/models/SearchObjectsResponseV2.md deleted file mode 100644 index e888ebb2..00000000 --- a/docs/v2/models/SearchObjectsResponseV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchObjectsResponseV2 - -SearchObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | | -**next_page_token** | Optional[PageToken] | No | | -**total_count** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchObjectsResponseV2Dict.md b/docs/v2/models/SearchObjectsResponseV2Dict.md deleted file mode 100644 index 9e572efb..00000000 --- a/docs/v2/models/SearchObjectsResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchObjectsResponseV2Dict - -SearchObjectsResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[OntologyObjectV2] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | -**totalCount** | TotalCount | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchOrderBy.md b/docs/v2/models/SearchOrderBy.md deleted file mode 100644 index 67338673..00000000 --- a/docs/v2/models/SearchOrderBy.md +++ /dev/null @@ -1,11 +0,0 @@ -# SearchOrderBy - -Specifies the ordering of search results by a field and an ordering direction. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[SearchOrdering] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchOrderByDict.md b/docs/v2/models/SearchOrderByDict.md deleted file mode 100644 index fdb9a85d..00000000 --- a/docs/v2/models/SearchOrderByDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# SearchOrderByDict - -Specifies the ordering of search results by a field and an ordering direction. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[SearchOrderingDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchOrderByV2.md b/docs/v2/models/SearchOrderByV2.md deleted file mode 100644 index ffb53a0b..00000000 --- a/docs/v2/models/SearchOrderByV2.md +++ /dev/null @@ -1,11 +0,0 @@ -# SearchOrderByV2 - -Specifies the ordering of search results by a field and an ordering direction. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[SearchOrderingV2] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchOrderByV2Dict.md b/docs/v2/models/SearchOrderByV2Dict.md deleted file mode 100644 index 13b550a3..00000000 --- a/docs/v2/models/SearchOrderByV2Dict.md +++ /dev/null @@ -1,11 +0,0 @@ -# SearchOrderByV2Dict - -Specifies the ordering of search results by a field and an ordering direction. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**fields** | List[SearchOrderingV2Dict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchOrdering.md b/docs/v2/models/SearchOrdering.md deleted file mode 100644 index b084dc38..00000000 --- a/docs/v2/models/SearchOrdering.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchOrdering - -SearchOrdering - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**direction** | Optional[StrictStr] | No | Specifies the ordering direction (can be either `asc` or `desc`) | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchOrderingDict.md b/docs/v2/models/SearchOrderingDict.md deleted file mode 100644 index f78cb008..00000000 --- a/docs/v2/models/SearchOrderingDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchOrderingDict - -SearchOrdering - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**direction** | NotRequired[StrictStr] | No | Specifies the ordering direction (can be either `asc` or `desc`) | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchOrderingV2.md b/docs/v2/models/SearchOrderingV2.md deleted file mode 100644 index 73458177..00000000 --- a/docs/v2/models/SearchOrderingV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchOrderingV2 - -SearchOrderingV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**direction** | Optional[StrictStr] | No | Specifies the ordering direction (can be either `asc` or `desc`) | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchOrderingV2Dict.md b/docs/v2/models/SearchOrderingV2Dict.md deleted file mode 100644 index 01617810..00000000 --- a/docs/v2/models/SearchOrderingV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchOrderingV2Dict - -SearchOrderingV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**direction** | NotRequired[StrictStr] | No | Specifies the ordering direction (can be either `asc` or `desc`) | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchUsersRequest.md b/docs/v2/models/SearchUsersRequest.md deleted file mode 100644 index 9fcfb123..00000000 --- a/docs/v2/models/SearchUsersRequest.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchUsersRequest - -SearchUsersRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**where** | UserSearchFilter | Yes | | -**page_size** | Optional[PageSize] | No | | -**page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchUsersRequestDict.md b/docs/v2/models/SearchUsersRequestDict.md deleted file mode 100644 index 45c676bd..00000000 --- a/docs/v2/models/SearchUsersRequestDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SearchUsersRequestDict - -SearchUsersRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**where** | UserSearchFilterDict | Yes | | -**pageSize** | NotRequired[PageSize] | No | | -**pageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchUsersResponse.md b/docs/v2/models/SearchUsersResponse.md deleted file mode 100644 index 3146cba6..00000000 --- a/docs/v2/models/SearchUsersResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchUsersResponse - -SearchUsersResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[User] | Yes | | -**next_page_token** | Optional[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SearchUsersResponseDict.md b/docs/v2/models/SearchUsersResponseDict.md deleted file mode 100644 index 1836c12e..00000000 --- a/docs/v2/models/SearchUsersResponseDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SearchUsersResponseDict - -SearchUsersResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[UserDict] | Yes | | -**nextPageToken** | NotRequired[PageToken] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SelectedPropertyApiName.md b/docs/v2/models/SelectedPropertyApiName.md deleted file mode 100644 index 3860d8ae..00000000 --- a/docs/v2/models/SelectedPropertyApiName.md +++ /dev/null @@ -1,26 +0,0 @@ -# SelectedPropertyApiName - -By default, anytime an object is requested, every property belonging to that object is returned. -The response can be filtered to only include certain properties using the `properties` query parameter. - -Properties to include can be specified in one of two ways. - -- A comma delimited list as the value for the `properties` query parameter - `properties={property1ApiName},{property2ApiName}` -- Multiple `properties` query parameters. - `properties={property1ApiName}&properties={property2ApiName}` - -The primary key of the object will always be returned even if it wasn't specified in the `properties` values. - -Unknown properties specified in the `properties` list will result in a `PropertiesNotFound` error. - -To find the API name for your property, use the `Get object type` endpoint or check the **Ontology Manager**. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SharedPropertyType.md b/docs/v2/models/SharedPropertyType.md deleted file mode 100644 index b13c7b7f..00000000 --- a/docs/v2/models/SharedPropertyType.md +++ /dev/null @@ -1,15 +0,0 @@ -# SharedPropertyType - -A property type that can be shared across object types. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | SharedPropertyTypeRid | Yes | | -**api_name** | SharedPropertyTypeApiName | Yes | | -**display_name** | DisplayName | Yes | | -**description** | Optional[StrictStr] | No | A short text that describes the SharedPropertyType. | -**data_type** | ObjectPropertyType | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SharedPropertyTypeApiName.md b/docs/v2/models/SharedPropertyTypeApiName.md deleted file mode 100644 index da14b0e2..00000000 --- a/docs/v2/models/SharedPropertyTypeApiName.md +++ /dev/null @@ -1,13 +0,0 @@ -# SharedPropertyTypeApiName - -The name of the shared property type in the API in lowerCamelCase format. To find the API name for your -shared property type, use the `List shared property types` endpoint or check the **Ontology Manager**. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SharedPropertyTypeDict.md b/docs/v2/models/SharedPropertyTypeDict.md deleted file mode 100644 index 4b7e8a2c..00000000 --- a/docs/v2/models/SharedPropertyTypeDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# SharedPropertyTypeDict - -A property type that can be shared across object types. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | SharedPropertyTypeRid | Yes | | -**apiName** | SharedPropertyTypeApiName | Yes | | -**displayName** | DisplayName | Yes | | -**description** | NotRequired[StrictStr] | No | A short text that describes the SharedPropertyType. | -**dataType** | ObjectPropertyTypeDict | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SharedPropertyTypeRid.md b/docs/v2/models/SharedPropertyTypeRid.md deleted file mode 100644 index 0213e2dc..00000000 --- a/docs/v2/models/SharedPropertyTypeRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# SharedPropertyTypeRid - -The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ShortType.md b/docs/v2/models/ShortType.md deleted file mode 100644 index 22adc988..00000000 --- a/docs/v2/models/ShortType.md +++ /dev/null @@ -1,11 +0,0 @@ -# ShortType - -ShortType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["short"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ShortTypeDict.md b/docs/v2/models/ShortTypeDict.md deleted file mode 100644 index 1f2c5b7d..00000000 --- a/docs/v2/models/ShortTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ShortTypeDict - -ShortType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["short"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SizeBytes.md b/docs/v2/models/SizeBytes.md deleted file mode 100644 index 8ff1f1d8..00000000 --- a/docs/v2/models/SizeBytes.md +++ /dev/null @@ -1,11 +0,0 @@ -# SizeBytes - -The size of the file or attachment in bytes. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Space.md b/docs/v2/models/Space.md deleted file mode 100644 index 77e536b9..00000000 --- a/docs/v2/models/Space.md +++ /dev/null @@ -1,11 +0,0 @@ -# Space - -Space - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | SpaceRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SpaceDict.md b/docs/v2/models/SpaceDict.md deleted file mode 100644 index 63e530ac..00000000 --- a/docs/v2/models/SpaceDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# SpaceDict - -Space - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | SpaceRid | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SpaceRid.md b/docs/v2/models/SpaceRid.md deleted file mode 100644 index 8ec5c9fe..00000000 --- a/docs/v2/models/SpaceRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# SpaceRid - -The unique resource identifier (RID) of a Space. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StartsWithQuery.md b/docs/v2/models/StartsWithQuery.md deleted file mode 100644 index 8c340d37..00000000 --- a/docs/v2/models/StartsWithQuery.md +++ /dev/null @@ -1,13 +0,0 @@ -# StartsWithQuery - -Returns objects where the specified field starts with the provided value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["startsWith"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StartsWithQueryDict.md b/docs/v2/models/StartsWithQueryDict.md deleted file mode 100644 index cc91506e..00000000 --- a/docs/v2/models/StartsWithQueryDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# StartsWithQueryDict - -Returns objects where the specified field starts with the provided value. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | StrictStr | Yes | | -**type** | Literal["startsWith"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StreamMessage.md b/docs/v2/models/StreamMessage.md deleted file mode 100644 index 19ca1df6..00000000 --- a/docs/v2/models/StreamMessage.md +++ /dev/null @@ -1,18 +0,0 @@ -# StreamMessage - -StreamMessage - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectSetSubscribeResponses](ObjectSetSubscribeResponses.md) | subscribeResponses -[ObjectSetUpdates](ObjectSetUpdates.md) | objectSetChanged -[RefreshObjectSet](RefreshObjectSet.md) | refreshObjectSet -[SubscriptionClosed](SubscriptionClosed.md) | subscriptionClosed - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StreamMessageDict.md b/docs/v2/models/StreamMessageDict.md deleted file mode 100644 index a739fb6f..00000000 --- a/docs/v2/models/StreamMessageDict.md +++ /dev/null @@ -1,18 +0,0 @@ -# StreamMessageDict - -StreamMessage - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ObjectSetSubscribeResponsesDict](ObjectSetSubscribeResponsesDict.md) | subscribeResponses -[ObjectSetUpdatesDict](ObjectSetUpdatesDict.md) | objectSetChanged -[RefreshObjectSetDict](RefreshObjectSetDict.md) | refreshObjectSet -[SubscriptionClosedDict](SubscriptionClosedDict.md) | subscriptionClosed - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StreamTimeSeriesPointsRequest.md b/docs/v2/models/StreamTimeSeriesPointsRequest.md deleted file mode 100644 index e87b9f8f..00000000 --- a/docs/v2/models/StreamTimeSeriesPointsRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# StreamTimeSeriesPointsRequest - -StreamTimeSeriesPointsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**range** | Optional[TimeRange] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StreamTimeSeriesPointsRequestDict.md b/docs/v2/models/StreamTimeSeriesPointsRequestDict.md deleted file mode 100644 index b3bd0963..00000000 --- a/docs/v2/models/StreamTimeSeriesPointsRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# StreamTimeSeriesPointsRequestDict - -StreamTimeSeriesPointsRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**range** | NotRequired[TimeRangeDict] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StreamTimeSeriesPointsResponse.md b/docs/v2/models/StreamTimeSeriesPointsResponse.md deleted file mode 100644 index cc6391c4..00000000 --- a/docs/v2/models/StreamTimeSeriesPointsResponse.md +++ /dev/null @@ -1,11 +0,0 @@ -# StreamTimeSeriesPointsResponse - -StreamTimeSeriesPointsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[TimeSeriesPoint] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StreamTimeSeriesPointsResponseDict.md b/docs/v2/models/StreamTimeSeriesPointsResponseDict.md deleted file mode 100644 index 6d9ab7a6..00000000 --- a/docs/v2/models/StreamTimeSeriesPointsResponseDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# StreamTimeSeriesPointsResponseDict - -StreamTimeSeriesPointsResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**data** | List[TimeSeriesPointDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StringLengthConstraint.md b/docs/v2/models/StringLengthConstraint.md deleted file mode 100644 index 2f1a3503..00000000 --- a/docs/v2/models/StringLengthConstraint.md +++ /dev/null @@ -1,17 +0,0 @@ -# StringLengthConstraint - -The parameter value must have a length within the defined range. -*This range is always inclusive.* - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | Optional[Any] | No | Less than | -**lte** | Optional[Any] | No | Less than or equal | -**gt** | Optional[Any] | No | Greater than | -**gte** | Optional[Any] | No | Greater than or equal | -**type** | Literal["stringLength"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StringLengthConstraintDict.md b/docs/v2/models/StringLengthConstraintDict.md deleted file mode 100644 index 75589b8b..00000000 --- a/docs/v2/models/StringLengthConstraintDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# StringLengthConstraintDict - -The parameter value must have a length within the defined range. -*This range is always inclusive.* - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**lt** | NotRequired[Any] | No | Less than | -**lte** | NotRequired[Any] | No | Less than or equal | -**gt** | NotRequired[Any] | No | Greater than | -**gte** | NotRequired[Any] | No | Greater than or equal | -**type** | Literal["stringLength"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StringRegexMatchConstraint.md b/docs/v2/models/StringRegexMatchConstraint.md deleted file mode 100644 index 4ae62504..00000000 --- a/docs/v2/models/StringRegexMatchConstraint.md +++ /dev/null @@ -1,14 +0,0 @@ -# StringRegexMatchConstraint - -The parameter value must match a predefined regular expression. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**regex** | StrictStr | Yes | The regular expression configured in the **Ontology Manager**. | -**configured_failure_message** | Optional[StrictStr] | No | The message indicating that the regular expression was not matched. This is configured per parameter in the **Ontology Manager**. | -**type** | Literal["stringRegexMatch"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StringRegexMatchConstraintDict.md b/docs/v2/models/StringRegexMatchConstraintDict.md deleted file mode 100644 index f0c0d725..00000000 --- a/docs/v2/models/StringRegexMatchConstraintDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# StringRegexMatchConstraintDict - -The parameter value must match a predefined regular expression. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**regex** | StrictStr | Yes | The regular expression configured in the **Ontology Manager**. | -**configuredFailureMessage** | NotRequired[StrictStr] | No | The message indicating that the regular expression was not matched. This is configured per parameter in the **Ontology Manager**. | -**type** | Literal["stringRegexMatch"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StringType.md b/docs/v2/models/StringType.md deleted file mode 100644 index 15fca78c..00000000 --- a/docs/v2/models/StringType.md +++ /dev/null @@ -1,11 +0,0 @@ -# StringType - -StringType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["string"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StringTypeDict.md b/docs/v2/models/StringTypeDict.md deleted file mode 100644 index 61db0139..00000000 --- a/docs/v2/models/StringTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# StringTypeDict - -StringType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["string"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/StructFieldName.md b/docs/v2/models/StructFieldName.md deleted file mode 100644 index 967dacaa..00000000 --- a/docs/v2/models/StructFieldName.md +++ /dev/null @@ -1,12 +0,0 @@ -# StructFieldName - -The name of a field in a `Struct`. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Subdomain.md b/docs/v2/models/Subdomain.md deleted file mode 100644 index 07b94549..00000000 --- a/docs/v2/models/Subdomain.md +++ /dev/null @@ -1,11 +0,0 @@ -# Subdomain - -A subdomain from which a website is served. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SubmissionCriteriaEvaluation.md b/docs/v2/models/SubmissionCriteriaEvaluation.md deleted file mode 100644 index 3306c2ac..00000000 --- a/docs/v2/models/SubmissionCriteriaEvaluation.md +++ /dev/null @@ -1,15 +0,0 @@ -# SubmissionCriteriaEvaluation - -Contains the status of the **submission criteria**. -**Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. -These are configured in the **Ontology Manager**. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**configured_failure_message** | Optional[StrictStr] | No | The message indicating one of the **submission criteria** was not satisfied. This is configured per **submission criteria** in the **Ontology Manager**. | -**result** | ValidationResult | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SubmissionCriteriaEvaluationDict.md b/docs/v2/models/SubmissionCriteriaEvaluationDict.md deleted file mode 100644 index 5e7bd622..00000000 --- a/docs/v2/models/SubmissionCriteriaEvaluationDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# SubmissionCriteriaEvaluationDict - -Contains the status of the **submission criteria**. -**Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. -These are configured in the **Ontology Manager**. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**configuredFailureMessage** | NotRequired[StrictStr] | No | The message indicating one of the **submission criteria** was not satisfied. This is configured per **submission criteria** in the **Ontology Manager**. | -**result** | ValidationResult | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SubscriptionClosed.md b/docs/v2/models/SubscriptionClosed.md deleted file mode 100644 index 9411b2ba..00000000 --- a/docs/v2/models/SubscriptionClosed.md +++ /dev/null @@ -1,14 +0,0 @@ -# SubscriptionClosed - -The subscription has been closed due to an irrecoverable error during its lifecycle. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**cause** | SubscriptionClosureCause | Yes | | -**type** | Literal["subscriptionClosed"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SubscriptionClosedDict.md b/docs/v2/models/SubscriptionClosedDict.md deleted file mode 100644 index eaa8178d..00000000 --- a/docs/v2/models/SubscriptionClosedDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# SubscriptionClosedDict - -The subscription has been closed due to an irrecoverable error during its lifecycle. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**cause** | SubscriptionClosureCauseDict | Yes | | -**type** | Literal["subscriptionClosed"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SubscriptionClosureCause.md b/docs/v2/models/SubscriptionClosureCause.md deleted file mode 100644 index e07c09b4..00000000 --- a/docs/v2/models/SubscriptionClosureCause.md +++ /dev/null @@ -1,16 +0,0 @@ -# SubscriptionClosureCause - -SubscriptionClosureCause - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[Error](Error.md) | error -[Reason](Reason.md) | reason - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SubscriptionClosureCauseDict.md b/docs/v2/models/SubscriptionClosureCauseDict.md deleted file mode 100644 index 424b85f9..00000000 --- a/docs/v2/models/SubscriptionClosureCauseDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# SubscriptionClosureCauseDict - -SubscriptionClosureCause - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[ErrorDict](ErrorDict.md) | error -[ReasonDict](ReasonDict.md) | reason - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SubscriptionError.md b/docs/v2/models/SubscriptionError.md deleted file mode 100644 index 187c5908..00000000 --- a/docs/v2/models/SubscriptionError.md +++ /dev/null @@ -1,12 +0,0 @@ -# SubscriptionError - -SubscriptionError - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**errors** | List[Error] | Yes | | -**type** | Literal["error"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SubscriptionErrorDict.md b/docs/v2/models/SubscriptionErrorDict.md deleted file mode 100644 index dd437bb4..00000000 --- a/docs/v2/models/SubscriptionErrorDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SubscriptionErrorDict - -SubscriptionError - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**errors** | List[ErrorDict] | Yes | | -**type** | Literal["error"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SubscriptionId.md b/docs/v2/models/SubscriptionId.md deleted file mode 100644 index 8a07f33a..00000000 --- a/docs/v2/models/SubscriptionId.md +++ /dev/null @@ -1,11 +0,0 @@ -# SubscriptionId - -A unique identifier used to associate subscription requests with responses. - -## Type -```python -UUID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SubscriptionSuccess.md b/docs/v2/models/SubscriptionSuccess.md deleted file mode 100644 index 58cc7ab9..00000000 --- a/docs/v2/models/SubscriptionSuccess.md +++ /dev/null @@ -1,12 +0,0 @@ -# SubscriptionSuccess - -SubscriptionSuccess - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**type** | Literal["success"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SubscriptionSuccessDict.md b/docs/v2/models/SubscriptionSuccessDict.md deleted file mode 100644 index 3da740d3..00000000 --- a/docs/v2/models/SubscriptionSuccessDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SubscriptionSuccessDict - -SubscriptionSuccess - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | SubscriptionId | Yes | | -**type** | Literal["success"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SumAggregation.md b/docs/v2/models/SumAggregation.md deleted file mode 100644 index 929d52dc..00000000 --- a/docs/v2/models/SumAggregation.md +++ /dev/null @@ -1,13 +0,0 @@ -# SumAggregation - -Computes the sum of values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**type** | Literal["sum"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SumAggregationDict.md b/docs/v2/models/SumAggregationDict.md deleted file mode 100644 index 7e5d5fde..00000000 --- a/docs/v2/models/SumAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# SumAggregationDict - -Computes the sum of values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | FieldNameV1 | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**type** | Literal["sum"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SumAggregationV2.md b/docs/v2/models/SumAggregationV2.md deleted file mode 100644 index 16d2a65a..00000000 --- a/docs/v2/models/SumAggregationV2.md +++ /dev/null @@ -1,14 +0,0 @@ -# SumAggregationV2 - -Computes the sum of values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | Optional[AggregationMetricName] | No | | -**direction** | Optional[OrderByDirection] | No | | -**type** | Literal["sum"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SumAggregationV2Dict.md b/docs/v2/models/SumAggregationV2Dict.md deleted file mode 100644 index 408e1b57..00000000 --- a/docs/v2/models/SumAggregationV2Dict.md +++ /dev/null @@ -1,14 +0,0 @@ -# SumAggregationV2Dict - -Computes the sum of values for the provided field. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**name** | NotRequired[AggregationMetricName] | No | | -**direction** | NotRequired[OrderByDirection] | No | | -**type** | Literal["sum"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SyncApplyActionResponseV2.md b/docs/v2/models/SyncApplyActionResponseV2.md deleted file mode 100644 index 8a244a76..00000000 --- a/docs/v2/models/SyncApplyActionResponseV2.md +++ /dev/null @@ -1,12 +0,0 @@ -# SyncApplyActionResponseV2 - -SyncApplyActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**validation** | Optional[ValidateActionResponseV2] | No | | -**edits** | Optional[ActionResults] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/SyncApplyActionResponseV2Dict.md b/docs/v2/models/SyncApplyActionResponseV2Dict.md deleted file mode 100644 index d677b99b..00000000 --- a/docs/v2/models/SyncApplyActionResponseV2Dict.md +++ /dev/null @@ -1,12 +0,0 @@ -# SyncApplyActionResponseV2Dict - -SyncApplyActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**validation** | NotRequired[ValidateActionResponseV2Dict] | No | | -**edits** | NotRequired[ActionResultsDict] | No | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TableExportFormat.md b/docs/v2/models/TableExportFormat.md deleted file mode 100644 index 7f4ac6b2..00000000 --- a/docs/v2/models/TableExportFormat.md +++ /dev/null @@ -1,12 +0,0 @@ -# TableExportFormat - -Format for tabular dataset export. - - -| **Value** | -| --------- | -| `"ARROW"` | -| `"CSV"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ThirdPartyApplication.md b/docs/v2/models/ThirdPartyApplication.md deleted file mode 100644 index 29a717fe..00000000 --- a/docs/v2/models/ThirdPartyApplication.md +++ /dev/null @@ -1,11 +0,0 @@ -# ThirdPartyApplication - -ThirdPartyApplication - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ThirdPartyApplicationRid | Yes | An RID identifying a third-party application created in Developer Console. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ThirdPartyApplicationDict.md b/docs/v2/models/ThirdPartyApplicationDict.md deleted file mode 100644 index 06775b7a..00000000 --- a/docs/v2/models/ThirdPartyApplicationDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ThirdPartyApplicationDict - -ThirdPartyApplication - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | ThirdPartyApplicationRid | Yes | An RID identifying a third-party application created in Developer Console. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ThirdPartyApplicationRid.md b/docs/v2/models/ThirdPartyApplicationRid.md deleted file mode 100644 index ac1dac21..00000000 --- a/docs/v2/models/ThirdPartyApplicationRid.md +++ /dev/null @@ -1,11 +0,0 @@ -# ThirdPartyApplicationRid - -An RID identifying a third-party application created in Developer Console. - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ThreeDimensionalAggregation.md b/docs/v2/models/ThreeDimensionalAggregation.md deleted file mode 100644 index 46b88bce..00000000 --- a/docs/v2/models/ThreeDimensionalAggregation.md +++ /dev/null @@ -1,13 +0,0 @@ -# ThreeDimensionalAggregation - -ThreeDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key_type** | QueryAggregationKeyType | Yes | | -**value_type** | TwoDimensionalAggregation | Yes | | -**type** | Literal["threeDimensionalAggregation"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ThreeDimensionalAggregationDict.md b/docs/v2/models/ThreeDimensionalAggregationDict.md deleted file mode 100644 index 2a1354d4..00000000 --- a/docs/v2/models/ThreeDimensionalAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ThreeDimensionalAggregationDict - -ThreeDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyType** | QueryAggregationKeyTypeDict | Yes | | -**valueType** | TwoDimensionalAggregationDict | Yes | | -**type** | Literal["threeDimensionalAggregation"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TimeRange.md b/docs/v2/models/TimeRange.md deleted file mode 100644 index a68362fa..00000000 --- a/docs/v2/models/TimeRange.md +++ /dev/null @@ -1,16 +0,0 @@ -# TimeRange - -An absolute or relative range for a time series query. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AbsoluteTimeRange](AbsoluteTimeRange.md) | absolute -[RelativeTimeRange](RelativeTimeRange.md) | relative - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TimeRangeDict.md b/docs/v2/models/TimeRangeDict.md deleted file mode 100644 index 850b64eb..00000000 --- a/docs/v2/models/TimeRangeDict.md +++ /dev/null @@ -1,16 +0,0 @@ -# TimeRangeDict - -An absolute or relative range for a time series query. - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AbsoluteTimeRangeDict](AbsoluteTimeRangeDict.md) | absolute -[RelativeTimeRangeDict](RelativeTimeRangeDict.md) | relative - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TimeSeriesItemType.md b/docs/v2/models/TimeSeriesItemType.md deleted file mode 100644 index 588926f6..00000000 --- a/docs/v2/models/TimeSeriesItemType.md +++ /dev/null @@ -1,17 +0,0 @@ -# TimeSeriesItemType - -A union of the types supported by time series properties. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[DoubleType](DoubleType.md) | double -[StringType](StringType.md) | string - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TimeSeriesItemTypeDict.md b/docs/v2/models/TimeSeriesItemTypeDict.md deleted file mode 100644 index 2dda9a72..00000000 --- a/docs/v2/models/TimeSeriesItemTypeDict.md +++ /dev/null @@ -1,17 +0,0 @@ -# TimeSeriesItemTypeDict - -A union of the types supported by time series properties. - - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[DoubleTypeDict](DoubleTypeDict.md) | double -[StringTypeDict](StringTypeDict.md) | string - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TimeSeriesPoint.md b/docs/v2/models/TimeSeriesPoint.md deleted file mode 100644 index 5eac8779..00000000 --- a/docs/v2/models/TimeSeriesPoint.md +++ /dev/null @@ -1,13 +0,0 @@ -# TimeSeriesPoint - -A time and value pair. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**time** | datetime | Yes | An ISO 8601 timestamp | -**value** | Any | Yes | An object which is either an enum String or a double number. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TimeSeriesPointDict.md b/docs/v2/models/TimeSeriesPointDict.md deleted file mode 100644 index b82708cc..00000000 --- a/docs/v2/models/TimeSeriesPointDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# TimeSeriesPointDict - -A time and value pair. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**time** | datetime | Yes | An ISO 8601 timestamp | -**value** | Any | Yes | An object which is either an enum String or a double number. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TimeTrigger.md b/docs/v2/models/TimeTrigger.md deleted file mode 100644 index 92b5dd93..00000000 --- a/docs/v2/models/TimeTrigger.md +++ /dev/null @@ -1,13 +0,0 @@ -# TimeTrigger - -Trigger on a time based schedule. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**cron_expression** | CronExpression | Yes | | -**time_zone** | ZoneId | Yes | | -**type** | Literal["time"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TimeTriggerDict.md b/docs/v2/models/TimeTriggerDict.md deleted file mode 100644 index 57244069..00000000 --- a/docs/v2/models/TimeTriggerDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# TimeTriggerDict - -Trigger on a time based schedule. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**cronExpression** | CronExpression | Yes | | -**timeZone** | ZoneId | Yes | | -**type** | Literal["time"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TimeUnit.md b/docs/v2/models/TimeUnit.md deleted file mode 100644 index 337a0ab4..00000000 --- a/docs/v2/models/TimeUnit.md +++ /dev/null @@ -1,17 +0,0 @@ -# TimeUnit - -TimeUnit - -| **Value** | -| --------- | -| `"MILLISECONDS"` | -| `"SECONDS"` | -| `"MINUTES"` | -| `"HOURS"` | -| `"DAYS"` | -| `"WEEKS"` | -| `"MONTHS"` | -| `"YEARS"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TimeseriesType.md b/docs/v2/models/TimeseriesType.md deleted file mode 100644 index dc7ae959..00000000 --- a/docs/v2/models/TimeseriesType.md +++ /dev/null @@ -1,12 +0,0 @@ -# TimeseriesType - -TimeseriesType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**item_type** | TimeSeriesItemType | Yes | | -**type** | Literal["timeseries"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TimeseriesTypeDict.md b/docs/v2/models/TimeseriesTypeDict.md deleted file mode 100644 index 936c5963..00000000 --- a/docs/v2/models/TimeseriesTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# TimeseriesTypeDict - -TimeseriesType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**itemType** | TimeSeriesItemTypeDict | Yes | | -**type** | Literal["timeseries"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TimestampType.md b/docs/v2/models/TimestampType.md deleted file mode 100644 index 9cdc5335..00000000 --- a/docs/v2/models/TimestampType.md +++ /dev/null @@ -1,11 +0,0 @@ -# TimestampType - -TimestampType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["timestamp"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TimestampTypeDict.md b/docs/v2/models/TimestampTypeDict.md deleted file mode 100644 index e86178f4..00000000 --- a/docs/v2/models/TimestampTypeDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# TimestampTypeDict - -TimestampType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["timestamp"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TotalCount.md b/docs/v2/models/TotalCount.md deleted file mode 100644 index 6a521afa..00000000 --- a/docs/v2/models/TotalCount.md +++ /dev/null @@ -1,12 +0,0 @@ -# TotalCount - -The total number of items across all pages. - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Transaction.md b/docs/v2/models/Transaction.md deleted file mode 100644 index 8dcb1fd5..00000000 --- a/docs/v2/models/Transaction.md +++ /dev/null @@ -1,15 +0,0 @@ -# Transaction - -Transaction - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | TransactionRid | Yes | | -**transaction_type** | TransactionType | Yes | | -**status** | TransactionStatus | Yes | | -**created_time** | TransactionCreatedTime | Yes | The timestamp when the transaction was created, in ISO 8601 timestamp format. | -**closed_time** | Optional[datetime] | No | The timestamp when the transaction was closed, in ISO 8601 timestamp format. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TransactionCreatedTime.md b/docs/v2/models/TransactionCreatedTime.md deleted file mode 100644 index 1e40d035..00000000 --- a/docs/v2/models/TransactionCreatedTime.md +++ /dev/null @@ -1,12 +0,0 @@ -# TransactionCreatedTime - -The timestamp when the transaction was created, in ISO 8601 timestamp format. - - -## Type -```python -datetime -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TransactionDict.md b/docs/v2/models/TransactionDict.md deleted file mode 100644 index 3f97e25e..00000000 --- a/docs/v2/models/TransactionDict.md +++ /dev/null @@ -1,15 +0,0 @@ -# TransactionDict - -Transaction - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**rid** | TransactionRid | Yes | | -**transactionType** | TransactionType | Yes | | -**status** | TransactionStatus | Yes | | -**createdTime** | TransactionCreatedTime | Yes | The timestamp when the transaction was created, in ISO 8601 timestamp format. | -**closedTime** | NotRequired[datetime] | No | The timestamp when the transaction was closed, in ISO 8601 timestamp format. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TransactionRid.md b/docs/v2/models/TransactionRid.md deleted file mode 100644 index 736a2f44..00000000 --- a/docs/v2/models/TransactionRid.md +++ /dev/null @@ -1,12 +0,0 @@ -# TransactionRid - -The Resource Identifier (RID) of a Transaction. - - -## Type -```python -RID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TransactionStatus.md b/docs/v2/models/TransactionStatus.md deleted file mode 100644 index 8eacda4b..00000000 --- a/docs/v2/models/TransactionStatus.md +++ /dev/null @@ -1,13 +0,0 @@ -# TransactionStatus - -The status of a Transaction. - - -| **Value** | -| --------- | -| `"ABORTED"` | -| `"COMMITTED"` | -| `"OPEN"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TransactionType.md b/docs/v2/models/TransactionType.md deleted file mode 100644 index 203bb469..00000000 --- a/docs/v2/models/TransactionType.md +++ /dev/null @@ -1,14 +0,0 @@ -# TransactionType - -The type of a Transaction. - - -| **Value** | -| --------- | -| `"APPEND"` | -| `"UPDATE"` | -| `"SNAPSHOT"` | -| `"DELETE"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TrashedStatus.md b/docs/v2/models/TrashedStatus.md deleted file mode 100644 index 95fea99c..00000000 --- a/docs/v2/models/TrashedStatus.md +++ /dev/null @@ -1,12 +0,0 @@ -# TrashedStatus - -TrashedStatus - -| **Value** | -| --------- | -| `"DIRECTLY_TRASHED"` | -| `"ANCESTOR_TRASHED"` | -| `"NOT_TRASHED"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Trigger.md b/docs/v2/models/Trigger.md deleted file mode 100644 index 39b3393f..00000000 --- a/docs/v2/models/Trigger.md +++ /dev/null @@ -1,22 +0,0 @@ -# Trigger - -Trigger - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AndTrigger](AndTrigger.md) | and -[OrTrigger](OrTrigger.md) | or -[TimeTrigger](TimeTrigger.md) | time -[DatasetUpdatedTrigger](DatasetUpdatedTrigger.md) | datasetUpdated -[NewLogicTrigger](NewLogicTrigger.md) | newLogic -[JobSucceededTrigger](JobSucceededTrigger.md) | jobSucceeded -[ScheduleSucceededTrigger](ScheduleSucceededTrigger.md) | scheduleSucceeded -[MediaSetUpdatedTrigger](MediaSetUpdatedTrigger.md) | mediaSetUpdated - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TriggerDict.md b/docs/v2/models/TriggerDict.md deleted file mode 100644 index 4b791657..00000000 --- a/docs/v2/models/TriggerDict.md +++ /dev/null @@ -1,22 +0,0 @@ -# TriggerDict - -Trigger - -This is a discriminator type and does not contain any fields. Instead, it is a union -of of the models listed below. - -This discriminator class uses the `type` field to differentiate between classes. - -| Class | Value -| ------------ | ------------- -[AndTriggerDict](AndTriggerDict.md) | and -[OrTriggerDict](OrTriggerDict.md) | or -[TimeTriggerDict](TimeTriggerDict.md) | time -[DatasetUpdatedTriggerDict](DatasetUpdatedTriggerDict.md) | datasetUpdated -[NewLogicTriggerDict](NewLogicTriggerDict.md) | newLogic -[JobSucceededTriggerDict](JobSucceededTriggerDict.md) | jobSucceeded -[ScheduleSucceededTriggerDict](ScheduleSucceededTriggerDict.md) | scheduleSucceeded -[MediaSetUpdatedTriggerDict](MediaSetUpdatedTriggerDict.md) | mediaSetUpdated - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TwoDimensionalAggregation.md b/docs/v2/models/TwoDimensionalAggregation.md deleted file mode 100644 index 5b8e95fb..00000000 --- a/docs/v2/models/TwoDimensionalAggregation.md +++ /dev/null @@ -1,13 +0,0 @@ -# TwoDimensionalAggregation - -TwoDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**key_type** | QueryAggregationKeyType | Yes | | -**value_type** | QueryAggregationValueType | Yes | | -**type** | Literal["twoDimensionalAggregation"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/TwoDimensionalAggregationDict.md b/docs/v2/models/TwoDimensionalAggregationDict.md deleted file mode 100644 index a162dae3..00000000 --- a/docs/v2/models/TwoDimensionalAggregationDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# TwoDimensionalAggregationDict - -TwoDimensionalAggregation - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**keyType** | QueryAggregationKeyTypeDict | Yes | | -**valueType** | QueryAggregationValueTypeDict | Yes | | -**type** | Literal["twoDimensionalAggregation"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/UnevaluableConstraint.md b/docs/v2/models/UnevaluableConstraint.md deleted file mode 100644 index c4523615..00000000 --- a/docs/v2/models/UnevaluableConstraint.md +++ /dev/null @@ -1,13 +0,0 @@ -# UnevaluableConstraint - -The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. -This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["unevaluable"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/UnevaluableConstraintDict.md b/docs/v2/models/UnevaluableConstraintDict.md deleted file mode 100644 index dfe47933..00000000 --- a/docs/v2/models/UnevaluableConstraintDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# UnevaluableConstraintDict - -The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. -This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["unevaluable"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/UnsupportedType.md b/docs/v2/models/UnsupportedType.md deleted file mode 100644 index 10fc2c33..00000000 --- a/docs/v2/models/UnsupportedType.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnsupportedType - -UnsupportedType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**unsupported_type** | StrictStr | Yes | | -**type** | Literal["unsupported"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/UnsupportedTypeDict.md b/docs/v2/models/UnsupportedTypeDict.md deleted file mode 100644 index f80837d5..00000000 --- a/docs/v2/models/UnsupportedTypeDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# UnsupportedTypeDict - -UnsupportedType - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**unsupportedType** | StrictStr | Yes | | -**type** | Literal["unsupported"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/UpdatedBy.md b/docs/v2/models/UpdatedBy.md deleted file mode 100644 index 10f93865..00000000 --- a/docs/v2/models/UpdatedBy.md +++ /dev/null @@ -1,11 +0,0 @@ -# UpdatedBy - -The Foundry user who last updated this resource - -## Type -```python -UserId -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/UpdatedTime.md b/docs/v2/models/UpdatedTime.md deleted file mode 100644 index fe55dad8..00000000 --- a/docs/v2/models/UpdatedTime.md +++ /dev/null @@ -1,12 +0,0 @@ -# UpdatedTime - -The time at which the resource was most recently updated. - - -## Type -```python -datetime -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/UpstreamTarget.md b/docs/v2/models/UpstreamTarget.md deleted file mode 100644 index 57c1e6b7..00000000 --- a/docs/v2/models/UpstreamTarget.md +++ /dev/null @@ -1,13 +0,0 @@ -# UpstreamTarget - -Target the specified datasets along with all upstream datasets except the ignored datasets. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**dataset_rids** | List[DatasetRid] | Yes | The target datasets. | -**ignored_dataset_rids** | List[DatasetRid] | Yes | The datasets to ignore when calculating the final set of dataset to build. | -**type** | Literal["upstream"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/UpstreamTargetDict.md b/docs/v2/models/UpstreamTargetDict.md deleted file mode 100644 index 0033134d..00000000 --- a/docs/v2/models/UpstreamTargetDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# UpstreamTargetDict - -Target the specified datasets along with all upstream datasets except the ignored datasets. - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**datasetRids** | List[DatasetRid] | Yes | The target datasets. | -**ignoredDatasetRids** | List[DatasetRid] | Yes | The datasets to ignore when calculating the final set of dataset to build. | -**type** | Literal["upstream"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/User.md b/docs/v2/models/User.md deleted file mode 100644 index 75052693..00000000 --- a/docs/v2/models/User.md +++ /dev/null @@ -1,18 +0,0 @@ -# User - -User - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**id** | PrincipalId | Yes | | -**username** | UserUsername | Yes | The Foundry username of the User. This is unique within the realm. | -**given_name** | Optional[StrictStr] | No | The given name of the User. | -**family_name** | Optional[StrictStr] | No | The family name (last name) of the User. | -**email** | Optional[StrictStr] | No | The email at which to contact a User. Multiple users may have the same email address. | -**realm** | Realm | Yes | | -**organization** | Optional[OrganizationRid] | No | The RID of the user's primary Organization. This will be blank for third-party application service users. | -**attributes** | Dict[AttributeName, AttributeValues] | Yes | A map of the User's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. Additional attributes may be configured by Foundry administrators in Control Panel and populated by the User's SSO provider upon login. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/UserId.md b/docs/v2/models/UserId.md deleted file mode 100644 index ecd03e50..00000000 --- a/docs/v2/models/UserId.md +++ /dev/null @@ -1,11 +0,0 @@ -# UserId - -A Foundry User ID. - -## Type -```python -UUID -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/UserScope.md b/docs/v2/models/UserScope.md deleted file mode 100644 index 000ee37a..00000000 --- a/docs/v2/models/UserScope.md +++ /dev/null @@ -1,13 +0,0 @@ -# UserScope - -When triggered, the schedule will build all resources that the -associated user is permitted to build. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["user"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/UserScopeDict.md b/docs/v2/models/UserScopeDict.md deleted file mode 100644 index ed732bbd..00000000 --- a/docs/v2/models/UserScopeDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# UserScopeDict - -When triggered, the schedule will build all resources that the -associated user is permitted to build. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | Literal["user"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/UserSearchFilter.md b/docs/v2/models/UserSearchFilter.md deleted file mode 100644 index 42c4815b..00000000 --- a/docs/v2/models/UserSearchFilter.md +++ /dev/null @@ -1,12 +0,0 @@ -# UserSearchFilter - -UserSearchFilter - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | PrincipalFilterType | Yes | | -**value** | StrictStr | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/UserSearchFilterDict.md b/docs/v2/models/UserSearchFilterDict.md deleted file mode 100644 index 43df3eb5..00000000 --- a/docs/v2/models/UserSearchFilterDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# UserSearchFilterDict - -UserSearchFilter - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**type** | PrincipalFilterType | Yes | | -**value** | StrictStr | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/UserUsername.md b/docs/v2/models/UserUsername.md deleted file mode 100644 index faca3281..00000000 --- a/docs/v2/models/UserUsername.md +++ /dev/null @@ -1,11 +0,0 @@ -# UserUsername - -The Foundry username of the User. This is unique within the realm. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ValidateActionRequest.md b/docs/v2/models/ValidateActionRequest.md deleted file mode 100644 index 80e5eb4c..00000000 --- a/docs/v2/models/ValidateActionRequest.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValidateActionRequest - -ValidateActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ValidateActionRequestDict.md b/docs/v2/models/ValidateActionRequestDict.md deleted file mode 100644 index b7958f61..00000000 --- a/docs/v2/models/ValidateActionRequestDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# ValidateActionRequestDict - -ValidateActionRequest - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ValidateActionResponse.md b/docs/v2/models/ValidateActionResponse.md deleted file mode 100644 index 1d3b833d..00000000 --- a/docs/v2/models/ValidateActionResponse.md +++ /dev/null @@ -1,13 +0,0 @@ -# ValidateActionResponse - -ValidateActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**submission_criteria** | List[SubmissionCriteriaEvaluation] | Yes | | -**parameters** | Dict[ParameterId, ParameterEvaluationResult] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ValidateActionResponseDict.md b/docs/v2/models/ValidateActionResponseDict.md deleted file mode 100644 index 040c900a..00000000 --- a/docs/v2/models/ValidateActionResponseDict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ValidateActionResponseDict - -ValidateActionResponse - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**submissionCriteria** | List[SubmissionCriteriaEvaluationDict] | Yes | | -**parameters** | Dict[ParameterId, ParameterEvaluationResultDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ValidateActionResponseV2.md b/docs/v2/models/ValidateActionResponseV2.md deleted file mode 100644 index 9aae7b48..00000000 --- a/docs/v2/models/ValidateActionResponseV2.md +++ /dev/null @@ -1,13 +0,0 @@ -# ValidateActionResponseV2 - -ValidateActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**submission_criteria** | List[SubmissionCriteriaEvaluation] | Yes | | -**parameters** | Dict[ParameterId, ParameterEvaluationResult] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ValidateActionResponseV2Dict.md b/docs/v2/models/ValidateActionResponseV2Dict.md deleted file mode 100644 index 2acb8218..00000000 --- a/docs/v2/models/ValidateActionResponseV2Dict.md +++ /dev/null @@ -1,13 +0,0 @@ -# ValidateActionResponseV2Dict - -ValidateActionResponseV2 - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**result** | ValidationResult | Yes | | -**submissionCriteria** | List[SubmissionCriteriaEvaluationDict] | Yes | | -**parameters** | Dict[ParameterId, ParameterEvaluationResultDict] | Yes | | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ValidationResult.md b/docs/v2/models/ValidationResult.md deleted file mode 100644 index 0bf3692f..00000000 --- a/docs/v2/models/ValidationResult.md +++ /dev/null @@ -1,12 +0,0 @@ -# ValidationResult - -Represents the state of a validation. - - -| **Value** | -| --------- | -| `"VALID"` | -| `"INVALID"` | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ValueType.md b/docs/v2/models/ValueType.md deleted file mode 100644 index d9d27542..00000000 --- a/docs/v2/models/ValueType.md +++ /dev/null @@ -1,33 +0,0 @@ -# ValueType - -A string indicating the type of each data value. Note that these types can be nested, for example an array of -structs. - -| Type | JSON value | -|---------------------|-------------------------------------------------------------------------------------------------------------------| -| Array | `Array`, where `T` is the type of the array elements, e.g. `Array`. | -| Attachment | `Attachment` | -| Boolean | `Boolean` | -| Byte | `Byte` | -| Date | `LocalDate` | -| Decimal | `Decimal` | -| Double | `Double` | -| Float | `Float` | -| Integer | `Integer` | -| Long | `Long` | -| Marking | `Marking` | -| OntologyObject | `OntologyObject` where `T` is the API name of the referenced object type. | -| Short | `Short` | -| String | `String` | -| Struct | `Struct` where `T` contains field name and type pairs, e.g. `Struct<{ firstName: String, lastName: string }>` | -| Timeseries | `TimeSeries` where `T` is either `String` for an enum series or `Double` for a numeric series. | -| Timestamp | `Timestamp` | - - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Version.md b/docs/v2/models/Version.md deleted file mode 100644 index 4387a78d..00000000 --- a/docs/v2/models/Version.md +++ /dev/null @@ -1,11 +0,0 @@ -# Version - -Version - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**version** | VersionVersion | Yes | The semantic version of the Website. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/VersionDict.md b/docs/v2/models/VersionDict.md deleted file mode 100644 index e9a05b4e..00000000 --- a/docs/v2/models/VersionDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# VersionDict - -Version - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**version** | VersionVersion | Yes | The semantic version of the Website. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/VersionVersion.md b/docs/v2/models/VersionVersion.md deleted file mode 100644 index 004b3d86..00000000 --- a/docs/v2/models/VersionVersion.md +++ /dev/null @@ -1,11 +0,0 @@ -# VersionVersion - -The semantic version of the Website. - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/Website.md b/docs/v2/models/Website.md deleted file mode 100644 index 5e8ebf68..00000000 --- a/docs/v2/models/Website.md +++ /dev/null @@ -1,12 +0,0 @@ -# Website - -Website - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**deployed_version** | Optional[VersionVersion] | No | The version of the Website that is currently deployed. | -**subdomains** | List[Subdomain] | Yes | The subdomains from which the Website is currently served. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/WebsiteDict.md b/docs/v2/models/WebsiteDict.md deleted file mode 100644 index af8fc8e3..00000000 --- a/docs/v2/models/WebsiteDict.md +++ /dev/null @@ -1,12 +0,0 @@ -# WebsiteDict - -Website - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**deployedVersion** | NotRequired[VersionVersion] | No | The version of the Website that is currently deployed. | -**subdomains** | List[Subdomain] | Yes | The subdomains from which the Website is currently served. | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/WithinBoundingBoxPoint.md b/docs/v2/models/WithinBoundingBoxPoint.md deleted file mode 100644 index 7616b5d1..00000000 --- a/docs/v2/models/WithinBoundingBoxPoint.md +++ /dev/null @@ -1,11 +0,0 @@ -# WithinBoundingBoxPoint - -WithinBoundingBoxPoint - -## Type -```python -GeoPoint -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/WithinBoundingBoxPointDict.md b/docs/v2/models/WithinBoundingBoxPointDict.md deleted file mode 100644 index d7b8c8ba..00000000 --- a/docs/v2/models/WithinBoundingBoxPointDict.md +++ /dev/null @@ -1,11 +0,0 @@ -# WithinBoundingBoxPointDict - -WithinBoundingBoxPoint - -## Type -```python -GeoPointDict -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/WithinBoundingBoxQuery.md b/docs/v2/models/WithinBoundingBoxQuery.md deleted file mode 100644 index 1276fc33..00000000 --- a/docs/v2/models/WithinBoundingBoxQuery.md +++ /dev/null @@ -1,14 +0,0 @@ -# WithinBoundingBoxQuery - -Returns objects where the specified field contains a point within the bounding box provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | BoundingBoxValue | Yes | | -**type** | Literal["withinBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/WithinBoundingBoxQueryDict.md b/docs/v2/models/WithinBoundingBoxQueryDict.md deleted file mode 100644 index b7a85362..00000000 --- a/docs/v2/models/WithinBoundingBoxQueryDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# WithinBoundingBoxQueryDict - -Returns objects where the specified field contains a point within the bounding box provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | BoundingBoxValueDict | Yes | | -**type** | Literal["withinBoundingBox"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/WithinDistanceOfQuery.md b/docs/v2/models/WithinDistanceOfQuery.md deleted file mode 100644 index 0d7d53ae..00000000 --- a/docs/v2/models/WithinDistanceOfQuery.md +++ /dev/null @@ -1,14 +0,0 @@ -# WithinDistanceOfQuery - -Returns objects where the specified field contains a point within the distance provided of the center point. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | CenterPoint | Yes | | -**type** | Literal["withinDistanceOf"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/WithinDistanceOfQueryDict.md b/docs/v2/models/WithinDistanceOfQueryDict.md deleted file mode 100644 index f726bb0e..00000000 --- a/docs/v2/models/WithinDistanceOfQueryDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# WithinDistanceOfQueryDict - -Returns objects where the specified field contains a point within the distance provided of the center point. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | CenterPointDict | Yes | | -**type** | Literal["withinDistanceOf"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/WithinPolygonQuery.md b/docs/v2/models/WithinPolygonQuery.md deleted file mode 100644 index 256e6993..00000000 --- a/docs/v2/models/WithinPolygonQuery.md +++ /dev/null @@ -1,14 +0,0 @@ -# WithinPolygonQuery - -Returns objects where the specified field contains a point within the polygon provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PolygonValue | Yes | | -**type** | Literal["withinPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/WithinPolygonQueryDict.md b/docs/v2/models/WithinPolygonQueryDict.md deleted file mode 100644 index f9da369d..00000000 --- a/docs/v2/models/WithinPolygonQueryDict.md +++ /dev/null @@ -1,14 +0,0 @@ -# WithinPolygonQueryDict - -Returns objects where the specified field contains a point within the polygon provided. - - -## Properties -| Name | Type | Required | Description | -| ------------ | ------------- | ------------- | ------------- | -**field** | PropertyApiName | Yes | | -**value** | PolygonValueDict | Yes | | -**type** | Literal["withinPolygon"] | Yes | None | - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/models/ZoneId.md b/docs/v2/models/ZoneId.md deleted file mode 100644 index 69e9fc77..00000000 --- a/docs/v2/models/ZoneId.md +++ /dev/null @@ -1,11 +0,0 @@ -# ZoneId - -A string representation of a java.time.ZoneId - -## Type -```python -StrictStr -``` - - -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) diff --git a/docs/v2/namespaces/Admin/Group.md b/docs/v2/namespaces/Admin/Group.md deleted file mode 100644 index cd90906b..00000000 --- a/docs/v2/namespaces/Admin/Group.md +++ /dev/null @@ -1,422 +0,0 @@ -# Group - -Method | HTTP request | -------------- | ------------- | -[**create**](#create) | **POST** /v2/admin/groups | -[**delete**](#delete) | **DELETE** /v2/admin/groups/{groupId} | -[**get**](#get) | **GET** /v2/admin/groups/{groupId} | -[**get_batch**](#get_batch) | **POST** /v2/admin/groups/getBatch | -[**list**](#list) | **GET** /v2/admin/groups | -[**page**](#page) | **GET** /v2/admin/groups | -[**search**](#search) | **POST** /v2/admin/groups/search | - -# **create** -Creates a new Group. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**create_group_request** | Union[CreateGroupRequest, CreateGroupRequestDict] | Body of the request | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Group** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# Union[CreateGroupRequest, CreateGroupRequestDict] | Body of the request -create_group_request = { - "name": "Data Source Admins", - "organizations": ["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"], - "description": "Create and modify data sources in the platform", -} - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.Group.create( - create_group_request, - preview=preview, - ) - print("The create response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Group.create: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Group | The created Group | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **delete** -Delete the Group with the specified id. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**group_id** | PrincipalId | groupId | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**None** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# PrincipalId | groupId -group_id = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.Group.delete( - group_id, - preview=preview, - ) - print("The delete response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Group.delete: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**204** | None | | None | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get** -Get the Group with the specified id. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**group_id** | PrincipalId | groupId | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Group** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# PrincipalId | groupId -group_id = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.Group.get( - group_id, - preview=preview, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Group.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Group | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get_batch** -Execute multiple get requests on Group. - -The maximum batch size for this endpoint is 500. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**body** | Union[List[GetGroupsBatchRequestElement], List[GetGroupsBatchRequestElementDict]] | Body of the request | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**GetGroupsBatchResponse** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# Union[List[GetGroupsBatchRequestElement], List[GetGroupsBatchRequestElementDict]] | Body of the request -body = {"groupId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"} - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.Group.get_batch( - body, - preview=preview, - ) - print("The get_batch response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Group.get_batch: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | GetGroupsBatchResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **list** -Lists all Groups. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**ResourceIterator[Group]** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - for group in foundry_client.admin.Group.list( - page_size=page_size, - preview=preview, - ): - pprint(group) -except PalantirRPCException as e: - print("HTTP error when calling Group.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListGroupsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **page** -Lists all Groups. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**ListGroupsResponse** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.Group.page( - page_size=page_size, - page_token=page_token, - preview=preview, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Group.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListGroupsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **search** - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**search_groups_request** | Union[SearchGroupsRequest, SearchGroupsRequestDict] | Body of the request | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**SearchGroupsResponse** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# Union[SearchGroupsRequest, SearchGroupsRequestDict] | Body of the request -search_groups_request = { - "pageSize": 100, - "where": {"type": "queryString"}, - "pageToken": "v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv", -} - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.Group.search( - search_groups_request, - preview=preview, - ) - print("The search response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Group.search: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | SearchGroupsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Admin/GroupMember.md b/docs/v2/namespaces/Admin/GroupMember.md deleted file mode 100644 index 54106ef1..00000000 --- a/docs/v2/namespaces/Admin/GroupMember.md +++ /dev/null @@ -1,271 +0,0 @@ -# GroupMember - -Method | HTTP request | -------------- | ------------- | -[**add**](#add) | **POST** /v2/admin/groups/{groupId}/groupMembers/add | -[**list**](#list) | **GET** /v2/admin/groups/{groupId}/groupMembers | -[**page**](#page) | **GET** /v2/admin/groups/{groupId}/groupMembers | -[**remove**](#remove) | **POST** /v2/admin/groups/{groupId}/groupMembers/remove | - -# **add** - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**group_id** | PrincipalId | groupId | | -**add_group_members_request** | Union[AddGroupMembersRequest, AddGroupMembersRequestDict] | Body of the request | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**None** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# PrincipalId | groupId -group_id = None - -# Union[AddGroupMembersRequest, AddGroupMembersRequestDict] | Body of the request -add_group_members_request = {"principalIds": ["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]} - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.Group.GroupMember.add( - group_id, - add_group_members_request, - preview=preview, - ) - print("The add response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling GroupMember.add: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**204** | None | | None | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **list** -Lists all GroupMembers. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**group_id** | PrincipalId | groupId | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | -**transitive** | Optional[StrictBool] | transitive | [optional] | - -### Return type -**ResourceIterator[GroupMember]** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# PrincipalId | groupId -group_id = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PreviewMode] | preview -preview = None - -# Optional[StrictBool] | transitive -transitive = None - - -try: - for group_member in foundry_client.admin.Group.GroupMember.list( - group_id, - page_size=page_size, - preview=preview, - transitive=transitive, - ): - pprint(group_member) -except PalantirRPCException as e: - print("HTTP error when calling GroupMember.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListGroupMembersResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **page** -Lists all GroupMembers. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**group_id** | PrincipalId | groupId | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | -**transitive** | Optional[StrictBool] | transitive | [optional] | - -### Return type -**ListGroupMembersResponse** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# PrincipalId | groupId -group_id = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - -# Optional[PreviewMode] | preview -preview = None - -# Optional[StrictBool] | transitive -transitive = None - - -try: - api_response = foundry_client.admin.Group.GroupMember.page( - group_id, - page_size=page_size, - page_token=page_token, - preview=preview, - transitive=transitive, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling GroupMember.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListGroupMembersResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **remove** - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**group_id** | PrincipalId | groupId | | -**remove_group_members_request** | Union[RemoveGroupMembersRequest, RemoveGroupMembersRequestDict] | Body of the request | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**None** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# PrincipalId | groupId -group_id = None - -# Union[RemoveGroupMembersRequest, RemoveGroupMembersRequestDict] | Body of the request -remove_group_members_request = {"principalIds": ["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]} - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.Group.GroupMember.remove( - group_id, - remove_group_members_request, - preview=preview, - ) - print("The remove response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling GroupMember.remove: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**204** | None | | None | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Admin/GroupMembership.md b/docs/v2/namespaces/Admin/GroupMembership.md deleted file mode 100644 index 9d21b341..00000000 --- a/docs/v2/namespaces/Admin/GroupMembership.md +++ /dev/null @@ -1,147 +0,0 @@ -# GroupMembership - -Method | HTTP request | -------------- | ------------- | -[**list**](#list) | **GET** /v2/admin/users/{userId}/groupMemberships | -[**page**](#page) | **GET** /v2/admin/users/{userId}/groupMemberships | - -# **list** -Lists all GroupMemberships. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**user_id** | PrincipalId | userId | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | -**transitive** | Optional[StrictBool] | transitive | [optional] | - -### Return type -**ResourceIterator[GroupMembership]** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# PrincipalId | userId -user_id = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PreviewMode] | preview -preview = None - -# Optional[StrictBool] | transitive -transitive = None - - -try: - for group_membership in foundry_client.admin.User.GroupMembership.list( - user_id, - page_size=page_size, - preview=preview, - transitive=transitive, - ): - pprint(group_membership) -except PalantirRPCException as e: - print("HTTP error when calling GroupMembership.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListGroupMembershipsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **page** -Lists all GroupMemberships. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**user_id** | PrincipalId | userId | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | -**transitive** | Optional[StrictBool] | transitive | [optional] | - -### Return type -**ListGroupMembershipsResponse** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# PrincipalId | userId -user_id = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - -# Optional[PreviewMode] | preview -preview = None - -# Optional[StrictBool] | transitive -transitive = None - - -try: - api_response = foundry_client.admin.User.GroupMembership.page( - user_id, - page_size=page_size, - page_token=page_token, - preview=preview, - transitive=transitive, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling GroupMembership.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListGroupMembershipsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Admin/User.md b/docs/v2/namespaces/Admin/User.md deleted file mode 100644 index c3e98794..00000000 --- a/docs/v2/namespaces/Admin/User.md +++ /dev/null @@ -1,470 +0,0 @@ -# User - -Method | HTTP request | -------------- | ------------- | -[**delete**](#delete) | **DELETE** /v2/admin/users/{userId} | -[**get**](#get) | **GET** /v2/admin/users/{userId} | -[**get_batch**](#get_batch) | **POST** /v2/admin/users/getBatch | -[**get_current**](#get_current) | **GET** /v2/admin/users/getCurrent | -[**list**](#list) | **GET** /v2/admin/users | -[**page**](#page) | **GET** /v2/admin/users | -[**profile_picture**](#profile_picture) | **GET** /v2/admin/users/{userId}/profilePicture | -[**search**](#search) | **POST** /v2/admin/users/search | - -# **delete** -Delete the User with the specified id. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**user_id** | PrincipalId | userId | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**None** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# PrincipalId | userId -user_id = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.User.delete( - user_id, - preview=preview, - ) - print("The delete response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling User.delete: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**204** | None | | None | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get** -Get the User with the specified id. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**user_id** | PrincipalId | userId | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**User** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# PrincipalId | userId -user_id = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.User.get( - user_id, - preview=preview, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling User.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | User | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get_batch** -Execute multiple get requests on User. - -The maximum batch size for this endpoint is 500. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**body** | Union[List[GetUsersBatchRequestElement], List[GetUsersBatchRequestElementDict]] | Body of the request | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**GetUsersBatchResponse** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# Union[List[GetUsersBatchRequestElement], List[GetUsersBatchRequestElementDict]] | Body of the request -body = {"userId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"} - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.User.get_batch( - body, - preview=preview, - ) - print("The get_batch response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling User.get_batch: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | GetUsersBatchResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get_current** - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**User** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.User.get_current( - preview=preview, - ) - print("The get_current response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling User.get_current: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | User | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **list** -Lists all Users. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**ResourceIterator[User]** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - for user in foundry_client.admin.User.list( - page_size=page_size, - preview=preview, - ): - pprint(user) -except PalantirRPCException as e: - print("HTTP error when calling User.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListUsersResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **page** -Lists all Users. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**ListUsersResponse** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.User.page( - page_size=page_size, - page_token=page_token, - preview=preview, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling User.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListUsersResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **profile_picture** - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**user_id** | PrincipalId | userId | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**bytes** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# PrincipalId | userId -user_id = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.User.profile_picture( - user_id, - preview=preview, - ) - print("The profile_picture response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling User.profile_picture: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | bytes | The user's profile picture in binary format. The format is the original format uploaded by the user. The response will contain a `Content-Type` header that can be used to identify the media type. | application/octet-stream | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **search** - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**search_users_request** | Union[SearchUsersRequest, SearchUsersRequestDict] | Body of the request | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**SearchUsersResponse** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# Union[SearchUsersRequest, SearchUsersRequestDict] | Body of the request -search_users_request = { - "pageSize": 100, - "where": {"type": "queryString"}, - "pageToken": "v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv", -} - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.admin.User.search( - search_users_request, - preview=preview, - ) - print("The search response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling User.search: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | SearchUsersResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Datasets/Branch.md b/docs/v2/namespaces/Datasets/Branch.md deleted file mode 100644 index e698f65e..00000000 --- a/docs/v2/namespaces/Datasets/Branch.md +++ /dev/null @@ -1,327 +0,0 @@ -# Branch - -Method | HTTP request | -------------- | ------------- | -[**create**](#create) | **POST** /v2/datasets/{datasetRid}/branches | -[**delete**](#delete) | **DELETE** /v2/datasets/{datasetRid}/branches/{branchName} | -[**get**](#get) | **GET** /v2/datasets/{datasetRid}/branches/{branchName} | -[**list**](#list) | **GET** /v2/datasets/{datasetRid}/branches | -[**page**](#page) | **GET** /v2/datasets/{datasetRid}/branches | - -# **create** -Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**create_branch_request** | Union[CreateBranchRequest, CreateBranchRequestDict] | Body of the request | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Branch** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# Union[CreateBranchRequest, CreateBranchRequestDict] | Body of the request -create_branch_request = { - "transactionRid": "ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4", - "name": "master", -} - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.datasets.Dataset.Branch.create( - dataset_rid, - create_branch_request, - preview=preview, - ) - print("The create response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Branch.create: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Branch | The created Branch | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **delete** -Deletes the Branch with the given BranchName. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**branch_name** | BranchName | branchName | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**None** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# BranchName | branchName -branch_name = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.datasets.Dataset.Branch.delete( - dataset_rid, - branch_name, - preview=preview, - ) - print("The delete response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Branch.delete: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**204** | None | | None | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get** -Get a Branch of a Dataset. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**branch_name** | BranchName | branchName | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Branch** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# BranchName | branchName -branch_name = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.datasets.Dataset.Branch.get( - dataset_rid, - branch_name, - preview=preview, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Branch.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Branch | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **list** -Lists the Branches of a Dataset. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**ResourceIterator[Branch]** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - for branch in foundry_client.datasets.Dataset.Branch.list( - dataset_rid, - page_size=page_size, - preview=preview, - ): - pprint(branch) -except PalantirRPCException as e: - print("HTTP error when calling Branch.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListBranchesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **page** -Lists the Branches of a Dataset. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**ListBranchesResponse** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.datasets.Dataset.Branch.page( - dataset_rid, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Branch.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListBranchesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Datasets/Dataset.md b/docs/v2/namespaces/Datasets/Dataset.md deleted file mode 100644 index 107951be..00000000 --- a/docs/v2/namespaces/Datasets/Dataset.md +++ /dev/null @@ -1,210 +0,0 @@ -# Dataset - -Method | HTTP request | -------------- | ------------- | -[**create**](#create) | **POST** /v2/datasets | -[**get**](#get) | **GET** /v2/datasets/{datasetRid} | -[**read_table**](#read_table) | **GET** /v2/datasets/{datasetRid}/readTable | - -# **create** -Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**create_dataset_request** | Union[CreateDatasetRequest, CreateDatasetRequestDict] | Body of the request | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Dataset** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# Union[CreateDatasetRequest, CreateDatasetRequestDict] | Body of the request -create_dataset_request = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.datasets.Dataset.create( - create_dataset_request, - preview=preview, - ) - print("The create response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Dataset.create: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Dataset | The created Dataset | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get** -Get the Dataset with the specified rid. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Dataset** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.datasets.Dataset.get( - dataset_rid, - preview=preview, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Dataset.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Dataset | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **read_table** -Gets the content of a dataset as a table in the specified format. - -This endpoint currently does not support views (Virtual datasets composed of other datasets). - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**format** | TableExportFormat | format | | -**branch_name** | Optional[BranchName] | branchName | [optional] | -**columns** | Optional[List[StrictStr]] | columns | [optional] | -**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | -**row_limit** | Optional[StrictInt] | rowLimit | [optional] | -**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | - -### Return type -**bytes** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# TableExportFormat | format -format = None - -# Optional[BranchName] | branchName -branch_name = None - -# Optional[List[StrictStr]] | columns -columns = None - -# Optional[TransactionRid] | endTransactionRid -end_transaction_rid = None - -# Optional[PreviewMode] | preview -preview = None - -# Optional[StrictInt] | rowLimit -row_limit = None - -# Optional[TransactionRid] | startTransactionRid -start_transaction_rid = None - - -try: - api_response = foundry_client.datasets.Dataset.read_table( - dataset_rid, - format=format, - branch_name=branch_name, - columns=columns, - end_transaction_rid=end_transaction_rid, - preview=preview, - row_limit=row_limit, - start_transaction_rid=start_transaction_rid, - ) - print("The read_table response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Dataset.read_table: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | bytes | | application/octet-stream | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Datasets/File.md b/docs/v2/namespaces/Datasets/File.md deleted file mode 100644 index 16d866fd..00000000 --- a/docs/v2/namespaces/Datasets/File.md +++ /dev/null @@ -1,563 +0,0 @@ -# File - -Method | HTTP request | -------------- | ------------- | -[**content**](#content) | **GET** /v2/datasets/{datasetRid}/files/{filePath}/content | -[**delete**](#delete) | **DELETE** /v2/datasets/{datasetRid}/files/{filePath} | -[**get**](#get) | **GET** /v2/datasets/{datasetRid}/files/{filePath} | -[**list**](#list) | **GET** /v2/datasets/{datasetRid}/files | -[**page**](#page) | **GET** /v2/datasets/{datasetRid}/files | -[**upload**](#upload) | **POST** /v2/datasets/{datasetRid}/files/{filePath}/upload | - -# **content** -Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest -view of the default branch - `master` for most enrollments. -#### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. -To **get a file's content from a specific Branch** specify the Branch's name as `branchName`. This will -retrieve the content for the most recent version of the file since the latest snapshot transaction, or the -earliest ancestor transaction of the branch if there are no snapshot transactions. -To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier -as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest -snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions. -To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's -resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. -This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the -`endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior -is undefined when the start and end transactions do not belong to the same root-to-leaf path. -To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the -`startTransactionRid` and `endTransactionRid`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**file_path** | FilePath | filePath | | -**branch_name** | Optional[BranchName] | branchName | [optional] | -**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | -**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | - -### Return type -**bytes** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# FilePath | filePath -file_path = None - -# Optional[BranchName] | branchName -branch_name = None - -# Optional[TransactionRid] | endTransactionRid -end_transaction_rid = None - -# Optional[PreviewMode] | preview -preview = None - -# Optional[TransactionRid] | startTransactionRid -start_transaction_rid = None - - -try: - api_response = foundry_client.datasets.Dataset.File.content( - dataset_rid, - file_path, - branch_name=branch_name, - end_transaction_rid=end_transaction_rid, - preview=preview, - start_transaction_rid=start_transaction_rid, - ) - print("The content response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling File.content: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | bytes | | application/octet-stream | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **delete** -Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default -branch - `master` for most enrollments. The file will still be visible on historical views. -#### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. -To **delete a File from a specific Branch** specify the Branch's name as `branchName`. A new delete Transaction -will be created and committed on this branch. -To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier -as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a -single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to -open a transaction. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**file_path** | FilePath | filePath | | -**branch_name** | Optional[BranchName] | branchName | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | -**transaction_rid** | Optional[TransactionRid] | transactionRid | [optional] | - -### Return type -**None** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# FilePath | filePath -file_path = None - -# Optional[BranchName] | branchName -branch_name = None - -# Optional[PreviewMode] | preview -preview = None - -# Optional[TransactionRid] | transactionRid -transaction_rid = None - - -try: - api_response = foundry_client.datasets.Dataset.File.delete( - dataset_rid, - file_path, - branch_name=branch_name, - preview=preview, - transaction_rid=transaction_rid, - ) - print("The delete response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling File.delete: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**204** | None | | None | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get** -Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest -view of the default branch - `master` for most enrollments. -#### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. -To **get a file's metadata from a specific Branch** specify the Branch's name as `branchName`. This will -retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest -ancestor transaction of the branch if there are no snapshot transactions. -To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier -as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot -transaction, or the earliest ancestor transaction if there are no snapshot transactions. -To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's -resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. -This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the -`endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path. -To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the -`startTransactionRid` and `endTransactionRid`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**file_path** | FilePath | filePath | | -**branch_name** | Optional[BranchName] | branchName | [optional] | -**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | -**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | - -### Return type -**File** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# FilePath | filePath -file_path = None - -# Optional[BranchName] | branchName -branch_name = None - -# Optional[TransactionRid] | endTransactionRid -end_transaction_rid = None - -# Optional[PreviewMode] | preview -preview = None - -# Optional[TransactionRid] | startTransactionRid -start_transaction_rid = None - - -try: - api_response = foundry_client.datasets.Dataset.File.get( - dataset_rid, - file_path, - branch_name=branch_name, - end_transaction_rid=end_transaction_rid, - preview=preview, - start_transaction_rid=start_transaction_rid, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling File.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | File | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **list** -Lists Files contained in a Dataset. By default files are listed on the latest view of the default -branch - `master` for most enrollments. -#### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. -To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most -recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the -branch if there are no snapshot transactions. -To **list files on the resolved view of a transaction** specify the Transaction's resource identifier -as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot -transaction, or the earliest ancestor transaction if there are no snapshot transactions. -To **list files on the resolved view of a range of transactions** specify the the start transaction's resource -identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This -will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. -Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when -the start and end transactions do not belong to the same root-to-leaf path. -To **list files on a specific transaction** specify the Transaction's resource identifier as both the -`startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that -Transaction. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**branch_name** | Optional[BranchName] | branchName | [optional] | -**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | -**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | - -### Return type -**ResourceIterator[File]** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# Optional[BranchName] | branchName -branch_name = None - -# Optional[TransactionRid] | endTransactionRid -end_transaction_rid = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PreviewMode] | preview -preview = None - -# Optional[TransactionRid] | startTransactionRid -start_transaction_rid = None - - -try: - for file in foundry_client.datasets.Dataset.File.list( - dataset_rid, - branch_name=branch_name, - end_transaction_rid=end_transaction_rid, - page_size=page_size, - preview=preview, - start_transaction_rid=start_transaction_rid, - ): - pprint(file) -except PalantirRPCException as e: - print("HTTP error when calling File.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListFilesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **page** -Lists Files contained in a Dataset. By default files are listed on the latest view of the default -branch - `master` for most enrollments. -#### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. -To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most -recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the -branch if there are no snapshot transactions. -To **list files on the resolved view of a transaction** specify the Transaction's resource identifier -as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot -transaction, or the earliest ancestor transaction if there are no snapshot transactions. -To **list files on the resolved view of a range of transactions** specify the the start transaction's resource -identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This -will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. -Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when -the start and end transactions do not belong to the same root-to-leaf path. -To **list files on a specific transaction** specify the Transaction's resource identifier as both the -`startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that -Transaction. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**branch_name** | Optional[BranchName] | branchName | [optional] | -**end_transaction_rid** | Optional[TransactionRid] | endTransactionRid | [optional] | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | -**start_transaction_rid** | Optional[TransactionRid] | startTransactionRid | [optional] | - -### Return type -**ListFilesResponse** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# Optional[BranchName] | branchName -branch_name = None - -# Optional[TransactionRid] | endTransactionRid -end_transaction_rid = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - -# Optional[PreviewMode] | preview -preview = None - -# Optional[TransactionRid] | startTransactionRid -start_transaction_rid = None - - -try: - api_response = foundry_client.datasets.Dataset.File.page( - dataset_rid, - branch_name=branch_name, - end_transaction_rid=end_transaction_rid, - page_size=page_size, - page_token=page_token, - preview=preview, - start_transaction_rid=start_transaction_rid, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling File.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListFilesResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **upload** -Uploads a File to an existing Dataset. -The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. -By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments. -If the file already exists only the most recent version will be visible in the updated view. -#### Advanced Usage -See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. -To **upload a file to a specific Branch** specify the Branch's name as `branchName`. A new transaction will -be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this -default specify `transactionType` in addition to `branchName`. -See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. -To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as -`transactionRid`. This is useful for uploading multiple files in a single transaction. -See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**file_path** | FilePath | filePath | | -**body** | bytes | Body of the request | | -**branch_name** | Optional[BranchName] | branchName | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | -**transaction_rid** | Optional[TransactionRid] | transactionRid | [optional] | -**transaction_type** | Optional[TransactionType] | transactionType | [optional] | - -### Return type -**File** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# FilePath | filePath -file_path = None - -# bytes | Body of the request -body = None - -# Optional[BranchName] | branchName -branch_name = None - -# Optional[PreviewMode] | preview -preview = None - -# Optional[TransactionRid] | transactionRid -transaction_rid = None - -# Optional[TransactionType] | transactionType -transaction_type = None - - -try: - api_response = foundry_client.datasets.Dataset.File.upload( - dataset_rid, - file_path, - body, - branch_name=branch_name, - preview=preview, - transaction_rid=transaction_rid, - transaction_type=transaction_type, - ) - print("The upload response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling File.upload: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | File | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Datasets/Transaction.md b/docs/v2/namespaces/Datasets/Transaction.md deleted file mode 100644 index 307472f9..00000000 --- a/docs/v2/namespaces/Datasets/Transaction.md +++ /dev/null @@ -1,286 +0,0 @@ -# Transaction - -Method | HTTP request | -------------- | ------------- | -[**abort**](#abort) | **POST** /v2/datasets/{datasetRid}/transactions/{transactionRid}/abort | -[**commit**](#commit) | **POST** /v2/datasets/{datasetRid}/transactions/{transactionRid}/commit | -[**create**](#create) | **POST** /v2/datasets/{datasetRid}/transactions | -[**get**](#get) | **GET** /v2/datasets/{datasetRid}/transactions/{transactionRid} | - -# **abort** -Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is -not updated. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**transaction_rid** | TransactionRid | transactionRid | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Transaction** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# TransactionRid | transactionRid -transaction_rid = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.datasets.Dataset.Transaction.abort( - dataset_rid, - transaction_rid, - preview=preview, - ) - print("The abort response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Transaction.abort: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Transaction | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **commit** -Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is -updated to point to the Transaction. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**transaction_rid** | TransactionRid | transactionRid | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Transaction** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# TransactionRid | transactionRid -transaction_rid = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.datasets.Dataset.Transaction.commit( - dataset_rid, - transaction_rid, - preview=preview, - ) - print("The commit response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Transaction.commit: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Transaction | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **create** -Creates a Transaction on a Branch of a Dataset. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**create_transaction_request** | Union[CreateTransactionRequest, CreateTransactionRequestDict] | Body of the request | | -**branch_name** | Optional[BranchName] | branchName | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Transaction** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# Union[CreateTransactionRequest, CreateTransactionRequestDict] | Body of the request -create_transaction_request = {"transactionType": "APPEND"} - -# Optional[BranchName] | branchName -branch_name = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.datasets.Dataset.Transaction.create( - dataset_rid, - create_transaction_request, - branch_name=branch_name, - preview=preview, - ) - print("The create response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Transaction.create: %s\n" % e) - -``` - -### Manipulate a Dataset within a Transaction - -```python -import foundry - -foundry_client = foundry.FoundryV2Client(auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com") - -transaction = foundry_client.datasets.Dataset.Transaction.create( - dataset_rid="...", - create_transaction_request={}, -) - -with open("my/path/to/file.txt", 'rb') as f: - foundry_client.datasets.Dataset.File.upload( - body=f.read(), - dataset_rid="....", - file_path="...", - transaction_rid=transaction.rid, - ) - -foundry_client.datasets.Dataset.Transaction.commit(dataset_rid="...", transaction_rid=transaction.rid) -``` - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Transaction | The created Transaction | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get** -Gets a Transaction of a Dataset. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**dataset_rid** | DatasetRid | datasetRid | | -**transaction_rid** | TransactionRid | transactionRid | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Transaction** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# DatasetRid | datasetRid -dataset_rid = None - -# TransactionRid | transactionRid -transaction_rid = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.datasets.Dataset.Transaction.get( - dataset_rid, - transaction_rid, - preview=preview, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Transaction.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Transaction | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Ontologies/Action.md b/docs/v2/namespaces/Ontologies/Action.md deleted file mode 100644 index 3bd6c21c..00000000 --- a/docs/v2/namespaces/Ontologies/Action.md +++ /dev/null @@ -1,173 +0,0 @@ -# Action - -Method | HTTP request | -------------- | ------------- | -[**apply**](#apply) | **POST** /v2/ontologies/{ontology}/actions/{action}/apply | -[**apply_batch**](#apply_batch) | **POST** /v2/ontologies/{ontology}/actions/{action}/applyBatch | - -# **apply** -Applies an action using the given parameters. - -Changes to the Ontology are eventually consistent and may take some time to be visible. - -Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by -this endpoint. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read api:ontologies-write`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**action** | ActionTypeApiName | action | | -**apply_action_request_v2** | Union[ApplyActionRequestV2, ApplyActionRequestV2Dict] | Body of the request | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | - -### Return type -**SyncApplyActionResponseV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ActionTypeApiName | action -action = "rename-employee" - -# Union[ApplyActionRequestV2, ApplyActionRequestV2Dict] | Body of the request -apply_action_request_v2 = {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}} - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[SdkPackageName] | packageName -package_name = None - - -try: - api_response = foundry_client.ontologies.Action.apply( - ontology, - action, - apply_action_request_v2, - artifact_repository=artifact_repository, - package_name=package_name, - ) - print("The apply response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Action.apply: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | SyncApplyActionResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **apply_batch** -Applies multiple actions (of the same Action Type) using the given parameters. -Changes to the Ontology are eventually consistent and may take some time to be visible. - -Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not -call Functions may receive a higher limit. - -Note that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read api:ontologies-write`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**action** | ActionTypeApiName | action | | -**batch_apply_action_request_v2** | Union[BatchApplyActionRequestV2, BatchApplyActionRequestV2Dict] | Body of the request | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | - -### Return type -**BatchApplyActionResponseV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ActionTypeApiName | action -action = "rename-employee" - -# Union[BatchApplyActionRequestV2, BatchApplyActionRequestV2Dict] | Body of the request -batch_apply_action_request_v2 = { - "requests": [ - {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}}, - {"parameters": {"id": 80061, "newName": "Joe Bloggs"}}, - ] -} - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[SdkPackageName] | packageName -package_name = None - - -try: - api_response = foundry_client.ontologies.Action.apply_batch( - ontology, - action, - batch_apply_action_request_v2, - artifact_repository=artifact_repository, - package_name=package_name, - ) - print("The apply_batch response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Action.apply_batch: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | BatchApplyActionResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Ontologies/ActionType.md b/docs/v2/namespaces/Ontologies/ActionType.md deleted file mode 100644 index b875fb21..00000000 --- a/docs/v2/namespaces/Ontologies/ActionType.md +++ /dev/null @@ -1,195 +0,0 @@ -# ActionType - -Method | HTTP request | -------------- | ------------- | -[**get**](#get) | **GET** /v2/ontologies/{ontology}/actionTypes/{actionType} | -[**list**](#list) | **GET** /v2/ontologies/{ontology}/actionTypes | -[**page**](#page) | **GET** /v2/ontologies/{ontology}/actionTypes | - -# **get** -Gets a specific action type with the given API name. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**action_type** | ActionTypeApiName | actionType | | - -### Return type -**ActionTypeV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ActionTypeApiName | actionType -action_type = "promote-employee" - - -try: - api_response = foundry_client.ontologies.Ontology.ActionType.get( - ontology, - action_type, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling ActionType.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ActionTypeV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **list** -Lists the action types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**page_size** | Optional[PageSize] | pageSize | [optional] | - -### Return type -**ResourceIterator[ActionTypeV2]** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# Optional[PageSize] | pageSize -page_size = None - - -try: - for action_type in foundry_client.ontologies.Ontology.ActionType.list( - ontology, - page_size=page_size, - ): - pprint(action_type) -except PalantirRPCException as e: - print("HTTP error when calling ActionType.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListActionTypesResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **page** -Lists the action types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | - -### Return type -**ListActionTypesResponseV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.ActionType.page( - ontology, - page_size=page_size, - page_token=page_token, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling ActionType.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListActionTypesResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Ontologies/Attachment.md b/docs/v2/namespaces/Ontologies/Attachment.md deleted file mode 100644 index d822808b..00000000 --- a/docs/v2/namespaces/Ontologies/Attachment.md +++ /dev/null @@ -1,192 +0,0 @@ -# Attachment - -Method | HTTP request | -------------- | ------------- | -[**get**](#get) | **GET** /v2/ontologies/attachments/{attachmentRid} | -[**read**](#read) | **GET** /v2/ontologies/attachments/{attachmentRid}/content | -[**upload**](#upload) | **POST** /v2/ontologies/attachments/upload | - -# **get** -Get the metadata of an attachment. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**attachment_rid** | AttachmentRid | attachmentRid | | - -### Return type -**AttachmentV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# AttachmentRid | attachmentRid -attachment_rid = "ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f" - - -try: - api_response = foundry_client.ontologies.Attachment.get( - attachment_rid, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Attachment.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | AttachmentV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **read** -Get the content of an attachment. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**attachment_rid** | AttachmentRid | attachmentRid | | - -### Return type -**bytes** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# AttachmentRid | attachmentRid -attachment_rid = "ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f" - - -try: - api_response = foundry_client.ontologies.Attachment.read( - attachment_rid, - ) - print("The read response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Attachment.read: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | bytes | Success response. | */* | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **upload** -Upload an attachment to use in an action. Any attachment which has not been linked to an object via -an action within one hour after upload will be removed. -Previously mapped attachments which are not connected to any object anymore are also removed on -a biweekly basis. -The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-write`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**body** | bytes | Body of the request | | -**content_length** | ContentLength | Content-Length | | -**content_type** | ContentType | Content-Type | | -**filename** | Filename | filename | | - -### Return type -**AttachmentV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# bytes | Body of the request -body = None - -# ContentLength | Content-Length -content_length = None - -# ContentType | Content-Type -content_type = None - -# Filename | filename -filename = "My Image.jpeg" - - -try: - api_response = foundry_client.ontologies.Attachment.upload( - body, - content_length=content_length, - content_type=content_type, - filename=filename, - ) - print("The upload response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Attachment.upload: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | AttachmentV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Ontologies/AttachmentProperty.md b/docs/v2/namespaces/Ontologies/AttachmentProperty.md deleted file mode 100644 index 97990ab8..00000000 --- a/docs/v2/namespaces/Ontologies/AttachmentProperty.md +++ /dev/null @@ -1,341 +0,0 @@ -# AttachmentProperty - -Method | HTTP request | -------------- | ------------- | -[**get_attachment**](#get_attachment) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property} | -[**get_attachment_by_rid**](#get_attachment_by_rid) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid} | -[**read_attachment**](#read_attachment) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content | -[**read_attachment_by_rid**](#read_attachment_by_rid) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content | - -# **get_attachment** -Get the metadata of attachments parented to the given object. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**primary_key** | PropertyValueEscapedString | primaryKey | | -**property** | PropertyApiName | property | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | - -### Return type -**AttachmentMetadataResponse** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# PropertyValueEscapedString | primaryKey -primary_key = 50030 - -# PropertyApiName | property -property = "performance" - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[SdkPackageName] | packageName -package_name = None - - -try: - api_response = foundry_client.ontologies.AttachmentProperty.get_attachment( - ontology, - object_type, - primary_key, - property, - artifact_repository=artifact_repository, - package_name=package_name, - ) - print("The get_attachment response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling AttachmentProperty.get_attachment: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | AttachmentMetadataResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get_attachment_by_rid** -Get the metadata of a particular attachment in an attachment list. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**primary_key** | PropertyValueEscapedString | primaryKey | | -**property** | PropertyApiName | property | | -**attachment_rid** | AttachmentRid | attachmentRid | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | - -### Return type -**AttachmentV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# PropertyValueEscapedString | primaryKey -primary_key = 50030 - -# PropertyApiName | property -property = "performance" - -# AttachmentRid | attachmentRid -attachment_rid = "ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f" - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[SdkPackageName] | packageName -package_name = None - - -try: - api_response = foundry_client.ontologies.AttachmentProperty.get_attachment_by_rid( - ontology, - object_type, - primary_key, - property, - attachment_rid, - artifact_repository=artifact_repository, - package_name=package_name, - ) - print("The get_attachment_by_rid response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling AttachmentProperty.get_attachment_by_rid: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | AttachmentV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **read_attachment** -Get the content of an attachment. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**primary_key** | PropertyValueEscapedString | primaryKey | | -**property** | PropertyApiName | property | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | - -### Return type -**bytes** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# PropertyValueEscapedString | primaryKey -primary_key = 50030 - -# PropertyApiName | property -property = "performance" - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[SdkPackageName] | packageName -package_name = None - - -try: - api_response = foundry_client.ontologies.AttachmentProperty.read_attachment( - ontology, - object_type, - primary_key, - property, - artifact_repository=artifact_repository, - package_name=package_name, - ) - print("The read_attachment response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling AttachmentProperty.read_attachment: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | bytes | Success response. | */* | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **read_attachment_by_rid** -Get the content of an attachment by its RID. - -The RID must exist in the attachment array of the property. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**primary_key** | PropertyValueEscapedString | primaryKey | | -**property** | PropertyApiName | property | | -**attachment_rid** | AttachmentRid | attachmentRid | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | - -### Return type -**bytes** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# PropertyValueEscapedString | primaryKey -primary_key = 50030 - -# PropertyApiName | property -property = "performance" - -# AttachmentRid | attachmentRid -attachment_rid = "ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f" - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[SdkPackageName] | packageName -package_name = None - - -try: - api_response = foundry_client.ontologies.AttachmentProperty.read_attachment_by_rid( - ontology, - object_type, - primary_key, - property, - attachment_rid, - artifact_repository=artifact_repository, - package_name=package_name, - ) - print("The read_attachment_by_rid response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling AttachmentProperty.read_attachment_by_rid: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | bytes | Success response. | */* | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Ontologies/LinkedObject.md b/docs/v2/namespaces/Ontologies/LinkedObject.md deleted file mode 100644 index 52c741e7..00000000 --- a/docs/v2/namespaces/Ontologies/LinkedObject.md +++ /dev/null @@ -1,330 +0,0 @@ -# LinkedObject - -Method | HTTP request | -------------- | ------------- | -[**get_linked_object**](#get_linked_object) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} | -[**list_linked_objects**](#list_linked_objects) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} | -[**page_linked_objects**](#page_linked_objects) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} | - -# **get_linked_object** -Get a specific linked object that originates from another object. - -If there is no link between the two objects, `LinkedObjectNotFound` is thrown. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**primary_key** | PropertyValueEscapedString | primaryKey | | -**link_type** | LinkTypeApiName | linkType | | -**linked_object_primary_key** | PropertyValueEscapedString | linkedObjectPrimaryKey | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**exclude_rid** | Optional[StrictBool] | excludeRid | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | -**select** | Optional[List[SelectedPropertyApiName]] | select | [optional] | - -### Return type -**OntologyObjectV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# PropertyValueEscapedString | primaryKey -primary_key = 50030 - -# LinkTypeApiName | linkType -link_type = "directReport" - -# PropertyValueEscapedString | linkedObjectPrimaryKey -linked_object_primary_key = 80060 - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[StrictBool] | excludeRid -exclude_rid = None - -# Optional[SdkPackageName] | packageName -package_name = None - -# Optional[List[SelectedPropertyApiName]] | select -select = None - - -try: - api_response = foundry_client.ontologies.LinkedObject.get_linked_object( - ontology, - object_type, - primary_key, - link_type, - linked_object_primary_key, - artifact_repository=artifact_repository, - exclude_rid=exclude_rid, - package_name=package_name, - select=select, - ) - print("The get_linked_object response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling LinkedObject.get_linked_object: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | OntologyObjectV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **list_linked_objects** -Lists the linked objects for a specific object and the given link type. - -Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or -repeated objects in the response pages. - -For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects -are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - -Each page may be smaller or larger than the requested page size. However, it -is guaranteed that if there are more results available, at least one result will be present -in the response. - -Note that null value properties will not be returned. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**primary_key** | PropertyValueEscapedString | primaryKey | | -**link_type** | LinkTypeApiName | linkType | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**exclude_rid** | Optional[StrictBool] | excludeRid | [optional] | -**order_by** | Optional[OrderBy] | orderBy | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**select** | Optional[List[SelectedPropertyApiName]] | select | [optional] | - -### Return type -**ResourceIterator[OntologyObjectV2]** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# PropertyValueEscapedString | primaryKey -primary_key = 50030 - -# LinkTypeApiName | linkType -link_type = "directReport" - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[StrictBool] | excludeRid -exclude_rid = None - -# Optional[OrderBy] | orderBy -order_by = None - -# Optional[SdkPackageName] | packageName -package_name = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[List[SelectedPropertyApiName]] | select -select = None - - -try: - for linked_object in foundry_client.ontologies.LinkedObject.list_linked_objects( - ontology, - object_type, - primary_key, - link_type, - artifact_repository=artifact_repository, - exclude_rid=exclude_rid, - order_by=order_by, - package_name=package_name, - page_size=page_size, - select=select, - ): - pprint(linked_object) -except PalantirRPCException as e: - print("HTTP error when calling LinkedObject.list_linked_objects: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListLinkedObjectsResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **page_linked_objects** -Lists the linked objects for a specific object and the given link type. - -Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or -repeated objects in the response pages. - -For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects -are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - -Each page may be smaller or larger than the requested page size. However, it -is guaranteed that if there are more results available, at least one result will be present -in the response. - -Note that null value properties will not be returned. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**primary_key** | PropertyValueEscapedString | primaryKey | | -**link_type** | LinkTypeApiName | linkType | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**exclude_rid** | Optional[StrictBool] | excludeRid | [optional] | -**order_by** | Optional[OrderBy] | orderBy | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | -**select** | Optional[List[SelectedPropertyApiName]] | select | [optional] | - -### Return type -**ListLinkedObjectsResponseV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# PropertyValueEscapedString | primaryKey -primary_key = 50030 - -# LinkTypeApiName | linkType -link_type = "directReport" - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[StrictBool] | excludeRid -exclude_rid = None - -# Optional[OrderBy] | orderBy -order_by = None - -# Optional[SdkPackageName] | packageName -package_name = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - -# Optional[List[SelectedPropertyApiName]] | select -select = None - - -try: - api_response = foundry_client.ontologies.LinkedObject.page_linked_objects( - ontology, - object_type, - primary_key, - link_type, - artifact_repository=artifact_repository, - exclude_rid=exclude_rid, - order_by=order_by, - package_name=package_name, - page_size=page_size, - page_token=page_token, - select=select, - ) - print("The page_linked_objects response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling LinkedObject.page_linked_objects: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListLinkedObjectsResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Ontologies/ObjectType.md b/docs/v2/namespaces/Ontologies/ObjectType.md deleted file mode 100644 index 001115bc..00000000 --- a/docs/v2/namespaces/Ontologies/ObjectType.md +++ /dev/null @@ -1,399 +0,0 @@ -# ObjectType - -Method | HTTP request | -------------- | ------------- | -[**get**](#get) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType} | -[**get_outgoing_link_type**](#get_outgoing_link_type) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} | -[**list**](#list) | **GET** /v2/ontologies/{ontology}/objectTypes | -[**list_outgoing_link_types**](#list_outgoing_link_types) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes | -[**page**](#page) | **GET** /v2/ontologies/{ontology}/objectTypes | -[**page_outgoing_link_types**](#page_outgoing_link_types) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes | - -# **get** -Gets a specific object type with the given API name. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | - -### Return type -**ObjectTypeV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "employee" - - -try: - api_response = foundry_client.ontologies.Ontology.ObjectType.get( - ontology, - object_type, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling ObjectType.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ObjectTypeV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get_outgoing_link_type** -Get an outgoing link for an object type. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**link_type** | LinkTypeApiName | linkType | | - -### Return type -**LinkTypeSideV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "Employee" - -# LinkTypeApiName | linkType -link_type = "directReport" - - -try: - api_response = foundry_client.ontologies.Ontology.ObjectType.get_outgoing_link_type( - ontology, - object_type, - link_type, - ) - print("The get_outgoing_link_type response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling ObjectType.get_outgoing_link_type: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | LinkTypeSideV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **list** -Lists the object types for the given Ontology. - -Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are -more results available, at least one result will be present in the -response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**page_size** | Optional[PageSize] | pageSize | [optional] | - -### Return type -**ResourceIterator[ObjectTypeV2]** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# Optional[PageSize] | pageSize -page_size = None - - -try: - for object_type in foundry_client.ontologies.Ontology.ObjectType.list( - ontology, - page_size=page_size, - ): - pprint(object_type) -except PalantirRPCException as e: - print("HTTP error when calling ObjectType.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListObjectTypesV2Response | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **list_outgoing_link_types** -List the outgoing links for an object type. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**page_size** | Optional[PageSize] | pageSize | [optional] | - -### Return type -**ResourceIterator[LinkTypeSideV2]** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "Flight" - -# Optional[PageSize] | pageSize -page_size = None - - -try: - for object_type in foundry_client.ontologies.Ontology.ObjectType.list_outgoing_link_types( - ontology, - object_type, - page_size=page_size, - ): - pprint(object_type) -except PalantirRPCException as e: - print("HTTP error when calling ObjectType.list_outgoing_link_types: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListOutgoingLinkTypesResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **page** -Lists the object types for the given Ontology. - -Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are -more results available, at least one result will be present in the -response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | - -### Return type -**ListObjectTypesV2Response** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.ObjectType.page( - ontology, - page_size=page_size, - page_token=page_token, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling ObjectType.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListObjectTypesV2Response | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **page_outgoing_link_types** -List the outgoing links for an object type. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | - -### Return type -**ListOutgoingLinkTypesResponseV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "Flight" - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.ObjectType.page_outgoing_link_types( - ontology, - object_type, - page_size=page_size, - page_token=page_token, - ) - print("The page_outgoing_link_types response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling ObjectType.page_outgoing_link_types: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListOutgoingLinkTypesResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Ontologies/Ontology.md b/docs/v2/namespaces/Ontologies/Ontology.md deleted file mode 100644 index b6440bf4..00000000 --- a/docs/v2/namespaces/Ontologies/Ontology.md +++ /dev/null @@ -1,113 +0,0 @@ -# Ontology - -Method | HTTP request | -------------- | ------------- | -[**get**](#get) | **GET** /v2/ontologies/{ontology} | -[**get_full_metadata**](#get_full_metadata) | **GET** /v2/ontologies/{ontology}/fullMetadata | - -# **get** -Gets a specific ontology with the given Ontology RID. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | - -### Return type -**OntologyV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - - -try: - api_response = foundry_client.ontologies.Ontology.get( - ontology, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Ontology.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | OntologyV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get_full_metadata** -Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | - -### Return type -**OntologyFullMetadata** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - - -try: - api_response = foundry_client.ontologies.Ontology.get_full_metadata( - ontology, - ) - print("The get_full_metadata response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Ontology.get_full_metadata: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | OntologyFullMetadata | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Ontologies/OntologyInterface.md b/docs/v2/namespaces/Ontologies/OntologyInterface.md deleted file mode 100644 index 74c5f01c..00000000 --- a/docs/v2/namespaces/Ontologies/OntologyInterface.md +++ /dev/null @@ -1,315 +0,0 @@ -# OntologyInterface - -Method | HTTP request | -------------- | ------------- | -[**aggregate**](#aggregate) | **POST** /v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate | -[**get**](#get) | **GET** /v2/ontologies/{ontology}/interfaceTypes/{interfaceType} | -[**list**](#list) | **GET** /v2/ontologies/{ontology}/interfaceTypes | -[**page**](#page) | **GET** /v2/ontologies/{ontology}/interfaceTypes | - -# **aggregate** -:::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. -::: - -Perform functions on object fields in the specified ontology and of the specified interface type. Any -properties specified in the query must be shared property type API names defined on the interface. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**interface_type** | InterfaceTypeApiName | interfaceType | | -**aggregate_objects_request_v2** | Union[AggregateObjectsRequestV2, AggregateObjectsRequestV2Dict] | Body of the request | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**AggregateObjectsResponseV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# InterfaceTypeApiName | interfaceType -interface_type = "Employee" - -# Union[AggregateObjectsRequestV2, AggregateObjectsRequestV2Dict] | Body of the request -aggregate_objects_request_v2 = { - "aggregation": [ - {"type": "min", "field": "properties.tenure", "name": "min_tenure"}, - {"type": "avg", "field": "properties.tenure", "name": "avg_tenure"}, - ], - "query": {"not": {"field": "name", "eq": "john"}}, - "groupBy": [ - { - "field": "startDate", - "type": "range", - "ranges": [{"startValue": "2020-01-01", "endValue": "2020-06-01"}], - }, - {"field": "city", "type": "exact"}, - ], -} - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.ontologies.OntologyInterface.aggregate( - ontology, - interface_type, - aggregate_objects_request_v2, - preview=preview, - ) - print("The aggregate response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyInterface.aggregate: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | AggregateObjectsResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get** -:::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. -::: - -Gets a specific object type with the given API name. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**interface_type** | InterfaceTypeApiName | interfaceType | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**InterfaceType** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# InterfaceTypeApiName | interfaceType -interface_type = "Employee" - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.ontologies.OntologyInterface.get( - ontology, - interface_type, - preview=preview, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyInterface.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | InterfaceType | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **list** -:::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. -::: - -Lists the interface types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**ResourceIterator[InterfaceType]** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - for ontology_interface in foundry_client.ontologies.OntologyInterface.list( - ontology, - page_size=page_size, - preview=preview, - ): - pprint(ontology_interface) -except PalantirRPCException as e: - print("HTTP error when calling OntologyInterface.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListInterfaceTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **page** -:::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. -::: - -Lists the interface types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**ListInterfaceTypesResponse** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.ontologies.OntologyInterface.page( - ontology, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyInterface.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListInterfaceTypesResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Ontologies/OntologyObject.md b/docs/v2/namespaces/Ontologies/OntologyObject.md deleted file mode 100644 index be9abde2..00000000 --- a/docs/v2/namespaces/Ontologies/OntologyObject.md +++ /dev/null @@ -1,551 +0,0 @@ -# OntologyObject - -Method | HTTP request | -------------- | ------------- | -[**aggregate**](#aggregate) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/aggregate | -[**count**](#count) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/count | -[**get**](#get) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey} | -[**list**](#list) | **GET** /v2/ontologies/{ontology}/objects/{objectType} | -[**page**](#page) | **GET** /v2/ontologies/{ontology}/objects/{objectType} | -[**search**](#search) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/search | - -# **aggregate** -Perform functions on object fields in the specified ontology and object type. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**aggregate_objects_request_v2** | Union[AggregateObjectsRequestV2, AggregateObjectsRequestV2Dict] | Body of the request | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | - -### Return type -**AggregateObjectsResponseV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# Union[AggregateObjectsRequestV2, AggregateObjectsRequestV2Dict] | Body of the request -aggregate_objects_request_v2 = { - "aggregation": [ - {"type": "min", "field": "properties.tenure", "name": "min_tenure"}, - {"type": "avg", "field": "properties.tenure", "name": "avg_tenure"}, - ], - "query": {"not": {"field": "name", "eq": "john"}}, - "groupBy": [ - { - "field": "startDate", - "type": "range", - "ranges": [{"startValue": "2020-01-01", "endValue": "2020-06-01"}], - }, - {"field": "city", "type": "exact"}, - ], -} - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[SdkPackageName] | packageName -package_name = None - - -try: - api_response = foundry_client.ontologies.OntologyObject.aggregate( - ontology, - object_type, - aggregate_objects_request_v2, - artifact_repository=artifact_repository, - package_name=package_name, - ) - print("The aggregate response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObject.aggregate: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | AggregateObjectsResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **count** -Returns a count of the objects of the given object type. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | - -### Return type -**CountObjectsResponseV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[SdkPackageName] | packageName -package_name = None - - -try: - api_response = foundry_client.ontologies.OntologyObject.count( - ontology, - object_type, - artifact_repository=artifact_repository, - package_name=package_name, - ) - print("The count response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObject.count: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | CountObjectsResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get** -Gets a specific object with the given primary key. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**primary_key** | PropertyValueEscapedString | primaryKey | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**exclude_rid** | Optional[StrictBool] | excludeRid | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | -**select** | Optional[List[SelectedPropertyApiName]] | select | [optional] | - -### Return type -**OntologyObjectV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# PropertyValueEscapedString | primaryKey -primary_key = 50030 - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[StrictBool] | excludeRid -exclude_rid = None - -# Optional[SdkPackageName] | packageName -package_name = None - -# Optional[List[SelectedPropertyApiName]] | select -select = None - - -try: - api_response = foundry_client.ontologies.OntologyObject.get( - ontology, - object_type, - primary_key, - artifact_repository=artifact_repository, - exclude_rid=exclude_rid, - package_name=package_name, - select=select, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObject.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | OntologyObjectV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **list** -Lists the objects for the given Ontology and object type. - -Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or -repeated objects in the response pages. - -For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects -are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - -Each page may be smaller or larger than the requested page size. However, it -is guaranteed that if there are more results available, at least one result will be present -in the response. - -Note that null value properties will not be returned. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**exclude_rid** | Optional[StrictBool] | excludeRid | [optional] | -**order_by** | Optional[OrderBy] | orderBy | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**select** | Optional[List[SelectedPropertyApiName]] | select | [optional] | - -### Return type -**ResourceIterator[OntologyObjectV2]** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[StrictBool] | excludeRid -exclude_rid = None - -# Optional[OrderBy] | orderBy -order_by = None - -# Optional[SdkPackageName] | packageName -package_name = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[List[SelectedPropertyApiName]] | select -select = None - - -try: - for ontology_object in foundry_client.ontologies.OntologyObject.list( - ontology, - object_type, - artifact_repository=artifact_repository, - exclude_rid=exclude_rid, - order_by=order_by, - package_name=package_name, - page_size=page_size, - select=select, - ): - pprint(ontology_object) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObject.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListObjectsResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **page** -Lists the objects for the given Ontology and object type. - -Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or -repeated objects in the response pages. - -For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects -are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - -Each page may be smaller or larger than the requested page size. However, it -is guaranteed that if there are more results available, at least one result will be present -in the response. - -Note that null value properties will not be returned. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**exclude_rid** | Optional[StrictBool] | excludeRid | [optional] | -**order_by** | Optional[OrderBy] | orderBy | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | -**select** | Optional[List[SelectedPropertyApiName]] | select | [optional] | - -### Return type -**ListObjectsResponseV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[StrictBool] | excludeRid -exclude_rid = None - -# Optional[OrderBy] | orderBy -order_by = None - -# Optional[SdkPackageName] | packageName -package_name = None - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - -# Optional[List[SelectedPropertyApiName]] | select -select = None - - -try: - api_response = foundry_client.ontologies.OntologyObject.page( - ontology, - object_type, - artifact_repository=artifact_repository, - exclude_rid=exclude_rid, - order_by=order_by, - package_name=package_name, - page_size=page_size, - page_token=page_token, - select=select, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObject.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListObjectsResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **search** -Search for objects in the specified ontology and object type. The request body is used -to filter objects based on the specified query. The supported queries are: - -| Query type | Description | Supported Types | -|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------| -| lt | The provided property is less than the provided value. | number, string, date, timestamp | -| gt | The provided property is greater than the provided value. | number, string, date, timestamp | -| lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp | -| gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp | -| eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp | -| isNull | The provided property is (or is not) null. | all | -| contains | The provided property contains the provided value. | array | -| not | The sub-query does not match. | N/A (applied on a query) | -| and | All the sub-queries match. | N/A (applied on queries) | -| or | At least one of the sub-queries match. | N/A (applied on queries) | -| startsWith | The provided property starts with the provided value. | string | -| containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string | -| containsAllTermsInOrder | The provided property contains the provided value as a substring. | string | -| containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string | -| containsAllTerms | The provided property contains all the terms separated by whitespace. | string | - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_type** | ObjectTypeApiName | objectType | | -**search_objects_request_v2** | Union[SearchObjectsRequestV2, SearchObjectsRequestV2Dict] | Body of the request | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | - -### Return type -**SearchObjectsResponseV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectTypeApiName | objectType -object_type = "employee" - -# Union[SearchObjectsRequestV2, SearchObjectsRequestV2Dict] | Body of the request -search_objects_request_v2 = {"where": {"type": "eq", "field": "age", "value": 21}} - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[SdkPackageName] | packageName -package_name = None - - -try: - api_response = foundry_client.ontologies.OntologyObject.search( - ontology, - object_type, - search_objects_request_v2, - artifact_repository=artifact_repository, - package_name=package_name, - ) - print("The search response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObject.search: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | SearchObjectsResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Ontologies/OntologyObjectSet.md b/docs/v2/namespaces/Ontologies/OntologyObjectSet.md deleted file mode 100644 index dbd9c3f0..00000000 --- a/docs/v2/namespaces/Ontologies/OntologyObjectSet.md +++ /dev/null @@ -1,275 +0,0 @@ -# OntologyObjectSet - -Method | HTTP request | -------------- | ------------- | -[**aggregate**](#aggregate) | **POST** /v2/ontologies/{ontology}/objectSets/aggregate | -[**create_temporary**](#create_temporary) | **POST** /v2/ontologies/{ontology}/objectSets/createTemporary | -[**get**](#get) | **GET** /v2/ontologies/{ontology}/objectSets/{objectSetRid} | -[**load**](#load) | **POST** /v2/ontologies/{ontology}/objectSets/loadObjects | - -# **aggregate** -Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**aggregate_object_set_request_v2** | Union[AggregateObjectSetRequestV2, AggregateObjectSetRequestV2Dict] | Body of the request | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | - -### Return type -**AggregateObjectsResponseV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# Union[AggregateObjectSetRequestV2, AggregateObjectSetRequestV2Dict] | Body of the request -aggregate_object_set_request_v2 = None - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[SdkPackageName] | packageName -package_name = None - - -try: - api_response = foundry_client.ontologies.OntologyObjectSet.aggregate( - ontology, - aggregate_object_set_request_v2, - artifact_repository=artifact_repository, - package_name=package_name, - ) - print("The aggregate response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObjectSet.aggregate: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | AggregateObjectsResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **create_temporary** -Creates a temporary `ObjectSet` from the given definition. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read api:ontologies-write`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**create_temporary_object_set_request_v2** | Union[CreateTemporaryObjectSetRequestV2, CreateTemporaryObjectSetRequestV2Dict] | Body of the request | | - -### Return type -**CreateTemporaryObjectSetResponseV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# Union[CreateTemporaryObjectSetRequestV2, CreateTemporaryObjectSetRequestV2Dict] | Body of the request -create_temporary_object_set_request_v2 = {"objectSet": {"type": "base", "objectType": "Employee"}} - - -try: - api_response = foundry_client.ontologies.OntologyObjectSet.create_temporary( - ontology, - create_temporary_object_set_request_v2, - ) - print("The create_temporary response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObjectSet.create_temporary: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | CreateTemporaryObjectSetResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get** -Gets the definition of the `ObjectSet` with the given RID. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**object_set_rid** | ObjectSetRid | objectSetRid | | - -### Return type -**ObjectSet** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# ObjectSetRid | objectSetRid -object_set_rid = "ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053" - - -try: - api_response = foundry_client.ontologies.OntologyObjectSet.get( - ontology, - object_set_rid, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObjectSet.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ObjectSet | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **load** -Load the ontology objects present in the `ObjectSet` from the provided object set definition. - -For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects -are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - -Note that null value properties will not be returned. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**load_object_set_request_v2** | Union[LoadObjectSetRequestV2, LoadObjectSetRequestV2Dict] | Body of the request | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | - -### Return type -**LoadObjectSetResponseV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# Union[LoadObjectSetRequestV2, LoadObjectSetRequestV2Dict] | Body of the request -load_object_set_request_v2 = { - "objectSet": {"type": "base", "objectType": "Employee"}, - "pageSize": 10000, - "nextPageToken": "v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv", -} - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[SdkPackageName] | packageName -package_name = None - - -try: - api_response = foundry_client.ontologies.OntologyObjectSet.load( - ontology, - load_object_set_request_v2, - artifact_repository=artifact_repository, - package_name=package_name, - ) - print("The load response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling OntologyObjectSet.load: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | LoadObjectSetResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Ontologies/Query.md b/docs/v2/namespaces/Ontologies/Query.md deleted file mode 100644 index cfbb8f77..00000000 --- a/docs/v2/namespaces/Ontologies/Query.md +++ /dev/null @@ -1,83 +0,0 @@ -# Query - -Method | HTTP request | -------------- | ------------- | -[**execute**](#execute) | **POST** /v2/ontologies/{ontology}/queries/{queryApiName}/execute | - -# **execute** -Executes a Query using the given parameters. - -Optional parameters do not need to be supplied. - -Third-party applications using this endpoint via OAuth2 must request the -following operation scopes: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**query_api_name** | QueryApiName | queryApiName | | -**execute_query_request** | Union[ExecuteQueryRequest, ExecuteQueryRequestDict] | Body of the request | | -**artifact_repository** | Optional[ArtifactRepositoryRid] | artifactRepository | [optional] | -**package_name** | Optional[SdkPackageName] | packageName | [optional] | - -### Return type -**ExecuteQueryResponse** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# QueryApiName | queryApiName -query_api_name = "getEmployeesInCity" - -# Union[ExecuteQueryRequest, ExecuteQueryRequestDict] | Body of the request -execute_query_request = {"parameters": {"city": "New York"}} - -# Optional[ArtifactRepositoryRid] | artifactRepository -artifact_repository = None - -# Optional[SdkPackageName] | packageName -package_name = None - - -try: - api_response = foundry_client.ontologies.Query.execute( - ontology, - query_api_name, - execute_query_request, - artifact_repository=artifact_repository, - package_name=package_name, - ) - print("The execute response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Query.execute: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ExecuteQueryResponse | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Ontologies/QueryType.md b/docs/v2/namespaces/Ontologies/QueryType.md deleted file mode 100644 index 5e1d94bd..00000000 --- a/docs/v2/namespaces/Ontologies/QueryType.md +++ /dev/null @@ -1,195 +0,0 @@ -# QueryType - -Method | HTTP request | -------------- | ------------- | -[**get**](#get) | **GET** /v2/ontologies/{ontology}/queryTypes/{queryApiName} | -[**list**](#list) | **GET** /v2/ontologies/{ontology}/queryTypes | -[**page**](#page) | **GET** /v2/ontologies/{ontology}/queryTypes | - -# **get** -Gets a specific query type with the given API name. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**query_api_name** | QueryApiName | queryApiName | | - -### Return type -**QueryTypeV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# QueryApiName | queryApiName -query_api_name = "getEmployeesInCity" - - -try: - api_response = foundry_client.ontologies.Ontology.QueryType.get( - ontology, - query_api_name, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling QueryType.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | QueryTypeV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **list** -Lists the query types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**page_size** | Optional[PageSize] | pageSize | [optional] | - -### Return type -**ResourceIterator[QueryTypeV2]** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# Optional[PageSize] | pageSize -page_size = None - - -try: - for query_type in foundry_client.ontologies.Ontology.QueryType.list( - ontology, - page_size=page_size, - ): - pprint(query_type) -except PalantirRPCException as e: - print("HTTP error when calling QueryType.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListQueryTypesResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **page** -Lists the query types for the given Ontology. - -Each page may be smaller than the requested page size. However, it is guaranteed that if there are more -results available, at least one result will be present in the response. - -Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**ontology** | OntologyIdentifier | ontology | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | - -### Return type -**ListQueryTypesResponseV2** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# OntologyIdentifier | ontology -ontology = "palantir" - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - - -try: - api_response = foundry_client.ontologies.Ontology.QueryType.page( - ontology, - page_size=page_size, - page_token=page_token, - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling QueryType.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListQueryTypesResponseV2 | Success response. | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Orchestration/Build.md b/docs/v2/namespaces/Orchestration/Build.md deleted file mode 100644 index 137c3ad2..00000000 --- a/docs/v2/namespaces/Orchestration/Build.md +++ /dev/null @@ -1,123 +0,0 @@ -# Build - -Method | HTTP request | -------------- | ------------- | -[**create**](#create) | **POST** /v2/orchestration/builds/create | -[**get**](#get) | **GET** /v2/orchestration/builds/{buildRid} | - -# **create** - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**create_builds_request** | Union[CreateBuildsRequest, CreateBuildsRequestDict] | Body of the request | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Build** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# Union[CreateBuildsRequest, CreateBuildsRequestDict] | Body of the request -create_builds_request = { - "retryBackoffDuration": {"unit": "SECONDS", "value": 30}, - "fallbackBranches": ["master"], - "branchName": "master", -} - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.orchestration.Build.create( - create_builds_request, - preview=preview, - ) - print("The create response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Build.create: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Build | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get** -Get the Build with the specified rid. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**build_rid** | BuildRid | buildRid | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Build** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# BuildRid | buildRid -build_rid = "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58" - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.orchestration.Build.get( - build_rid, - preview=preview, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Build.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Build | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/Orchestration/Schedule.md b/docs/v2/namespaces/Orchestration/Schedule.md deleted file mode 100644 index cc279365..00000000 --- a/docs/v2/namespaces/Orchestration/Schedule.md +++ /dev/null @@ -1,233 +0,0 @@ -# Schedule - -Method | HTTP request | -------------- | ------------- | -[**get**](#get) | **GET** /v2/orchestration/schedules/{scheduleRid} | -[**pause**](#pause) | **POST** /v2/orchestration/schedules/{scheduleRid}/pause | -[**run**](#run) | **POST** /v2/orchestration/schedules/{scheduleRid}/run | -[**unpause**](#unpause) | **POST** /v2/orchestration/schedules/{scheduleRid}/unpause | - -# **get** -Get the Schedule with the specified rid. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**schedule_rid** | ScheduleRid | scheduleRid | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Schedule** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# ScheduleRid | scheduleRid -schedule_rid = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.orchestration.Schedule.get( - schedule_rid, - preview=preview, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Schedule.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Schedule | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **pause** - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**schedule_rid** | ScheduleRid | scheduleRid | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**None** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# ScheduleRid | scheduleRid -schedule_rid = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.orchestration.Schedule.pause( - schedule_rid, - preview=preview, - ) - print("The pause response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Schedule.pause: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**204** | None | | None | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **run** - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**schedule_rid** | ScheduleRid | scheduleRid | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**ScheduleRun** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# ScheduleRid | scheduleRid -schedule_rid = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.orchestration.Schedule.run( - schedule_rid, - preview=preview, - ) - print("The run response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Schedule.run: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ScheduleRun | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **unpause** - - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**schedule_rid** | ScheduleRid | scheduleRid | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**None** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# ScheduleRid | scheduleRid -schedule_rid = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.orchestration.Schedule.unpause( - schedule_rid, - preview=preview, - ) - print("The unpause response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Schedule.unpause: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**204** | None | | None | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/ThirdPartyApplications/ThirdPartyApplication.md b/docs/v2/namespaces/ThirdPartyApplications/ThirdPartyApplication.md deleted file mode 100644 index 46de0dff..00000000 --- a/docs/v2/namespaces/ThirdPartyApplications/ThirdPartyApplication.md +++ /dev/null @@ -1,64 +0,0 @@ -# ThirdPartyApplication - -Method | HTTP request | -------------- | ------------- | -[**get**](#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid} | - -# **get** -Get the ThirdPartyApplication with the specified rid. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**ThirdPartyApplication** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# ThirdPartyApplicationRid | thirdPartyApplicationRid -third_party_application_rid = ( - "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" -) - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.third_party_applications.ThirdPartyApplication.get( - third_party_application_rid, - preview=preview, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling ThirdPartyApplication.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ThirdPartyApplication | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/ThirdPartyApplications/Version.md b/docs/v2/namespaces/ThirdPartyApplications/Version.md deleted file mode 100644 index a9ab6e62..00000000 --- a/docs/v2/namespaces/ThirdPartyApplications/Version.md +++ /dev/null @@ -1,348 +0,0 @@ -# Version - -Method | HTTP request | -------------- | ------------- | -[**delete**](#delete) | **DELETE** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | -[**get**](#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | -[**list**](#list) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions | -[**page**](#page) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions | -[**upload**](#upload) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/upload | - -# **delete** -Delete the Version with the specified version. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | -**version_version** | VersionVersion | versionVersion | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**None** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# ThirdPartyApplicationRid | thirdPartyApplicationRid -third_party_application_rid = ( - "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" -) - -# VersionVersion | versionVersion -version_version = "1.2.0" - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = ( - foundry_client.third_party_applications.ThirdPartyApplication.Website.Version.delete( - third_party_application_rid, - version_version, - preview=preview, - ) - ) - print("The delete response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Version.delete: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**204** | None | | None | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get** -Get the Version with the specified version. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | -**version_version** | VersionVersion | versionVersion | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Version** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# ThirdPartyApplicationRid | thirdPartyApplicationRid -third_party_application_rid = ( - "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" -) - -# VersionVersion | versionVersion -version_version = "1.2.0" - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = ( - foundry_client.third_party_applications.ThirdPartyApplication.Website.Version.get( - third_party_application_rid, - version_version, - preview=preview, - ) - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Version.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Version | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **list** -Lists all Versions. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**ResourceIterator[Version]** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# ThirdPartyApplicationRid | thirdPartyApplicationRid -third_party_application_rid = ( - "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" -) - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - for ( - version - ) in foundry_client.third_party_applications.ThirdPartyApplication.Website.Version.list( - third_party_application_rid, - page_size=page_size, - preview=preview, - ): - pprint(version) -except PalantirRPCException as e: - print("HTTP error when calling Version.list: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListVersionsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **page** -Lists all Versions. - -This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | -**page_size** | Optional[PageSize] | pageSize | [optional] | -**page_token** | Optional[PageToken] | pageToken | [optional] | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**ListVersionsResponse** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# ThirdPartyApplicationRid | thirdPartyApplicationRid -third_party_application_rid = ( - "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" -) - -# Optional[PageSize] | pageSize -page_size = None - -# Optional[PageToken] | pageToken -page_token = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = ( - foundry_client.third_party_applications.ThirdPartyApplication.Website.Version.page( - third_party_application_rid, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - ) - print("The page response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Version.page: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | ListVersionsResponse | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **upload** -Upload a new version of the Website. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | -**body** | bytes | The zip file that contains the contents of your application. For more information, refer to the [documentation](/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. | | -**version** | VersionVersion | version | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Version** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# ThirdPartyApplicationRid | thirdPartyApplicationRid -third_party_application_rid = ( - "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" -) - -# bytes | The zip file that contains the contents of your application. For more information, refer to the [documentation](/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. -body = None - -# VersionVersion | version -version = None - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = ( - foundry_client.third_party_applications.ThirdPartyApplication.Website.Version.upload( - third_party_application_rid, - body, - version=version, - preview=preview, - ) - ) - print("The upload response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Version.upload: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Version | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/namespaces/ThirdPartyApplications/Website.md b/docs/v2/namespaces/ThirdPartyApplications/Website.md deleted file mode 100644 index 024eae85..00000000 --- a/docs/v2/namespaces/ThirdPartyApplications/Website.md +++ /dev/null @@ -1,187 +0,0 @@ -# Website - -Method | HTTP request | -------------- | ------------- | -[**deploy**](#deploy) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/deploy | -[**get**](#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website | -[**undeploy**](#undeploy) | **POST** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/undeploy | - -# **deploy** -Deploy a version of the Website. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | -**deploy_website_request** | Union[DeployWebsiteRequest, DeployWebsiteRequestDict] | Body of the request | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Website** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# ThirdPartyApplicationRid | thirdPartyApplicationRid -third_party_application_rid = ( - "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" -) - -# Union[DeployWebsiteRequest, DeployWebsiteRequestDict] | Body of the request -deploy_website_request = {"version": "1.2.0"} - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.third_party_applications.ThirdPartyApplication.Website.deploy( - third_party_application_rid, - deploy_website_request, - preview=preview, - ) - print("The deploy response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Website.deploy: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Website | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **get** -Get the Website. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Website** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# ThirdPartyApplicationRid | thirdPartyApplicationRid -third_party_application_rid = ( - "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" -) - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.third_party_applications.ThirdPartyApplication.Website.get( - third_party_application_rid, - preview=preview, - ) - print("The get response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Website.get: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Website | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - -# **undeploy** -Remove the currently deployed version of the Website. - -### Parameters - -Name | Type | Description | Notes | -------------- | ------------- | ------------- | ------------- | -**third_party_application_rid** | ThirdPartyApplicationRid | thirdPartyApplicationRid | | -**preview** | Optional[PreviewMode] | preview | [optional] | - -### Return type -**Website** - -### Example - -```python -from foundry.v2 import FoundryV2Client -from foundry import PalantirRPCException -from pprint import pprint - -foundry_client = FoundryV2Client( - auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" -) - -# ThirdPartyApplicationRid | thirdPartyApplicationRid -third_party_application_rid = ( - "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" -) - -# Optional[PreviewMode] | preview -preview = None - - -try: - api_response = foundry_client.third_party_applications.ThirdPartyApplication.Website.undeploy( - third_party_application_rid, - preview=preview, - ) - print("The undeploy response:\n") - pprint(api_response) -except PalantirRPCException as e: - print("HTTP error when calling Website.undeploy: %s\n" % e) - -``` - - - -### Authorization - -See [README](../../../../README.md#authorization) - -### HTTP response details -| Status Code | Type | Description | Content Type | -|-------------|-------------|-------------|------------------| -**200** | Website | | application/json | - -[[Back to top]](#) [[Back to API list]](../../../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to README]](../../../../README.md) - diff --git a/docs/v2/ontologies/models/AbsoluteTimeRangeDict.md b/docs/v2/ontologies/models/AbsoluteTimeRangeDict.md new file mode 100644 index 00000000..42ff6bb7 --- /dev/null +++ b/docs/v2/ontologies/models/AbsoluteTimeRangeDict.md @@ -0,0 +1,13 @@ +# AbsoluteTimeRangeDict + +ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**startTime** | NotRequired[datetime] | No | | +**endTime** | NotRequired[datetime] | No | | +**type** | Literal["absolute"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ActionParameterArrayType.md b/docs/v2/ontologies/models/ActionParameterArrayType.md new file mode 100644 index 00000000..8a73b0b9 --- /dev/null +++ b/docs/v2/ontologies/models/ActionParameterArrayType.md @@ -0,0 +1,12 @@ +# ActionParameterArrayType + +ActionParameterArrayType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**sub_type** | ActionParameterType | Yes | | +**type** | Literal["array"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ActionParameterArrayTypeDict.md b/docs/v2/ontologies/models/ActionParameterArrayTypeDict.md new file mode 100644 index 00000000..bf295e33 --- /dev/null +++ b/docs/v2/ontologies/models/ActionParameterArrayTypeDict.md @@ -0,0 +1,12 @@ +# ActionParameterArrayTypeDict + +ActionParameterArrayType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**subType** | ActionParameterTypeDict | Yes | | +**type** | Literal["array"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ActionParameterType.md b/docs/v2/ontologies/models/ActionParameterType.md new file mode 100644 index 00000000..b15a50a1 --- /dev/null +++ b/docs/v2/ontologies/models/ActionParameterType.md @@ -0,0 +1,27 @@ +# ActionParameterType + +A union of all the types supported by Ontology Action parameters. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateType | date +BooleanType | boolean +MarkingType | marking +AttachmentType | attachment +StringType | string +ActionParameterArrayType | array +OntologyObjectSetType | objectSet +DoubleType | double +IntegerType | integer +LongType | long +OntologyObjectType | object +TimestampType | timestamp + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ActionParameterTypeDict.md b/docs/v2/ontologies/models/ActionParameterTypeDict.md new file mode 100644 index 00000000..c6ca5949 --- /dev/null +++ b/docs/v2/ontologies/models/ActionParameterTypeDict.md @@ -0,0 +1,27 @@ +# ActionParameterTypeDict + +A union of all the types supported by Ontology Action parameters. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateTypeDict | date +BooleanTypeDict | boolean +MarkingTypeDict | marking +AttachmentTypeDict | attachment +StringTypeDict | string +ActionParameterArrayTypeDict | array +OntologyObjectSetTypeDict | objectSet +DoubleTypeDict | double +IntegerTypeDict | integer +LongTypeDict | long +OntologyObjectTypeDict | object +TimestampTypeDict | timestamp + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ActionParameterV2.md b/docs/v2/ontologies/models/ActionParameterV2.md new file mode 100644 index 00000000..f5e708aa --- /dev/null +++ b/docs/v2/ontologies/models/ActionParameterV2.md @@ -0,0 +1,13 @@ +# ActionParameterV2 + +Details about a parameter of an action. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**description** | Optional[StrictStr] | No | | +**data_type** | ActionParameterType | Yes | | +**required** | StrictBool | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ActionParameterV2Dict.md b/docs/v2/ontologies/models/ActionParameterV2Dict.md new file mode 100644 index 00000000..f9fe9619 --- /dev/null +++ b/docs/v2/ontologies/models/ActionParameterV2Dict.md @@ -0,0 +1,13 @@ +# ActionParameterV2Dict + +Details about a parameter of an action. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**description** | NotRequired[StrictStr] | No | | +**dataType** | ActionParameterTypeDict | Yes | | +**required** | StrictBool | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ActionResults.md b/docs/v2/ontologies/models/ActionResults.md new file mode 100644 index 00000000..22d63f67 --- /dev/null +++ b/docs/v2/ontologies/models/ActionResults.md @@ -0,0 +1,16 @@ +# ActionResults + +ActionResults + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ObjectEdits | edits +ObjectTypeEdits | largeScaleEdits + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ActionResultsDict.md b/docs/v2/ontologies/models/ActionResultsDict.md new file mode 100644 index 00000000..e071b44b --- /dev/null +++ b/docs/v2/ontologies/models/ActionResultsDict.md @@ -0,0 +1,16 @@ +# ActionResultsDict + +ActionResults + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ObjectEditsDict | edits +ObjectTypeEditsDict | largeScaleEdits + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ActionTypeApiName.md b/docs/v2/ontologies/models/ActionTypeApiName.md new file mode 100644 index 00000000..3249bc2a --- /dev/null +++ b/docs/v2/ontologies/models/ActionTypeApiName.md @@ -0,0 +1,13 @@ +# ActionTypeApiName + +The name of the action type in the API. To find the API name for your Action Type, use the `List action types` +endpoint or check the **Ontology Manager**. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ActionTypeRid.md b/docs/v2/ontologies/models/ActionTypeRid.md new file mode 100644 index 00000000..41d4e6f9 --- /dev/null +++ b/docs/v2/ontologies/models/ActionTypeRid.md @@ -0,0 +1,12 @@ +# ActionTypeRid + +The unique resource identifier of an action type, useful for interacting with other Foundry APIs. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ActionTypeV2.md b/docs/v2/ontologies/models/ActionTypeV2.md new file mode 100644 index 00000000..35421b02 --- /dev/null +++ b/docs/v2/ontologies/models/ActionTypeV2.md @@ -0,0 +1,17 @@ +# ActionTypeV2 + +Represents an action type in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**api_name** | ActionTypeApiName | Yes | | +**description** | Optional[StrictStr] | No | | +**display_name** | Optional[DisplayName] | No | | +**status** | ReleaseStatus | Yes | | +**parameters** | Dict[ParameterId, ActionParameterV2] | Yes | | +**rid** | ActionTypeRid | Yes | | +**operations** | List[LogicRule] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ActionTypeV2Dict.md b/docs/v2/ontologies/models/ActionTypeV2Dict.md new file mode 100644 index 00000000..58d2ae2d --- /dev/null +++ b/docs/v2/ontologies/models/ActionTypeV2Dict.md @@ -0,0 +1,17 @@ +# ActionTypeV2Dict + +Represents an action type in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**apiName** | ActionTypeApiName | Yes | | +**description** | NotRequired[StrictStr] | No | | +**displayName** | NotRequired[DisplayName] | No | | +**status** | ReleaseStatus | Yes | | +**parameters** | Dict[ParameterId, ActionParameterV2Dict] | Yes | | +**rid** | ActionTypeRid | Yes | | +**operations** | List[LogicRuleDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AddLink.md b/docs/v2/ontologies/models/AddLink.md new file mode 100644 index 00000000..00715a92 --- /dev/null +++ b/docs/v2/ontologies/models/AddLink.md @@ -0,0 +1,15 @@ +# AddLink + +AddLink + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**link_type_api_name_ato_b** | LinkTypeApiName | Yes | | +**link_type_api_name_bto_a** | LinkTypeApiName | Yes | | +**a_side_object** | LinkSideObject | Yes | | +**b_side_object** | LinkSideObject | Yes | | +**type** | Literal["addLink"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AddLinkDict.md b/docs/v2/ontologies/models/AddLinkDict.md new file mode 100644 index 00000000..a140a12e --- /dev/null +++ b/docs/v2/ontologies/models/AddLinkDict.md @@ -0,0 +1,15 @@ +# AddLinkDict + +AddLink + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | +**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | +**aSideObject** | LinkSideObjectDict | Yes | | +**bSideObject** | LinkSideObjectDict | Yes | | +**type** | Literal["addLink"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AddObject.md b/docs/v2/ontologies/models/AddObject.md new file mode 100644 index 00000000..7dc7c86b --- /dev/null +++ b/docs/v2/ontologies/models/AddObject.md @@ -0,0 +1,13 @@ +# AddObject + +AddObject + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**primary_key** | PropertyValue | Yes | | +**object_type** | ObjectTypeApiName | Yes | | +**type** | Literal["addObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AddObjectDict.md b/docs/v2/ontologies/models/AddObjectDict.md new file mode 100644 index 00000000..0ee3c43f --- /dev/null +++ b/docs/v2/ontologies/models/AddObjectDict.md @@ -0,0 +1,13 @@ +# AddObjectDict + +AddObject + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**primaryKey** | PropertyValue | Yes | | +**objectType** | ObjectTypeApiName | Yes | | +**type** | Literal["addObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregateObjectsResponseItemV2.md b/docs/v2/ontologies/models/AggregateObjectsResponseItemV2.md new file mode 100644 index 00000000..2de0a0d1 --- /dev/null +++ b/docs/v2/ontologies/models/AggregateObjectsResponseItemV2.md @@ -0,0 +1,12 @@ +# AggregateObjectsResponseItemV2 + +AggregateObjectsResponseItemV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**group** | Dict[AggregationGroupKeyV2, AggregationGroupValueV2] | Yes | | +**metrics** | List[AggregationMetricResultV2] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregateObjectsResponseItemV2Dict.md b/docs/v2/ontologies/models/AggregateObjectsResponseItemV2Dict.md new file mode 100644 index 00000000..029ecff0 --- /dev/null +++ b/docs/v2/ontologies/models/AggregateObjectsResponseItemV2Dict.md @@ -0,0 +1,12 @@ +# AggregateObjectsResponseItemV2Dict + +AggregateObjectsResponseItemV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**group** | Dict[AggregationGroupKeyV2, AggregationGroupValueV2] | Yes | | +**metrics** | List[AggregationMetricResultV2Dict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregateObjectsResponseV2.md b/docs/v2/ontologies/models/AggregateObjectsResponseV2.md new file mode 100644 index 00000000..798a0f04 --- /dev/null +++ b/docs/v2/ontologies/models/AggregateObjectsResponseV2.md @@ -0,0 +1,13 @@ +# AggregateObjectsResponseV2 + +AggregateObjectsResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**excluded_items** | Optional[StrictInt] | No | | +**accuracy** | AggregationAccuracy | Yes | | +**data** | List[AggregateObjectsResponseItemV2] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregateObjectsResponseV2Dict.md b/docs/v2/ontologies/models/AggregateObjectsResponseV2Dict.md new file mode 100644 index 00000000..ff794174 --- /dev/null +++ b/docs/v2/ontologies/models/AggregateObjectsResponseV2Dict.md @@ -0,0 +1,13 @@ +# AggregateObjectsResponseV2Dict + +AggregateObjectsResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**excludedItems** | NotRequired[StrictInt] | No | | +**accuracy** | AggregationAccuracy | Yes | | +**data** | List[AggregateObjectsResponseItemV2Dict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregationAccuracy.md b/docs/v2/ontologies/models/AggregationAccuracy.md new file mode 100644 index 00000000..c26cc37e --- /dev/null +++ b/docs/v2/ontologies/models/AggregationAccuracy.md @@ -0,0 +1,11 @@ +# AggregationAccuracy + +AggregationAccuracy + +| **Value** | +| --------- | +| `"ACCURATE"` | +| `"APPROXIMATE"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregationAccuracyRequest.md b/docs/v2/ontologies/models/AggregationAccuracyRequest.md new file mode 100644 index 00000000..b17209cc --- /dev/null +++ b/docs/v2/ontologies/models/AggregationAccuracyRequest.md @@ -0,0 +1,11 @@ +# AggregationAccuracyRequest + +AggregationAccuracyRequest + +| **Value** | +| --------- | +| `"REQUIRE_ACCURATE"` | +| `"ALLOW_APPROXIMATE"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregationDurationGroupingV2Dict.md b/docs/v2/ontologies/models/AggregationDurationGroupingV2Dict.md new file mode 100644 index 00000000..96028cbf --- /dev/null +++ b/docs/v2/ontologies/models/AggregationDurationGroupingV2Dict.md @@ -0,0 +1,16 @@ +# AggregationDurationGroupingV2Dict + +Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. +When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | StrictInt | Yes | | +**unit** | TimeUnit | Yes | | +**type** | Literal["duration"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregationExactGroupingV2Dict.md b/docs/v2/ontologies/models/AggregationExactGroupingV2Dict.md new file mode 100644 index 00000000..4a52f1d5 --- /dev/null +++ b/docs/v2/ontologies/models/AggregationExactGroupingV2Dict.md @@ -0,0 +1,13 @@ +# AggregationExactGroupingV2Dict + +Divides objects into groups according to an exact value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**maxGroupCount** | NotRequired[StrictInt] | No | | +**type** | Literal["exact"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregationFixedWidthGroupingV2Dict.md b/docs/v2/ontologies/models/AggregationFixedWidthGroupingV2Dict.md new file mode 100644 index 00000000..63e934fc --- /dev/null +++ b/docs/v2/ontologies/models/AggregationFixedWidthGroupingV2Dict.md @@ -0,0 +1,13 @@ +# AggregationFixedWidthGroupingV2Dict + +Divides objects into groups with the specified width. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**fixedWidth** | StrictInt | Yes | | +**type** | Literal["fixedWidth"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregationGroupByV2Dict.md b/docs/v2/ontologies/models/AggregationGroupByV2Dict.md new file mode 100644 index 00000000..ebb43512 --- /dev/null +++ b/docs/v2/ontologies/models/AggregationGroupByV2Dict.md @@ -0,0 +1,18 @@ +# AggregationGroupByV2Dict + +Specifies a grouping for aggregation results. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +AggregationDurationGroupingV2Dict | duration +AggregationFixedWidthGroupingV2Dict | fixedWidth +AggregationRangesGroupingV2Dict | ranges +AggregationExactGroupingV2Dict | exact + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregationGroupKeyV2.md b/docs/v2/ontologies/models/AggregationGroupKeyV2.md new file mode 100644 index 00000000..511b1788 --- /dev/null +++ b/docs/v2/ontologies/models/AggregationGroupKeyV2.md @@ -0,0 +1,11 @@ +# AggregationGroupKeyV2 + +AggregationGroupKeyV2 + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregationGroupValueV2.md b/docs/v2/ontologies/models/AggregationGroupValueV2.md new file mode 100644 index 00000000..e6373e62 --- /dev/null +++ b/docs/v2/ontologies/models/AggregationGroupValueV2.md @@ -0,0 +1,11 @@ +# AggregationGroupValueV2 + +AggregationGroupValueV2 + +## Type +```python +Any +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregationMetricName.md b/docs/v2/ontologies/models/AggregationMetricName.md new file mode 100644 index 00000000..ae33667c --- /dev/null +++ b/docs/v2/ontologies/models/AggregationMetricName.md @@ -0,0 +1,11 @@ +# AggregationMetricName + +A user-specified alias for an aggregation metric name. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregationMetricResultV2.md b/docs/v2/ontologies/models/AggregationMetricResultV2.md new file mode 100644 index 00000000..bd4f8238 --- /dev/null +++ b/docs/v2/ontologies/models/AggregationMetricResultV2.md @@ -0,0 +1,12 @@ +# AggregationMetricResultV2 + +AggregationMetricResultV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**name** | StrictStr | Yes | | +**value** | Optional[Any] | No | The value of the metric. This will be a double in the case of a numeric metric, or a date string in the case of a date metric. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregationMetricResultV2Dict.md b/docs/v2/ontologies/models/AggregationMetricResultV2Dict.md new file mode 100644 index 00000000..efa7eced --- /dev/null +++ b/docs/v2/ontologies/models/AggregationMetricResultV2Dict.md @@ -0,0 +1,12 @@ +# AggregationMetricResultV2Dict + +AggregationMetricResultV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**name** | StrictStr | Yes | | +**value** | NotRequired[Any] | No | The value of the metric. This will be a double in the case of a numeric metric, or a date string in the case of a date metric. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregationRangeV2Dict.md b/docs/v2/ontologies/models/AggregationRangeV2Dict.md new file mode 100644 index 00000000..727324ab --- /dev/null +++ b/docs/v2/ontologies/models/AggregationRangeV2Dict.md @@ -0,0 +1,12 @@ +# AggregationRangeV2Dict + +Specifies a range from an inclusive start value to an exclusive end value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**startValue** | Any | Yes | Inclusive start. | +**endValue** | Any | Yes | Exclusive end. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregationRangesGroupingV2Dict.md b/docs/v2/ontologies/models/AggregationRangesGroupingV2Dict.md new file mode 100644 index 00000000..43f3603d --- /dev/null +++ b/docs/v2/ontologies/models/AggregationRangesGroupingV2Dict.md @@ -0,0 +1,13 @@ +# AggregationRangesGroupingV2Dict + +Divides objects into groups according to specified ranges. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**ranges** | List[AggregationRangeV2Dict] | Yes | | +**type** | Literal["ranges"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AggregationV2Dict.md b/docs/v2/ontologies/models/AggregationV2Dict.md new file mode 100644 index 00000000..26857b2a --- /dev/null +++ b/docs/v2/ontologies/models/AggregationV2Dict.md @@ -0,0 +1,22 @@ +# AggregationV2Dict + +Specifies an aggregation function. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ApproximateDistinctAggregationV2Dict | approximateDistinct +MinAggregationV2Dict | min +AvgAggregationV2Dict | avg +MaxAggregationV2Dict | max +ApproximatePercentileAggregationV2Dict | approximatePercentile +CountAggregationV2Dict | count +SumAggregationV2Dict | sum +ExactDistinctAggregationV2Dict | exactDistinct + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AndQueryV2.md b/docs/v2/ontologies/models/AndQueryV2.md new file mode 100644 index 00000000..3e45089c --- /dev/null +++ b/docs/v2/ontologies/models/AndQueryV2.md @@ -0,0 +1,12 @@ +# AndQueryV2 + +Returns objects where every query is satisfied. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | List[SearchJsonQueryV2] | Yes | | +**type** | Literal["and"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AndQueryV2Dict.md b/docs/v2/ontologies/models/AndQueryV2Dict.md new file mode 100644 index 00000000..e4c4f339 --- /dev/null +++ b/docs/v2/ontologies/models/AndQueryV2Dict.md @@ -0,0 +1,12 @@ +# AndQueryV2Dict + +Returns objects where every query is satisfied. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | List[SearchJsonQueryV2Dict] | Yes | | +**type** | Literal["and"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ApplyActionMode.md b/docs/v2/ontologies/models/ApplyActionMode.md new file mode 100644 index 00000000..255c32e8 --- /dev/null +++ b/docs/v2/ontologies/models/ApplyActionMode.md @@ -0,0 +1,11 @@ +# ApplyActionMode + +ApplyActionMode + +| **Value** | +| --------- | +| `"VALIDATE_ONLY"` | +| `"VALIDATE_AND_EXECUTE"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ApplyActionRequestOptionsDict.md b/docs/v2/ontologies/models/ApplyActionRequestOptionsDict.md new file mode 100644 index 00000000..b5461fea --- /dev/null +++ b/docs/v2/ontologies/models/ApplyActionRequestOptionsDict.md @@ -0,0 +1,12 @@ +# ApplyActionRequestOptionsDict + +ApplyActionRequestOptions + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**mode** | NotRequired[ApplyActionMode] | No | | +**returnEdits** | NotRequired[ReturnEditsMode] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ApproximateDistinctAggregationV2Dict.md b/docs/v2/ontologies/models/ApproximateDistinctAggregationV2Dict.md new file mode 100644 index 00000000..1a139969 --- /dev/null +++ b/docs/v2/ontologies/models/ApproximateDistinctAggregationV2Dict.md @@ -0,0 +1,14 @@ +# ApproximateDistinctAggregationV2Dict + +Computes an approximate number of distinct values for the provided field. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**name** | NotRequired[AggregationMetricName] | No | | +**direction** | NotRequired[OrderByDirection] | No | | +**type** | Literal["approximateDistinct"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ApproximatePercentileAggregationV2Dict.md b/docs/v2/ontologies/models/ApproximatePercentileAggregationV2Dict.md new file mode 100644 index 00000000..ee5f0a2d --- /dev/null +++ b/docs/v2/ontologies/models/ApproximatePercentileAggregationV2Dict.md @@ -0,0 +1,15 @@ +# ApproximatePercentileAggregationV2Dict + +Computes the approximate percentile value for the provided field. Requires Object Storage V2. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**name** | NotRequired[AggregationMetricName] | No | | +**approximatePercentile** | StrictFloat | Yes | | +**direction** | NotRequired[OrderByDirection] | No | | +**type** | Literal["approximatePercentile"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ArraySizeConstraint.md b/docs/v2/ontologies/models/ArraySizeConstraint.md new file mode 100644 index 00000000..bc873022 --- /dev/null +++ b/docs/v2/ontologies/models/ArraySizeConstraint.md @@ -0,0 +1,16 @@ +# ArraySizeConstraint + +The parameter expects an array of values and the size of the array must fall within the defined range. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**lt** | Optional[Any] | No | Less than | +**lte** | Optional[Any] | No | Less than or equal | +**gt** | Optional[Any] | No | Greater than | +**gte** | Optional[Any] | No | Greater than or equal | +**type** | Literal["arraySize"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ArraySizeConstraintDict.md b/docs/v2/ontologies/models/ArraySizeConstraintDict.md new file mode 100644 index 00000000..e8286db2 --- /dev/null +++ b/docs/v2/ontologies/models/ArraySizeConstraintDict.md @@ -0,0 +1,16 @@ +# ArraySizeConstraintDict + +The parameter expects an array of values and the size of the array must fall within the defined range. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**lt** | NotRequired[Any] | No | Less than | +**lte** | NotRequired[Any] | No | Less than or equal | +**gt** | NotRequired[Any] | No | Greater than | +**gte** | NotRequired[Any] | No | Greater than or equal | +**type** | Literal["arraySize"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ArtifactRepositoryRid.md b/docs/v2/ontologies/models/ArtifactRepositoryRid.md new file mode 100644 index 00000000..e2c47b29 --- /dev/null +++ b/docs/v2/ontologies/models/ArtifactRepositoryRid.md @@ -0,0 +1,11 @@ +# ArtifactRepositoryRid + +ArtifactRepositoryRid + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AttachmentMetadataResponse.md b/docs/v2/ontologies/models/AttachmentMetadataResponse.md new file mode 100644 index 00000000..2b5d1ca8 --- /dev/null +++ b/docs/v2/ontologies/models/AttachmentMetadataResponse.md @@ -0,0 +1,16 @@ +# AttachmentMetadataResponse + +The attachment metadata response + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +AttachmentV2 | single +ListAttachmentsResponseV2 | multiple + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AttachmentMetadataResponseDict.md b/docs/v2/ontologies/models/AttachmentMetadataResponseDict.md new file mode 100644 index 00000000..6cd82007 --- /dev/null +++ b/docs/v2/ontologies/models/AttachmentMetadataResponseDict.md @@ -0,0 +1,16 @@ +# AttachmentMetadataResponseDict + +The attachment metadata response + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +AttachmentV2Dict | single +ListAttachmentsResponseV2Dict | multiple + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AttachmentRid.md b/docs/v2/ontologies/models/AttachmentRid.md new file mode 100644 index 00000000..cb496fe7 --- /dev/null +++ b/docs/v2/ontologies/models/AttachmentRid.md @@ -0,0 +1,11 @@ +# AttachmentRid + +The unique resource identifier of an attachment. + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AttachmentV2.md b/docs/v2/ontologies/models/AttachmentV2.md new file mode 100644 index 00000000..88d604e4 --- /dev/null +++ b/docs/v2/ontologies/models/AttachmentV2.md @@ -0,0 +1,15 @@ +# AttachmentV2 + +The representation of an attachment. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | AttachmentRid | Yes | | +**filename** | Filename | Yes | | +**size_bytes** | SizeBytes | Yes | | +**media_type** | MediaType | Yes | | +**type** | Literal["single"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AttachmentV2Dict.md b/docs/v2/ontologies/models/AttachmentV2Dict.md new file mode 100644 index 00000000..2c1402d4 --- /dev/null +++ b/docs/v2/ontologies/models/AttachmentV2Dict.md @@ -0,0 +1,15 @@ +# AttachmentV2Dict + +The representation of an attachment. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | AttachmentRid | Yes | | +**filename** | Filename | Yes | | +**sizeBytes** | SizeBytes | Yes | | +**mediaType** | MediaType | Yes | | +**type** | Literal["single"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/AvgAggregationV2Dict.md b/docs/v2/ontologies/models/AvgAggregationV2Dict.md new file mode 100644 index 00000000..659647d8 --- /dev/null +++ b/docs/v2/ontologies/models/AvgAggregationV2Dict.md @@ -0,0 +1,14 @@ +# AvgAggregationV2Dict + +Computes the average value for the provided field. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**name** | NotRequired[AggregationMetricName] | No | | +**direction** | NotRequired[OrderByDirection] | No | | +**type** | Literal["avg"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/BatchApplyActionRequestItemDict.md b/docs/v2/ontologies/models/BatchApplyActionRequestItemDict.md new file mode 100644 index 00000000..7463d935 --- /dev/null +++ b/docs/v2/ontologies/models/BatchApplyActionRequestItemDict.md @@ -0,0 +1,11 @@ +# BatchApplyActionRequestItemDict + +BatchApplyActionRequestItem + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**parameters** | Dict[ParameterId, Optional[DataValue]] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/BatchApplyActionRequestOptionsDict.md b/docs/v2/ontologies/models/BatchApplyActionRequestOptionsDict.md new file mode 100644 index 00000000..0cb69ec1 --- /dev/null +++ b/docs/v2/ontologies/models/BatchApplyActionRequestOptionsDict.md @@ -0,0 +1,11 @@ +# BatchApplyActionRequestOptionsDict + +BatchApplyActionRequestOptions + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**returnEdits** | NotRequired[ReturnEditsMode] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/BatchApplyActionResponseV2.md b/docs/v2/ontologies/models/BatchApplyActionResponseV2.md new file mode 100644 index 00000000..012cc26a --- /dev/null +++ b/docs/v2/ontologies/models/BatchApplyActionResponseV2.md @@ -0,0 +1,11 @@ +# BatchApplyActionResponseV2 + +BatchApplyActionResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**edits** | Optional[ActionResults] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/BatchApplyActionResponseV2Dict.md b/docs/v2/ontologies/models/BatchApplyActionResponseV2Dict.md new file mode 100644 index 00000000..fbfecfd7 --- /dev/null +++ b/docs/v2/ontologies/models/BatchApplyActionResponseV2Dict.md @@ -0,0 +1,11 @@ +# BatchApplyActionResponseV2Dict + +BatchApplyActionResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**edits** | NotRequired[ActionResultsDict] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/BlueprintIcon.md b/docs/v2/ontologies/models/BlueprintIcon.md new file mode 100644 index 00000000..c9a79773 --- /dev/null +++ b/docs/v2/ontologies/models/BlueprintIcon.md @@ -0,0 +1,13 @@ +# BlueprintIcon + +BlueprintIcon + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**color** | StrictStr | Yes | A hexadecimal color code. | +**name** | StrictStr | Yes | The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. Used to specify the Blueprint icon to represent the object type in a React app. | +**type** | Literal["blueprint"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/BlueprintIconDict.md b/docs/v2/ontologies/models/BlueprintIconDict.md new file mode 100644 index 00000000..e4752159 --- /dev/null +++ b/docs/v2/ontologies/models/BlueprintIconDict.md @@ -0,0 +1,13 @@ +# BlueprintIconDict + +BlueprintIcon + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**color** | StrictStr | Yes | A hexadecimal color code. | +**name** | StrictStr | Yes | The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. Used to specify the Blueprint icon to represent the object type in a React app. | +**type** | Literal["blueprint"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/BoundingBoxValue.md b/docs/v2/ontologies/models/BoundingBoxValue.md new file mode 100644 index 00000000..4aaf5ddb --- /dev/null +++ b/docs/v2/ontologies/models/BoundingBoxValue.md @@ -0,0 +1,13 @@ +# BoundingBoxValue + +The top left and bottom right coordinate points that make up the bounding box. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**top_left** | WithinBoundingBoxPoint | Yes | | +**bottom_right** | WithinBoundingBoxPoint | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/BoundingBoxValueDict.md b/docs/v2/ontologies/models/BoundingBoxValueDict.md new file mode 100644 index 00000000..798b6dd2 --- /dev/null +++ b/docs/v2/ontologies/models/BoundingBoxValueDict.md @@ -0,0 +1,13 @@ +# BoundingBoxValueDict + +The top left and bottom right coordinate points that make up the bounding box. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**topLeft** | WithinBoundingBoxPointDict | Yes | | +**bottomRight** | WithinBoundingBoxPointDict | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CenterPoint.md b/docs/v2/ontologies/models/CenterPoint.md new file mode 100644 index 00000000..83354b50 --- /dev/null +++ b/docs/v2/ontologies/models/CenterPoint.md @@ -0,0 +1,13 @@ +# CenterPoint + +The coordinate point to use as the center of the distance query. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**center** | CenterPointTypes | Yes | | +**distance** | Distance | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CenterPointDict.md b/docs/v2/ontologies/models/CenterPointDict.md new file mode 100644 index 00000000..e03b9d25 --- /dev/null +++ b/docs/v2/ontologies/models/CenterPointDict.md @@ -0,0 +1,13 @@ +# CenterPointDict + +The coordinate point to use as the center of the distance query. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**center** | CenterPointTypesDict | Yes | | +**distance** | DistanceDict | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CenterPointTypes.md b/docs/v2/ontologies/models/CenterPointTypes.md new file mode 100644 index 00000000..b9f26bfb --- /dev/null +++ b/docs/v2/ontologies/models/CenterPointTypes.md @@ -0,0 +1,11 @@ +# CenterPointTypes + +CenterPointTypes + +## Type +```python +GeoPoint +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CenterPointTypesDict.md b/docs/v2/ontologies/models/CenterPointTypesDict.md new file mode 100644 index 00000000..8e9957ba --- /dev/null +++ b/docs/v2/ontologies/models/CenterPointTypesDict.md @@ -0,0 +1,11 @@ +# CenterPointTypesDict + +CenterPointTypes + +## Type +```python +GeoPointDict +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ContainsAllTermsInOrderPrefixLastTerm.md b/docs/v2/ontologies/models/ContainsAllTermsInOrderPrefixLastTerm.md new file mode 100644 index 00000000..ec00d9cf --- /dev/null +++ b/docs/v2/ontologies/models/ContainsAllTermsInOrderPrefixLastTerm.md @@ -0,0 +1,16 @@ +# ContainsAllTermsInOrderPrefixLastTerm + +Returns objects where the specified field contains all of the terms in the order provided, +but they do have to be adjacent to each other. +The last term can be a partial prefix match. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | StrictStr | Yes | | +**type** | Literal["containsAllTermsInOrderPrefixLastTerm"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ContainsAllTermsInOrderPrefixLastTermDict.md b/docs/v2/ontologies/models/ContainsAllTermsInOrderPrefixLastTermDict.md new file mode 100644 index 00000000..bc937a50 --- /dev/null +++ b/docs/v2/ontologies/models/ContainsAllTermsInOrderPrefixLastTermDict.md @@ -0,0 +1,16 @@ +# ContainsAllTermsInOrderPrefixLastTermDict + +Returns objects where the specified field contains all of the terms in the order provided, +but they do have to be adjacent to each other. +The last term can be a partial prefix match. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | StrictStr | Yes | | +**type** | Literal["containsAllTermsInOrderPrefixLastTerm"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ContainsAllTermsInOrderQuery.md b/docs/v2/ontologies/models/ContainsAllTermsInOrderQuery.md new file mode 100644 index 00000000..6f98e5b0 --- /dev/null +++ b/docs/v2/ontologies/models/ContainsAllTermsInOrderQuery.md @@ -0,0 +1,15 @@ +# ContainsAllTermsInOrderQuery + +Returns objects where the specified field contains all of the terms in the order provided, +but they do have to be adjacent to each other. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | StrictStr | Yes | | +**type** | Literal["containsAllTermsInOrder"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ContainsAllTermsInOrderQueryDict.md b/docs/v2/ontologies/models/ContainsAllTermsInOrderQueryDict.md new file mode 100644 index 00000000..03fd734b --- /dev/null +++ b/docs/v2/ontologies/models/ContainsAllTermsInOrderQueryDict.md @@ -0,0 +1,15 @@ +# ContainsAllTermsInOrderQueryDict + +Returns objects where the specified field contains all of the terms in the order provided, +but they do have to be adjacent to each other. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | StrictStr | Yes | | +**type** | Literal["containsAllTermsInOrder"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ContainsAllTermsQuery.md b/docs/v2/ontologies/models/ContainsAllTermsQuery.md new file mode 100644 index 00000000..86d36b51 --- /dev/null +++ b/docs/v2/ontologies/models/ContainsAllTermsQuery.md @@ -0,0 +1,16 @@ +# ContainsAllTermsQuery + +Returns objects where the specified field contains all of the whitespace separated words in any +order in the provided value. This query supports fuzzy matching. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | StrictStr | Yes | | +**fuzzy** | Optional[FuzzyV2] | No | | +**type** | Literal["containsAllTerms"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ContainsAllTermsQueryDict.md b/docs/v2/ontologies/models/ContainsAllTermsQueryDict.md new file mode 100644 index 00000000..21d746e5 --- /dev/null +++ b/docs/v2/ontologies/models/ContainsAllTermsQueryDict.md @@ -0,0 +1,16 @@ +# ContainsAllTermsQueryDict + +Returns objects where the specified field contains all of the whitespace separated words in any +order in the provided value. This query supports fuzzy matching. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | StrictStr | Yes | | +**fuzzy** | NotRequired[FuzzyV2] | No | | +**type** | Literal["containsAllTerms"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ContainsAnyTermQuery.md b/docs/v2/ontologies/models/ContainsAnyTermQuery.md new file mode 100644 index 00000000..1fd059b3 --- /dev/null +++ b/docs/v2/ontologies/models/ContainsAnyTermQuery.md @@ -0,0 +1,16 @@ +# ContainsAnyTermQuery + +Returns objects where the specified field contains any of the whitespace separated words in any +order in the provided value. This query supports fuzzy matching. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | StrictStr | Yes | | +**fuzzy** | Optional[FuzzyV2] | No | | +**type** | Literal["containsAnyTerm"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ContainsAnyTermQueryDict.md b/docs/v2/ontologies/models/ContainsAnyTermQueryDict.md new file mode 100644 index 00000000..896bb45c --- /dev/null +++ b/docs/v2/ontologies/models/ContainsAnyTermQueryDict.md @@ -0,0 +1,16 @@ +# ContainsAnyTermQueryDict + +Returns objects where the specified field contains any of the whitespace separated words in any +order in the provided value. This query supports fuzzy matching. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | StrictStr | Yes | | +**fuzzy** | NotRequired[FuzzyV2] | No | | +**type** | Literal["containsAnyTerm"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ContainsQueryV2.md b/docs/v2/ontologies/models/ContainsQueryV2.md new file mode 100644 index 00000000..39d42fe0 --- /dev/null +++ b/docs/v2/ontologies/models/ContainsQueryV2.md @@ -0,0 +1,13 @@ +# ContainsQueryV2 + +Returns objects where the specified array contains a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["contains"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ContainsQueryV2Dict.md b/docs/v2/ontologies/models/ContainsQueryV2Dict.md new file mode 100644 index 00000000..15b2169c --- /dev/null +++ b/docs/v2/ontologies/models/ContainsQueryV2Dict.md @@ -0,0 +1,13 @@ +# ContainsQueryV2Dict + +Returns objects where the specified array contains a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["contains"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CountAggregationV2Dict.md b/docs/v2/ontologies/models/CountAggregationV2Dict.md new file mode 100644 index 00000000..7c41407a --- /dev/null +++ b/docs/v2/ontologies/models/CountAggregationV2Dict.md @@ -0,0 +1,13 @@ +# CountAggregationV2Dict + +Computes the total count of objects. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**name** | NotRequired[AggregationMetricName] | No | | +**direction** | NotRequired[OrderByDirection] | No | | +**type** | Literal["count"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CountObjectsResponseV2.md b/docs/v2/ontologies/models/CountObjectsResponseV2.md new file mode 100644 index 00000000..b66c4231 --- /dev/null +++ b/docs/v2/ontologies/models/CountObjectsResponseV2.md @@ -0,0 +1,11 @@ +# CountObjectsResponseV2 + +CountObjectsResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**count** | Optional[StrictInt] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CountObjectsResponseV2Dict.md b/docs/v2/ontologies/models/CountObjectsResponseV2Dict.md new file mode 100644 index 00000000..aa69bf62 --- /dev/null +++ b/docs/v2/ontologies/models/CountObjectsResponseV2Dict.md @@ -0,0 +1,11 @@ +# CountObjectsResponseV2Dict + +CountObjectsResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**count** | NotRequired[StrictInt] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CreateInterfaceObjectRule.md b/docs/v2/ontologies/models/CreateInterfaceObjectRule.md new file mode 100644 index 00000000..1cbac523 --- /dev/null +++ b/docs/v2/ontologies/models/CreateInterfaceObjectRule.md @@ -0,0 +1,11 @@ +# CreateInterfaceObjectRule + +CreateInterfaceObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["createInterfaceObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CreateInterfaceObjectRuleDict.md b/docs/v2/ontologies/models/CreateInterfaceObjectRuleDict.md new file mode 100644 index 00000000..5826dcc7 --- /dev/null +++ b/docs/v2/ontologies/models/CreateInterfaceObjectRuleDict.md @@ -0,0 +1,11 @@ +# CreateInterfaceObjectRuleDict + +CreateInterfaceObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["createInterfaceObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CreateLinkRule.md b/docs/v2/ontologies/models/CreateLinkRule.md new file mode 100644 index 00000000..20b3fb0e --- /dev/null +++ b/docs/v2/ontologies/models/CreateLinkRule.md @@ -0,0 +1,15 @@ +# CreateLinkRule + +CreateLinkRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**link_type_api_name_ato_b** | LinkTypeApiName | Yes | | +**link_type_api_name_bto_a** | LinkTypeApiName | Yes | | +**a_side_object_type_api_name** | ObjectTypeApiName | Yes | | +**b_side_object_type_api_name** | ObjectTypeApiName | Yes | | +**type** | Literal["createLink"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CreateLinkRuleDict.md b/docs/v2/ontologies/models/CreateLinkRuleDict.md new file mode 100644 index 00000000..35d65722 --- /dev/null +++ b/docs/v2/ontologies/models/CreateLinkRuleDict.md @@ -0,0 +1,15 @@ +# CreateLinkRuleDict + +CreateLinkRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | +**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | +**aSideObjectTypeApiName** | ObjectTypeApiName | Yes | | +**bSideObjectTypeApiName** | ObjectTypeApiName | Yes | | +**type** | Literal["createLink"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CreateObjectRule.md b/docs/v2/ontologies/models/CreateObjectRule.md new file mode 100644 index 00000000..b8740ae4 --- /dev/null +++ b/docs/v2/ontologies/models/CreateObjectRule.md @@ -0,0 +1,12 @@ +# CreateObjectRule + +CreateObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_type_api_name** | ObjectTypeApiName | Yes | | +**type** | Literal["createObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CreateObjectRuleDict.md b/docs/v2/ontologies/models/CreateObjectRuleDict.md new file mode 100644 index 00000000..81877aa6 --- /dev/null +++ b/docs/v2/ontologies/models/CreateObjectRuleDict.md @@ -0,0 +1,12 @@ +# CreateObjectRuleDict + +CreateObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectTypeApiName** | ObjectTypeApiName | Yes | | +**type** | Literal["createObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CreateTemporaryObjectSetResponseV2.md b/docs/v2/ontologies/models/CreateTemporaryObjectSetResponseV2.md new file mode 100644 index 00000000..e1260c7e --- /dev/null +++ b/docs/v2/ontologies/models/CreateTemporaryObjectSetResponseV2.md @@ -0,0 +1,11 @@ +# CreateTemporaryObjectSetResponseV2 + +CreateTemporaryObjectSetResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_set_rid** | ObjectSetRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CreateTemporaryObjectSetResponseV2Dict.md b/docs/v2/ontologies/models/CreateTemporaryObjectSetResponseV2Dict.md new file mode 100644 index 00000000..a7b25b3b --- /dev/null +++ b/docs/v2/ontologies/models/CreateTemporaryObjectSetResponseV2Dict.md @@ -0,0 +1,11 @@ +# CreateTemporaryObjectSetResponseV2Dict + +CreateTemporaryObjectSetResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectSetRid** | ObjectSetRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/DataValue.md b/docs/v2/ontologies/models/DataValue.md new file mode 100644 index 00000000..d04c9da9 --- /dev/null +++ b/docs/v2/ontologies/models/DataValue.md @@ -0,0 +1,35 @@ +# DataValue + +Represents the value of data in the following format. Note that these values can be nested, for example an array of structs. +| Type | JSON encoding | Example | +|-----------------------------|-------------------------------------------------------|-------------------------------------------------------------------------------| +| Array | array | `["alpha", "bravo", "charlie"]` | +| Attachment | string | `"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"` | +| Boolean | boolean | `true` | +| Byte | number | `31` | +| Date | ISO 8601 extended local date string | `"2021-05-01"` | +| Decimal | string | `"2.718281828"` | +| Float | number | `3.14159265` | +| Double | number | `3.14159265` | +| Integer | number | `238940` | +| Long | string | `"58319870951433"` | +| Marking | string | `"MU"` | +| Null | null | `null` | +| Object Set | string OR the object set definition | `ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z`| +| Ontology Object Reference | JSON encoding of the object's primary key | `10033123` or `"EMP1234"` | +| Set | array | `["alpha", "bravo", "charlie"]` | +| Short | number | `8739` | +| String | string | `"Call me Ishmael"` | +| Struct | JSON object | `{"name": "John Doe", "age": 42}` | +| TwoDimensionalAggregation | JSON object | `{"groups": [{"key": "alpha", "value": 100}, {"key": "beta", "value": 101}]}` | +| ThreeDimensionalAggregation | JSON object | `{"groups": [{"key": "NYC", "groups": [{"key": "Engineer", "value" : 100}]}]}`| +| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | + + +## Type +```python +Any +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/DeleteLinkRule.md b/docs/v2/ontologies/models/DeleteLinkRule.md new file mode 100644 index 00000000..8dc15d73 --- /dev/null +++ b/docs/v2/ontologies/models/DeleteLinkRule.md @@ -0,0 +1,15 @@ +# DeleteLinkRule + +DeleteLinkRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**link_type_api_name_ato_b** | LinkTypeApiName | Yes | | +**link_type_api_name_bto_a** | LinkTypeApiName | Yes | | +**a_side_object_type_api_name** | ObjectTypeApiName | Yes | | +**b_side_object_type_api_name** | ObjectTypeApiName | Yes | | +**type** | Literal["deleteLink"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/DeleteLinkRuleDict.md b/docs/v2/ontologies/models/DeleteLinkRuleDict.md new file mode 100644 index 00000000..c9b82b10 --- /dev/null +++ b/docs/v2/ontologies/models/DeleteLinkRuleDict.md @@ -0,0 +1,15 @@ +# DeleteLinkRuleDict + +DeleteLinkRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**linkTypeApiNameAtoB** | LinkTypeApiName | Yes | | +**linkTypeApiNameBtoA** | LinkTypeApiName | Yes | | +**aSideObjectTypeApiName** | ObjectTypeApiName | Yes | | +**bSideObjectTypeApiName** | ObjectTypeApiName | Yes | | +**type** | Literal["deleteLink"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/DeleteObjectRule.md b/docs/v2/ontologies/models/DeleteObjectRule.md new file mode 100644 index 00000000..153e4777 --- /dev/null +++ b/docs/v2/ontologies/models/DeleteObjectRule.md @@ -0,0 +1,12 @@ +# DeleteObjectRule + +DeleteObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_type_api_name** | ObjectTypeApiName | Yes | | +**type** | Literal["deleteObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/DeleteObjectRuleDict.md b/docs/v2/ontologies/models/DeleteObjectRuleDict.md new file mode 100644 index 00000000..6fd00f1a --- /dev/null +++ b/docs/v2/ontologies/models/DeleteObjectRuleDict.md @@ -0,0 +1,12 @@ +# DeleteObjectRuleDict + +DeleteObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectTypeApiName** | ObjectTypeApiName | Yes | | +**type** | Literal["deleteObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/DoesNotIntersectBoundingBoxQuery.md b/docs/v2/ontologies/models/DoesNotIntersectBoundingBoxQuery.md new file mode 100644 index 00000000..a7727b25 --- /dev/null +++ b/docs/v2/ontologies/models/DoesNotIntersectBoundingBoxQuery.md @@ -0,0 +1,14 @@ +# DoesNotIntersectBoundingBoxQuery + +Returns objects where the specified field does not intersect the bounding box provided. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | BoundingBoxValue | Yes | | +**type** | Literal["doesNotIntersectBoundingBox"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/DoesNotIntersectBoundingBoxQueryDict.md b/docs/v2/ontologies/models/DoesNotIntersectBoundingBoxQueryDict.md new file mode 100644 index 00000000..3438a25d --- /dev/null +++ b/docs/v2/ontologies/models/DoesNotIntersectBoundingBoxQueryDict.md @@ -0,0 +1,14 @@ +# DoesNotIntersectBoundingBoxQueryDict + +Returns objects where the specified field does not intersect the bounding box provided. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | BoundingBoxValueDict | Yes | | +**type** | Literal["doesNotIntersectBoundingBox"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/DoesNotIntersectPolygonQuery.md b/docs/v2/ontologies/models/DoesNotIntersectPolygonQuery.md new file mode 100644 index 00000000..8fd868ee --- /dev/null +++ b/docs/v2/ontologies/models/DoesNotIntersectPolygonQuery.md @@ -0,0 +1,14 @@ +# DoesNotIntersectPolygonQuery + +Returns objects where the specified field does not intersect the polygon provided. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PolygonValue | Yes | | +**type** | Literal["doesNotIntersectPolygon"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/DoesNotIntersectPolygonQueryDict.md b/docs/v2/ontologies/models/DoesNotIntersectPolygonQueryDict.md new file mode 100644 index 00000000..711498b3 --- /dev/null +++ b/docs/v2/ontologies/models/DoesNotIntersectPolygonQueryDict.md @@ -0,0 +1,14 @@ +# DoesNotIntersectPolygonQueryDict + +Returns objects where the specified field does not intersect the polygon provided. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PolygonValueDict | Yes | | +**type** | Literal["doesNotIntersectPolygon"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/EqualsQueryV2.md b/docs/v2/ontologies/models/EqualsQueryV2.md new file mode 100644 index 00000000..b461a199 --- /dev/null +++ b/docs/v2/ontologies/models/EqualsQueryV2.md @@ -0,0 +1,13 @@ +# EqualsQueryV2 + +Returns objects where the specified field is equal to a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["eq"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/EqualsQueryV2Dict.md b/docs/v2/ontologies/models/EqualsQueryV2Dict.md new file mode 100644 index 00000000..dba9782e --- /dev/null +++ b/docs/v2/ontologies/models/EqualsQueryV2Dict.md @@ -0,0 +1,13 @@ +# EqualsQueryV2Dict + +Returns objects where the specified field is equal to a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["eq"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ExactDistinctAggregationV2Dict.md b/docs/v2/ontologies/models/ExactDistinctAggregationV2Dict.md new file mode 100644 index 00000000..06956ab6 --- /dev/null +++ b/docs/v2/ontologies/models/ExactDistinctAggregationV2Dict.md @@ -0,0 +1,14 @@ +# ExactDistinctAggregationV2Dict + +Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**name** | NotRequired[AggregationMetricName] | No | | +**direction** | NotRequired[OrderByDirection] | No | | +**type** | Literal["exactDistinct"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ExecuteQueryResponse.md b/docs/v2/ontologies/models/ExecuteQueryResponse.md new file mode 100644 index 00000000..7fb62023 --- /dev/null +++ b/docs/v2/ontologies/models/ExecuteQueryResponse.md @@ -0,0 +1,11 @@ +# ExecuteQueryResponse + +ExecuteQueryResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | DataValue | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ExecuteQueryResponseDict.md b/docs/v2/ontologies/models/ExecuteQueryResponseDict.md new file mode 100644 index 00000000..15bb6b00 --- /dev/null +++ b/docs/v2/ontologies/models/ExecuteQueryResponseDict.md @@ -0,0 +1,11 @@ +# ExecuteQueryResponseDict + +ExecuteQueryResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | DataValue | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/FunctionRid.md b/docs/v2/ontologies/models/FunctionRid.md new file mode 100644 index 00000000..2ea83761 --- /dev/null +++ b/docs/v2/ontologies/models/FunctionRid.md @@ -0,0 +1,12 @@ +# FunctionRid + +The unique resource identifier of a Function, useful for interacting with other Foundry APIs. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/FunctionVersion.md b/docs/v2/ontologies/models/FunctionVersion.md new file mode 100644 index 00000000..f8c88d6b --- /dev/null +++ b/docs/v2/ontologies/models/FunctionVersion.md @@ -0,0 +1,13 @@ +# FunctionVersion + +The version of the given Function, written `..-`, where `-` is optional. +Examples: `1.2.3`, `1.2.3-rc1`. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/FuzzyV2.md b/docs/v2/ontologies/models/FuzzyV2.md new file mode 100644 index 00000000..9e2ebb2b --- /dev/null +++ b/docs/v2/ontologies/models/FuzzyV2.md @@ -0,0 +1,11 @@ +# FuzzyV2 + +Setting fuzzy to `true` allows approximate matching in search queries that support it. + +## Type +```python +StrictBool +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/GroupMemberConstraint.md b/docs/v2/ontologies/models/GroupMemberConstraint.md new file mode 100644 index 00000000..7560da96 --- /dev/null +++ b/docs/v2/ontologies/models/GroupMemberConstraint.md @@ -0,0 +1,12 @@ +# GroupMemberConstraint + +The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["groupMember"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/GroupMemberConstraintDict.md b/docs/v2/ontologies/models/GroupMemberConstraintDict.md new file mode 100644 index 00000000..c2f0449b --- /dev/null +++ b/docs/v2/ontologies/models/GroupMemberConstraintDict.md @@ -0,0 +1,12 @@ +# GroupMemberConstraintDict + +The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["groupMember"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/GtQueryV2.md b/docs/v2/ontologies/models/GtQueryV2.md new file mode 100644 index 00000000..5b2f5fcb --- /dev/null +++ b/docs/v2/ontologies/models/GtQueryV2.md @@ -0,0 +1,13 @@ +# GtQueryV2 + +Returns objects where the specified field is greater than a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["gt"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/GtQueryV2Dict.md b/docs/v2/ontologies/models/GtQueryV2Dict.md new file mode 100644 index 00000000..ca670bb2 --- /dev/null +++ b/docs/v2/ontologies/models/GtQueryV2Dict.md @@ -0,0 +1,13 @@ +# GtQueryV2Dict + +Returns objects where the specified field is greater than a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["gt"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/GteQueryV2.md b/docs/v2/ontologies/models/GteQueryV2.md new file mode 100644 index 00000000..1474bf2e --- /dev/null +++ b/docs/v2/ontologies/models/GteQueryV2.md @@ -0,0 +1,13 @@ +# GteQueryV2 + +Returns objects where the specified field is greater than or equal to a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["gte"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/GteQueryV2Dict.md b/docs/v2/ontologies/models/GteQueryV2Dict.md new file mode 100644 index 00000000..32093b06 --- /dev/null +++ b/docs/v2/ontologies/models/GteQueryV2Dict.md @@ -0,0 +1,13 @@ +# GteQueryV2Dict + +Returns objects where the specified field is greater than or equal to a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["gte"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/Icon.md b/docs/v2/ontologies/models/Icon.md new file mode 100644 index 00000000..c8a0720c --- /dev/null +++ b/docs/v2/ontologies/models/Icon.md @@ -0,0 +1,11 @@ +# Icon + +A union currently only consisting of the BlueprintIcon (more icon types may be added in the future). + +## Type +```python +BlueprintIcon +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/IconDict.md b/docs/v2/ontologies/models/IconDict.md new file mode 100644 index 00000000..4614c427 --- /dev/null +++ b/docs/v2/ontologies/models/IconDict.md @@ -0,0 +1,11 @@ +# IconDict + +A union currently only consisting of the BlueprintIcon (more icon types may be added in the future). + +## Type +```python +BlueprintIconDict +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/InterfaceLinkType.md b/docs/v2/ontologies/models/InterfaceLinkType.md new file mode 100644 index 00000000..d432b926 --- /dev/null +++ b/docs/v2/ontologies/models/InterfaceLinkType.md @@ -0,0 +1,19 @@ +# InterfaceLinkType + +A link type constraint defined at the interface level where the implementation of the links is provided +by the implementing object types. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | InterfaceLinkTypeRid | Yes | | +**api_name** | InterfaceLinkTypeApiName | Yes | | +**display_name** | DisplayName | Yes | | +**description** | Optional[StrictStr] | No | The description of the interface link type. | +**linked_entity_api_name** | InterfaceLinkTypeLinkedEntityApiName | Yes | | +**cardinality** | InterfaceLinkTypeCardinality | Yes | | +**required** | StrictBool | Yes | Whether each implementing object type must declare at least one implementation of this link. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/InterfaceLinkTypeApiName.md b/docs/v2/ontologies/models/InterfaceLinkTypeApiName.md new file mode 100644 index 00000000..403509d5 --- /dev/null +++ b/docs/v2/ontologies/models/InterfaceLinkTypeApiName.md @@ -0,0 +1,11 @@ +# InterfaceLinkTypeApiName + +A string indicating the API name to use for the interface link. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/InterfaceLinkTypeCardinality.md b/docs/v2/ontologies/models/InterfaceLinkTypeCardinality.md new file mode 100644 index 00000000..7ab218f7 --- /dev/null +++ b/docs/v2/ontologies/models/InterfaceLinkTypeCardinality.md @@ -0,0 +1,13 @@ +# InterfaceLinkTypeCardinality + +The cardinality of the link in the given direction. Cardinality can be "ONE", meaning an object can +link to zero or one other objects, or "MANY", meaning an object can link to any number of other objects. + + +| **Value** | +| --------- | +| `"ONE"` | +| `"MANY"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/InterfaceLinkTypeDict.md b/docs/v2/ontologies/models/InterfaceLinkTypeDict.md new file mode 100644 index 00000000..3dfc9978 --- /dev/null +++ b/docs/v2/ontologies/models/InterfaceLinkTypeDict.md @@ -0,0 +1,19 @@ +# InterfaceLinkTypeDict + +A link type constraint defined at the interface level where the implementation of the links is provided +by the implementing object types. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | InterfaceLinkTypeRid | Yes | | +**apiName** | InterfaceLinkTypeApiName | Yes | | +**displayName** | DisplayName | Yes | | +**description** | NotRequired[StrictStr] | No | The description of the interface link type. | +**linkedEntityApiName** | InterfaceLinkTypeLinkedEntityApiNameDict | Yes | | +**cardinality** | InterfaceLinkTypeCardinality | Yes | | +**required** | StrictBool | Yes | Whether each implementing object type must declare at least one implementation of this link. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/InterfaceLinkTypeLinkedEntityApiName.md b/docs/v2/ontologies/models/InterfaceLinkTypeLinkedEntityApiName.md new file mode 100644 index 00000000..2ac8b7fe --- /dev/null +++ b/docs/v2/ontologies/models/InterfaceLinkTypeLinkedEntityApiName.md @@ -0,0 +1,16 @@ +# InterfaceLinkTypeLinkedEntityApiName + +A reference to the linked entity. This can either be an object or an interface type. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +LinkedObjectTypeApiName | objectTypeApiName +LinkedInterfaceTypeApiName | interfaceTypeApiName + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/InterfaceLinkTypeLinkedEntityApiNameDict.md b/docs/v2/ontologies/models/InterfaceLinkTypeLinkedEntityApiNameDict.md new file mode 100644 index 00000000..d6f5f81b --- /dev/null +++ b/docs/v2/ontologies/models/InterfaceLinkTypeLinkedEntityApiNameDict.md @@ -0,0 +1,16 @@ +# InterfaceLinkTypeLinkedEntityApiNameDict + +A reference to the linked entity. This can either be an object or an interface type. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +LinkedObjectTypeApiNameDict | objectTypeApiName +LinkedInterfaceTypeApiNameDict | interfaceTypeApiName + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/InterfaceLinkTypeRid.md b/docs/v2/ontologies/models/InterfaceLinkTypeRid.md new file mode 100644 index 00000000..c44e3302 --- /dev/null +++ b/docs/v2/ontologies/models/InterfaceLinkTypeRid.md @@ -0,0 +1,12 @@ +# InterfaceLinkTypeRid + +The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/InterfaceType.md b/docs/v2/ontologies/models/InterfaceType.md new file mode 100644 index 00000000..1c3d4818 --- /dev/null +++ b/docs/v2/ontologies/models/InterfaceType.md @@ -0,0 +1,17 @@ +# InterfaceType + +Represents an interface type in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | InterfaceTypeRid | Yes | | +**api_name** | InterfaceTypeApiName | Yes | | +**display_name** | DisplayName | Yes | | +**description** | Optional[StrictStr] | No | The description of the interface. | +**properties** | Dict[SharedPropertyTypeApiName, SharedPropertyType] | Yes | A map from a shared property type API name to the corresponding shared property type. The map describes the set of properties the interface has. A shared property type must be unique across all of the properties. | +**extends_interfaces** | List[InterfaceTypeApiName] | Yes | A list of interface API names that this interface extends. An interface can extend other interfaces to inherit their properties. | +**links** | Dict[InterfaceLinkTypeApiName, InterfaceLinkType] | Yes | A map from an interface link type API name to the corresponding interface link type. The map describes the set of link types the interface has. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/InterfaceTypeApiName.md b/docs/v2/ontologies/models/InterfaceTypeApiName.md new file mode 100644 index 00000000..884971cd --- /dev/null +++ b/docs/v2/ontologies/models/InterfaceTypeApiName.md @@ -0,0 +1,13 @@ +# InterfaceTypeApiName + +The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface +type, use the `List interface types` endpoint or check the **Ontology Manager**. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/InterfaceTypeDict.md b/docs/v2/ontologies/models/InterfaceTypeDict.md new file mode 100644 index 00000000..1d9c04c1 --- /dev/null +++ b/docs/v2/ontologies/models/InterfaceTypeDict.md @@ -0,0 +1,17 @@ +# InterfaceTypeDict + +Represents an interface type in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | InterfaceTypeRid | Yes | | +**apiName** | InterfaceTypeApiName | Yes | | +**displayName** | DisplayName | Yes | | +**description** | NotRequired[StrictStr] | No | The description of the interface. | +**properties** | Dict[SharedPropertyTypeApiName, SharedPropertyTypeDict] | Yes | A map from a shared property type API name to the corresponding shared property type. The map describes the set of properties the interface has. A shared property type must be unique across all of the properties. | +**extendsInterfaces** | List[InterfaceTypeApiName] | Yes | A list of interface API names that this interface extends. An interface can extend other interfaces to inherit their properties. | +**links** | Dict[InterfaceLinkTypeApiName, InterfaceLinkTypeDict] | Yes | A map from an interface link type API name to the corresponding interface link type. The map describes the set of link types the interface has. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/InterfaceTypeRid.md b/docs/v2/ontologies/models/InterfaceTypeRid.md new file mode 100644 index 00000000..bee01df1 --- /dev/null +++ b/docs/v2/ontologies/models/InterfaceTypeRid.md @@ -0,0 +1,11 @@ +# InterfaceTypeRid + +The unique resource identifier of an interface, useful for interacting with other Foundry APIs. + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/IntersectsBoundingBoxQuery.md b/docs/v2/ontologies/models/IntersectsBoundingBoxQuery.md new file mode 100644 index 00000000..e7484d3a --- /dev/null +++ b/docs/v2/ontologies/models/IntersectsBoundingBoxQuery.md @@ -0,0 +1,14 @@ +# IntersectsBoundingBoxQuery + +Returns objects where the specified field intersects the bounding box provided. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | BoundingBoxValue | Yes | | +**type** | Literal["intersectsBoundingBox"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/IntersectsBoundingBoxQueryDict.md b/docs/v2/ontologies/models/IntersectsBoundingBoxQueryDict.md new file mode 100644 index 00000000..3cd919c9 --- /dev/null +++ b/docs/v2/ontologies/models/IntersectsBoundingBoxQueryDict.md @@ -0,0 +1,14 @@ +# IntersectsBoundingBoxQueryDict + +Returns objects where the specified field intersects the bounding box provided. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | BoundingBoxValueDict | Yes | | +**type** | Literal["intersectsBoundingBox"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/IntersectsPolygonQuery.md b/docs/v2/ontologies/models/IntersectsPolygonQuery.md new file mode 100644 index 00000000..8e344830 --- /dev/null +++ b/docs/v2/ontologies/models/IntersectsPolygonQuery.md @@ -0,0 +1,14 @@ +# IntersectsPolygonQuery + +Returns objects where the specified field intersects the polygon provided. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PolygonValue | Yes | | +**type** | Literal["intersectsPolygon"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/IntersectsPolygonQueryDict.md b/docs/v2/ontologies/models/IntersectsPolygonQueryDict.md new file mode 100644 index 00000000..cd6120f6 --- /dev/null +++ b/docs/v2/ontologies/models/IntersectsPolygonQueryDict.md @@ -0,0 +1,14 @@ +# IntersectsPolygonQueryDict + +Returns objects where the specified field intersects the polygon provided. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PolygonValueDict | Yes | | +**type** | Literal["intersectsPolygon"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/IsNullQueryV2.md b/docs/v2/ontologies/models/IsNullQueryV2.md new file mode 100644 index 00000000..5369ab36 --- /dev/null +++ b/docs/v2/ontologies/models/IsNullQueryV2.md @@ -0,0 +1,13 @@ +# IsNullQueryV2 + +Returns objects based on the existence of the specified field. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | StrictBool | Yes | | +**type** | Literal["isNull"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/IsNullQueryV2Dict.md b/docs/v2/ontologies/models/IsNullQueryV2Dict.md new file mode 100644 index 00000000..4776086c --- /dev/null +++ b/docs/v2/ontologies/models/IsNullQueryV2Dict.md @@ -0,0 +1,13 @@ +# IsNullQueryV2Dict + +Returns objects based on the existence of the specified field. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | StrictBool | Yes | | +**type** | Literal["isNull"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LinkSideObject.md b/docs/v2/ontologies/models/LinkSideObject.md new file mode 100644 index 00000000..8d151359 --- /dev/null +++ b/docs/v2/ontologies/models/LinkSideObject.md @@ -0,0 +1,12 @@ +# LinkSideObject + +LinkSideObject + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**primary_key** | PropertyValue | Yes | | +**object_type** | ObjectTypeApiName | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LinkSideObjectDict.md b/docs/v2/ontologies/models/LinkSideObjectDict.md new file mode 100644 index 00000000..b25e1166 --- /dev/null +++ b/docs/v2/ontologies/models/LinkSideObjectDict.md @@ -0,0 +1,12 @@ +# LinkSideObjectDict + +LinkSideObject + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**primaryKey** | PropertyValue | Yes | | +**objectType** | ObjectTypeApiName | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LinkTypeApiName.md b/docs/v2/ontologies/models/LinkTypeApiName.md new file mode 100644 index 00000000..575e66c1 --- /dev/null +++ b/docs/v2/ontologies/models/LinkTypeApiName.md @@ -0,0 +1,13 @@ +# LinkTypeApiName + +The name of the link type in the API. To find the API name for your Link Type, check the **Ontology Manager** +application. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LinkTypeRid.md b/docs/v2/ontologies/models/LinkTypeRid.md new file mode 100644 index 00000000..4b22d8bc --- /dev/null +++ b/docs/v2/ontologies/models/LinkTypeRid.md @@ -0,0 +1,11 @@ +# LinkTypeRid + +LinkTypeRid + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LinkTypeSideCardinality.md b/docs/v2/ontologies/models/LinkTypeSideCardinality.md new file mode 100644 index 00000000..ccc7b693 --- /dev/null +++ b/docs/v2/ontologies/models/LinkTypeSideCardinality.md @@ -0,0 +1,11 @@ +# LinkTypeSideCardinality + +LinkTypeSideCardinality + +| **Value** | +| --------- | +| `"ONE"` | +| `"MANY"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LinkTypeSideV2.md b/docs/v2/ontologies/models/LinkTypeSideV2.md new file mode 100644 index 00000000..3b979372 --- /dev/null +++ b/docs/v2/ontologies/models/LinkTypeSideV2.md @@ -0,0 +1,17 @@ +# LinkTypeSideV2 + +LinkTypeSideV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**api_name** | LinkTypeApiName | Yes | | +**display_name** | DisplayName | Yes | | +**status** | ReleaseStatus | Yes | | +**object_type_api_name** | ObjectTypeApiName | Yes | | +**cardinality** | LinkTypeSideCardinality | Yes | | +**foreign_key_property_api_name** | Optional[PropertyApiName] | No | | +**link_type_rid** | LinkTypeRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LinkTypeSideV2Dict.md b/docs/v2/ontologies/models/LinkTypeSideV2Dict.md new file mode 100644 index 00000000..c011b266 --- /dev/null +++ b/docs/v2/ontologies/models/LinkTypeSideV2Dict.md @@ -0,0 +1,17 @@ +# LinkTypeSideV2Dict + +LinkTypeSideV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**apiName** | LinkTypeApiName | Yes | | +**displayName** | DisplayName | Yes | | +**status** | ReleaseStatus | Yes | | +**objectTypeApiName** | ObjectTypeApiName | Yes | | +**cardinality** | LinkTypeSideCardinality | Yes | | +**foreignKeyPropertyApiName** | NotRequired[PropertyApiName] | No | | +**linkTypeRid** | LinkTypeRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LinkedInterfaceTypeApiName.md b/docs/v2/ontologies/models/LinkedInterfaceTypeApiName.md new file mode 100644 index 00000000..7c966314 --- /dev/null +++ b/docs/v2/ontologies/models/LinkedInterfaceTypeApiName.md @@ -0,0 +1,12 @@ +# LinkedInterfaceTypeApiName + +A reference to the linked interface type. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**api_name** | InterfaceTypeApiName | Yes | | +**type** | Literal["interfaceTypeApiName"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LinkedInterfaceTypeApiNameDict.md b/docs/v2/ontologies/models/LinkedInterfaceTypeApiNameDict.md new file mode 100644 index 00000000..1d91151b --- /dev/null +++ b/docs/v2/ontologies/models/LinkedInterfaceTypeApiNameDict.md @@ -0,0 +1,12 @@ +# LinkedInterfaceTypeApiNameDict + +A reference to the linked interface type. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**apiName** | InterfaceTypeApiName | Yes | | +**type** | Literal["interfaceTypeApiName"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LinkedObjectTypeApiName.md b/docs/v2/ontologies/models/LinkedObjectTypeApiName.md new file mode 100644 index 00000000..cf22bd9e --- /dev/null +++ b/docs/v2/ontologies/models/LinkedObjectTypeApiName.md @@ -0,0 +1,12 @@ +# LinkedObjectTypeApiName + +A reference to the linked object type. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**api_name** | ObjectTypeApiName | Yes | | +**type** | Literal["objectTypeApiName"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LinkedObjectTypeApiNameDict.md b/docs/v2/ontologies/models/LinkedObjectTypeApiNameDict.md new file mode 100644 index 00000000..6adb8da7 --- /dev/null +++ b/docs/v2/ontologies/models/LinkedObjectTypeApiNameDict.md @@ -0,0 +1,12 @@ +# LinkedObjectTypeApiNameDict + +A reference to the linked object type. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**apiName** | ObjectTypeApiName | Yes | | +**type** | Literal["objectTypeApiName"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListActionTypesResponseV2.md b/docs/v2/ontologies/models/ListActionTypesResponseV2.md new file mode 100644 index 00000000..c9094113 --- /dev/null +++ b/docs/v2/ontologies/models/ListActionTypesResponseV2.md @@ -0,0 +1,12 @@ +# ListActionTypesResponseV2 + +ListActionTypesResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[ActionTypeV2] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListActionTypesResponseV2Dict.md b/docs/v2/ontologies/models/ListActionTypesResponseV2Dict.md new file mode 100644 index 00000000..adf351f4 --- /dev/null +++ b/docs/v2/ontologies/models/ListActionTypesResponseV2Dict.md @@ -0,0 +1,12 @@ +# ListActionTypesResponseV2Dict + +ListActionTypesResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[ActionTypeV2Dict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListAttachmentsResponseV2.md b/docs/v2/ontologies/models/ListAttachmentsResponseV2.md new file mode 100644 index 00000000..16a61bc6 --- /dev/null +++ b/docs/v2/ontologies/models/ListAttachmentsResponseV2.md @@ -0,0 +1,13 @@ +# ListAttachmentsResponseV2 + +ListAttachmentsResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[AttachmentV2] | Yes | | +**next_page_token** | Optional[PageToken] | No | | +**type** | Literal["multiple"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListAttachmentsResponseV2Dict.md b/docs/v2/ontologies/models/ListAttachmentsResponseV2Dict.md new file mode 100644 index 00000000..51eee480 --- /dev/null +++ b/docs/v2/ontologies/models/ListAttachmentsResponseV2Dict.md @@ -0,0 +1,13 @@ +# ListAttachmentsResponseV2Dict + +ListAttachmentsResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[AttachmentV2Dict] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | +**type** | Literal["multiple"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListInterfaceTypesResponse.md b/docs/v2/ontologies/models/ListInterfaceTypesResponse.md new file mode 100644 index 00000000..b81a5961 --- /dev/null +++ b/docs/v2/ontologies/models/ListInterfaceTypesResponse.md @@ -0,0 +1,12 @@ +# ListInterfaceTypesResponse + +ListInterfaceTypesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[InterfaceType] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListInterfaceTypesResponseDict.md b/docs/v2/ontologies/models/ListInterfaceTypesResponseDict.md new file mode 100644 index 00000000..8ac71000 --- /dev/null +++ b/docs/v2/ontologies/models/ListInterfaceTypesResponseDict.md @@ -0,0 +1,12 @@ +# ListInterfaceTypesResponseDict + +ListInterfaceTypesResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[InterfaceTypeDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListLinkedObjectsResponseV2.md b/docs/v2/ontologies/models/ListLinkedObjectsResponseV2.md new file mode 100644 index 00000000..e9419b77 --- /dev/null +++ b/docs/v2/ontologies/models/ListLinkedObjectsResponseV2.md @@ -0,0 +1,12 @@ +# ListLinkedObjectsResponseV2 + +ListLinkedObjectsResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[OntologyObjectV2] | Yes | | +**next_page_token** | Optional[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListLinkedObjectsResponseV2Dict.md b/docs/v2/ontologies/models/ListLinkedObjectsResponseV2Dict.md new file mode 100644 index 00000000..d50feafb --- /dev/null +++ b/docs/v2/ontologies/models/ListLinkedObjectsResponseV2Dict.md @@ -0,0 +1,12 @@ +# ListLinkedObjectsResponseV2Dict + +ListLinkedObjectsResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[OntologyObjectV2] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListObjectTypesV2Response.md b/docs/v2/ontologies/models/ListObjectTypesV2Response.md new file mode 100644 index 00000000..12c63d64 --- /dev/null +++ b/docs/v2/ontologies/models/ListObjectTypesV2Response.md @@ -0,0 +1,12 @@ +# ListObjectTypesV2Response + +ListObjectTypesV2Response + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[ObjectTypeV2] | Yes | The list of object types in the current page. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListObjectTypesV2ResponseDict.md b/docs/v2/ontologies/models/ListObjectTypesV2ResponseDict.md new file mode 100644 index 00000000..a5a4b6cc --- /dev/null +++ b/docs/v2/ontologies/models/ListObjectTypesV2ResponseDict.md @@ -0,0 +1,12 @@ +# ListObjectTypesV2ResponseDict + +ListObjectTypesV2Response + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[ObjectTypeV2Dict] | Yes | The list of object types in the current page. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListObjectsResponseV2.md b/docs/v2/ontologies/models/ListObjectsResponseV2.md new file mode 100644 index 00000000..78d07aa0 --- /dev/null +++ b/docs/v2/ontologies/models/ListObjectsResponseV2.md @@ -0,0 +1,13 @@ +# ListObjectsResponseV2 + +ListObjectsResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[OntologyObjectV2] | Yes | The list of objects in the current page. | +**total_count** | TotalCount | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListObjectsResponseV2Dict.md b/docs/v2/ontologies/models/ListObjectsResponseV2Dict.md new file mode 100644 index 00000000..c33fb6ba --- /dev/null +++ b/docs/v2/ontologies/models/ListObjectsResponseV2Dict.md @@ -0,0 +1,13 @@ +# ListObjectsResponseV2Dict + +ListObjectsResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[OntologyObjectV2] | Yes | The list of objects in the current page. | +**totalCount** | TotalCount | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListOutgoingLinkTypesResponseV2.md b/docs/v2/ontologies/models/ListOutgoingLinkTypesResponseV2.md new file mode 100644 index 00000000..39fdb50f --- /dev/null +++ b/docs/v2/ontologies/models/ListOutgoingLinkTypesResponseV2.md @@ -0,0 +1,12 @@ +# ListOutgoingLinkTypesResponseV2 + +ListOutgoingLinkTypesResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[LinkTypeSideV2] | Yes | The list of link type sides in the current page. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListOutgoingLinkTypesResponseV2Dict.md b/docs/v2/ontologies/models/ListOutgoingLinkTypesResponseV2Dict.md new file mode 100644 index 00000000..a40a54ba --- /dev/null +++ b/docs/v2/ontologies/models/ListOutgoingLinkTypesResponseV2Dict.md @@ -0,0 +1,12 @@ +# ListOutgoingLinkTypesResponseV2Dict + +ListOutgoingLinkTypesResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[LinkTypeSideV2Dict] | Yes | The list of link type sides in the current page. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListQueryTypesResponseV2.md b/docs/v2/ontologies/models/ListQueryTypesResponseV2.md new file mode 100644 index 00000000..375343eb --- /dev/null +++ b/docs/v2/ontologies/models/ListQueryTypesResponseV2.md @@ -0,0 +1,12 @@ +# ListQueryTypesResponseV2 + +ListQueryTypesResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**next_page_token** | Optional[PageToken] | No | | +**data** | List[QueryTypeV2] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ListQueryTypesResponseV2Dict.md b/docs/v2/ontologies/models/ListQueryTypesResponseV2Dict.md new file mode 100644 index 00000000..830ec89c --- /dev/null +++ b/docs/v2/ontologies/models/ListQueryTypesResponseV2Dict.md @@ -0,0 +1,12 @@ +# ListQueryTypesResponseV2Dict + +ListQueryTypesResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**nextPageToken** | NotRequired[PageToken] | No | | +**data** | List[QueryTypeV2Dict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LoadObjectSetResponseV2.md b/docs/v2/ontologies/models/LoadObjectSetResponseV2.md new file mode 100644 index 00000000..44bfae89 --- /dev/null +++ b/docs/v2/ontologies/models/LoadObjectSetResponseV2.md @@ -0,0 +1,13 @@ +# LoadObjectSetResponseV2 + +Represents the API response when loading an `ObjectSet`. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[OntologyObjectV2] | Yes | The list of objects in the current Page. | +**next_page_token** | Optional[PageToken] | No | | +**total_count** | TotalCount | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LoadObjectSetResponseV2Dict.md b/docs/v2/ontologies/models/LoadObjectSetResponseV2Dict.md new file mode 100644 index 00000000..66c06b19 --- /dev/null +++ b/docs/v2/ontologies/models/LoadObjectSetResponseV2Dict.md @@ -0,0 +1,13 @@ +# LoadObjectSetResponseV2Dict + +Represents the API response when loading an `ObjectSet`. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[OntologyObjectV2] | Yes | The list of objects in the current Page. | +**nextPageToken** | NotRequired[PageToken] | No | | +**totalCount** | TotalCount | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LogicRule.md b/docs/v2/ontologies/models/LogicRule.md new file mode 100644 index 00000000..0e31b10e --- /dev/null +++ b/docs/v2/ontologies/models/LogicRule.md @@ -0,0 +1,21 @@ +# LogicRule + +LogicRule + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ModifyInterfaceObjectRule | modifyInterfaceObject +ModifyObjectRule | modifyObject +DeleteObjectRule | deleteObject +CreateInterfaceObjectRule | createInterfaceObject +DeleteLinkRule | deleteLink +CreateObjectRule | createObject +CreateLinkRule | createLink + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LogicRuleDict.md b/docs/v2/ontologies/models/LogicRuleDict.md new file mode 100644 index 00000000..dcc52ea2 --- /dev/null +++ b/docs/v2/ontologies/models/LogicRuleDict.md @@ -0,0 +1,21 @@ +# LogicRuleDict + +LogicRule + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ModifyInterfaceObjectRuleDict | modifyInterfaceObject +ModifyObjectRuleDict | modifyObject +DeleteObjectRuleDict | deleteObject +CreateInterfaceObjectRuleDict | createInterfaceObject +DeleteLinkRuleDict | deleteLink +CreateObjectRuleDict | createObject +CreateLinkRuleDict | createLink + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LtQueryV2.md b/docs/v2/ontologies/models/LtQueryV2.md new file mode 100644 index 00000000..6ccdce31 --- /dev/null +++ b/docs/v2/ontologies/models/LtQueryV2.md @@ -0,0 +1,13 @@ +# LtQueryV2 + +Returns objects where the specified field is less than a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["lt"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LtQueryV2Dict.md b/docs/v2/ontologies/models/LtQueryV2Dict.md new file mode 100644 index 00000000..2cef4848 --- /dev/null +++ b/docs/v2/ontologies/models/LtQueryV2Dict.md @@ -0,0 +1,13 @@ +# LtQueryV2Dict + +Returns objects where the specified field is less than a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["lt"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LteQueryV2.md b/docs/v2/ontologies/models/LteQueryV2.md new file mode 100644 index 00000000..d73d2ac2 --- /dev/null +++ b/docs/v2/ontologies/models/LteQueryV2.md @@ -0,0 +1,13 @@ +# LteQueryV2 + +Returns objects where the specified field is less than or equal to a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["lte"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LteQueryV2Dict.md b/docs/v2/ontologies/models/LteQueryV2Dict.md new file mode 100644 index 00000000..7885729e --- /dev/null +++ b/docs/v2/ontologies/models/LteQueryV2Dict.md @@ -0,0 +1,13 @@ +# LteQueryV2Dict + +Returns objects where the specified field is less than or equal to a value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PropertyValue | Yes | | +**type** | Literal["lte"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/MaxAggregationV2Dict.md b/docs/v2/ontologies/models/MaxAggregationV2Dict.md new file mode 100644 index 00000000..b5063727 --- /dev/null +++ b/docs/v2/ontologies/models/MaxAggregationV2Dict.md @@ -0,0 +1,14 @@ +# MaxAggregationV2Dict + +Computes the maximum value for the provided field. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**name** | NotRequired[AggregationMetricName] | No | | +**direction** | NotRequired[OrderByDirection] | No | | +**type** | Literal["max"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/MinAggregationV2Dict.md b/docs/v2/ontologies/models/MinAggregationV2Dict.md new file mode 100644 index 00000000..c5485e61 --- /dev/null +++ b/docs/v2/ontologies/models/MinAggregationV2Dict.md @@ -0,0 +1,14 @@ +# MinAggregationV2Dict + +Computes the minimum value for the provided field. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**name** | NotRequired[AggregationMetricName] | No | | +**direction** | NotRequired[OrderByDirection] | No | | +**type** | Literal["min"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ModifyInterfaceObjectRule.md b/docs/v2/ontologies/models/ModifyInterfaceObjectRule.md new file mode 100644 index 00000000..0d36f471 --- /dev/null +++ b/docs/v2/ontologies/models/ModifyInterfaceObjectRule.md @@ -0,0 +1,11 @@ +# ModifyInterfaceObjectRule + +ModifyInterfaceObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["modifyInterfaceObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ModifyInterfaceObjectRuleDict.md b/docs/v2/ontologies/models/ModifyInterfaceObjectRuleDict.md new file mode 100644 index 00000000..a3d79c40 --- /dev/null +++ b/docs/v2/ontologies/models/ModifyInterfaceObjectRuleDict.md @@ -0,0 +1,11 @@ +# ModifyInterfaceObjectRuleDict + +ModifyInterfaceObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["modifyInterfaceObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ModifyObject.md b/docs/v2/ontologies/models/ModifyObject.md new file mode 100644 index 00000000..d33745b9 --- /dev/null +++ b/docs/v2/ontologies/models/ModifyObject.md @@ -0,0 +1,13 @@ +# ModifyObject + +ModifyObject + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**primary_key** | PropertyValue | Yes | | +**object_type** | ObjectTypeApiName | Yes | | +**type** | Literal["modifyObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ModifyObjectDict.md b/docs/v2/ontologies/models/ModifyObjectDict.md new file mode 100644 index 00000000..f126dbf5 --- /dev/null +++ b/docs/v2/ontologies/models/ModifyObjectDict.md @@ -0,0 +1,13 @@ +# ModifyObjectDict + +ModifyObject + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**primaryKey** | PropertyValue | Yes | | +**objectType** | ObjectTypeApiName | Yes | | +**type** | Literal["modifyObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ModifyObjectRule.md b/docs/v2/ontologies/models/ModifyObjectRule.md new file mode 100644 index 00000000..ca690877 --- /dev/null +++ b/docs/v2/ontologies/models/ModifyObjectRule.md @@ -0,0 +1,12 @@ +# ModifyObjectRule + +ModifyObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_type_api_name** | ObjectTypeApiName | Yes | | +**type** | Literal["modifyObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ModifyObjectRuleDict.md b/docs/v2/ontologies/models/ModifyObjectRuleDict.md new file mode 100644 index 00000000..21ef16ee --- /dev/null +++ b/docs/v2/ontologies/models/ModifyObjectRuleDict.md @@ -0,0 +1,12 @@ +# ModifyObjectRuleDict + +ModifyObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectTypeApiName** | ObjectTypeApiName | Yes | | +**type** | Literal["modifyObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/NotQueryV2.md b/docs/v2/ontologies/models/NotQueryV2.md new file mode 100644 index 00000000..12573d6b --- /dev/null +++ b/docs/v2/ontologies/models/NotQueryV2.md @@ -0,0 +1,12 @@ +# NotQueryV2 + +Returns objects where the query is not satisfied. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | SearchJsonQueryV2 | Yes | | +**type** | Literal["not"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/NotQueryV2Dict.md b/docs/v2/ontologies/models/NotQueryV2Dict.md new file mode 100644 index 00000000..cb3d1e7b --- /dev/null +++ b/docs/v2/ontologies/models/NotQueryV2Dict.md @@ -0,0 +1,12 @@ +# NotQueryV2Dict + +Returns objects where the query is not satisfied. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | SearchJsonQueryV2Dict | Yes | | +**type** | Literal["not"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectEdit.md b/docs/v2/ontologies/models/ObjectEdit.md new file mode 100644 index 00000000..64dd9a49 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectEdit.md @@ -0,0 +1,17 @@ +# ObjectEdit + +ObjectEdit + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ModifyObject | modifyObject +AddObject | addObject +AddLink | addLink + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectEditDict.md b/docs/v2/ontologies/models/ObjectEditDict.md new file mode 100644 index 00000000..5055e510 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectEditDict.md @@ -0,0 +1,17 @@ +# ObjectEditDict + +ObjectEdit + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ModifyObjectDict | modifyObject +AddObjectDict | addObject +AddLinkDict | addLink + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectEdits.md b/docs/v2/ontologies/models/ObjectEdits.md new file mode 100644 index 00000000..32e26ef2 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectEdits.md @@ -0,0 +1,17 @@ +# ObjectEdits + +ObjectEdits + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**edits** | List[ObjectEdit] | Yes | | +**added_object_count** | StrictInt | Yes | | +**modified_objects_count** | StrictInt | Yes | | +**deleted_objects_count** | StrictInt | Yes | | +**added_links_count** | StrictInt | Yes | | +**deleted_links_count** | StrictInt | Yes | | +**type** | Literal["edits"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectEditsDict.md b/docs/v2/ontologies/models/ObjectEditsDict.md new file mode 100644 index 00000000..d741666a --- /dev/null +++ b/docs/v2/ontologies/models/ObjectEditsDict.md @@ -0,0 +1,17 @@ +# ObjectEditsDict + +ObjectEdits + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**edits** | List[ObjectEditDict] | Yes | | +**addedObjectCount** | StrictInt | Yes | | +**modifiedObjectsCount** | StrictInt | Yes | | +**deletedObjectsCount** | StrictInt | Yes | | +**addedLinksCount** | StrictInt | Yes | | +**deletedLinksCount** | StrictInt | Yes | | +**type** | Literal["edits"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectPropertyType.md b/docs/v2/ontologies/models/ObjectPropertyType.md new file mode 100644 index 00000000..85e3d08a --- /dev/null +++ b/docs/v2/ontologies/models/ObjectPropertyType.md @@ -0,0 +1,32 @@ +# ObjectPropertyType + +A union of all the types supported by Ontology Object properties. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateType | date +StringType | string +ByteType | byte +DoubleType | double +GeoPointType | geopoint +IntegerType | integer +FloatType | float +GeoShapeType | geoshape +LongType | long +BooleanType | boolean +MarkingType | marking +AttachmentType | attachment +TimeseriesType | timeseries +OntologyObjectArrayType | array +ShortType | short +DecimalType | decimal +TimestampType | timestamp + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectPropertyTypeDict.md b/docs/v2/ontologies/models/ObjectPropertyTypeDict.md new file mode 100644 index 00000000..ef8c9c75 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectPropertyTypeDict.md @@ -0,0 +1,32 @@ +# ObjectPropertyTypeDict + +A union of all the types supported by Ontology Object properties. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateTypeDict | date +StringTypeDict | string +ByteTypeDict | byte +DoubleTypeDict | double +GeoPointTypeDict | geopoint +IntegerTypeDict | integer +FloatTypeDict | float +GeoShapeTypeDict | geoshape +LongTypeDict | long +BooleanTypeDict | boolean +MarkingTypeDict | marking +AttachmentTypeDict | attachment +TimeseriesTypeDict | timeseries +OntologyObjectArrayTypeDict | array +ShortTypeDict | short +DecimalTypeDict | decimal +TimestampTypeDict | timestamp + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectPropertyValueConstraint.md b/docs/v2/ontologies/models/ObjectPropertyValueConstraint.md new file mode 100644 index 00000000..f272270a --- /dev/null +++ b/docs/v2/ontologies/models/ObjectPropertyValueConstraint.md @@ -0,0 +1,12 @@ +# ObjectPropertyValueConstraint + +The parameter value must be a property value of an object found within an object set. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["objectPropertyValue"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectPropertyValueConstraintDict.md b/docs/v2/ontologies/models/ObjectPropertyValueConstraintDict.md new file mode 100644 index 00000000..951f1726 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectPropertyValueConstraintDict.md @@ -0,0 +1,12 @@ +# ObjectPropertyValueConstraintDict + +The parameter value must be a property value of an object found within an object set. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["objectPropertyValue"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectQueryResultConstraint.md b/docs/v2/ontologies/models/ObjectQueryResultConstraint.md new file mode 100644 index 00000000..e29b0a5e --- /dev/null +++ b/docs/v2/ontologies/models/ObjectQueryResultConstraint.md @@ -0,0 +1,12 @@ +# ObjectQueryResultConstraint + +The parameter value must be the primary key of an object found within an object set. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["objectQueryResult"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectQueryResultConstraintDict.md b/docs/v2/ontologies/models/ObjectQueryResultConstraintDict.md new file mode 100644 index 00000000..f905ff7b --- /dev/null +++ b/docs/v2/ontologies/models/ObjectQueryResultConstraintDict.md @@ -0,0 +1,12 @@ +# ObjectQueryResultConstraintDict + +The parameter value must be the primary key of an object found within an object set. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["objectQueryResult"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectRid.md b/docs/v2/ontologies/models/ObjectRid.md new file mode 100644 index 00000000..288a09b2 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectRid.md @@ -0,0 +1,12 @@ +# ObjectRid + +The unique resource identifier of an object, useful for interacting with other Foundry APIs. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSet.md b/docs/v2/ontologies/models/ObjectSet.md new file mode 100644 index 00000000..8c0d4278 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSet.md @@ -0,0 +1,22 @@ +# ObjectSet + +Represents the definition of an `ObjectSet` in the `Ontology`. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ObjectSetReferenceType | reference +ObjectSetFilterType | filter +ObjectSetSearchAroundType | searchAround +ObjectSetStaticType | static +ObjectSetIntersectionType | intersect +ObjectSetSubtractType | subtract +ObjectSetUnionType | union +ObjectSetBaseType | base + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetBaseType.md b/docs/v2/ontologies/models/ObjectSetBaseType.md new file mode 100644 index 00000000..f6e4cb59 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetBaseType.md @@ -0,0 +1,12 @@ +# ObjectSetBaseType + +ObjectSetBaseType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_type** | StrictStr | Yes | | +**type** | Literal["base"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetBaseTypeDict.md b/docs/v2/ontologies/models/ObjectSetBaseTypeDict.md new file mode 100644 index 00000000..8ba04774 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetBaseTypeDict.md @@ -0,0 +1,12 @@ +# ObjectSetBaseTypeDict + +ObjectSetBaseType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectType** | StrictStr | Yes | | +**type** | Literal["base"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetDict.md b/docs/v2/ontologies/models/ObjectSetDict.md new file mode 100644 index 00000000..e7b6b31e --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetDict.md @@ -0,0 +1,22 @@ +# ObjectSetDict + +Represents the definition of an `ObjectSet` in the `Ontology`. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ObjectSetReferenceTypeDict | reference +ObjectSetFilterTypeDict | filter +ObjectSetSearchAroundTypeDict | searchAround +ObjectSetStaticTypeDict | static +ObjectSetIntersectionTypeDict | intersect +ObjectSetSubtractTypeDict | subtract +ObjectSetUnionTypeDict | union +ObjectSetBaseTypeDict | base + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetFilterType.md b/docs/v2/ontologies/models/ObjectSetFilterType.md new file mode 100644 index 00000000..f0e022da --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetFilterType.md @@ -0,0 +1,13 @@ +# ObjectSetFilterType + +ObjectSetFilterType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_set** | ObjectSet | Yes | | +**where** | SearchJsonQueryV2 | Yes | | +**type** | Literal["filter"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetFilterTypeDict.md b/docs/v2/ontologies/models/ObjectSetFilterTypeDict.md new file mode 100644 index 00000000..869c981c --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetFilterTypeDict.md @@ -0,0 +1,13 @@ +# ObjectSetFilterTypeDict + +ObjectSetFilterType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectSet** | ObjectSetDict | Yes | | +**where** | SearchJsonQueryV2Dict | Yes | | +**type** | Literal["filter"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetIntersectionType.md b/docs/v2/ontologies/models/ObjectSetIntersectionType.md new file mode 100644 index 00000000..2c2caf09 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetIntersectionType.md @@ -0,0 +1,12 @@ +# ObjectSetIntersectionType + +ObjectSetIntersectionType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_sets** | List[ObjectSet] | Yes | | +**type** | Literal["intersect"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetIntersectionTypeDict.md b/docs/v2/ontologies/models/ObjectSetIntersectionTypeDict.md new file mode 100644 index 00000000..daf2addc --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetIntersectionTypeDict.md @@ -0,0 +1,12 @@ +# ObjectSetIntersectionTypeDict + +ObjectSetIntersectionType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectSets** | List[ObjectSetDict] | Yes | | +**type** | Literal["intersect"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetReferenceType.md b/docs/v2/ontologies/models/ObjectSetReferenceType.md new file mode 100644 index 00000000..00e0894d --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetReferenceType.md @@ -0,0 +1,12 @@ +# ObjectSetReferenceType + +ObjectSetReferenceType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**reference** | RID | Yes | | +**type** | Literal["reference"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetReferenceTypeDict.md b/docs/v2/ontologies/models/ObjectSetReferenceTypeDict.md new file mode 100644 index 00000000..0b158aaf --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetReferenceTypeDict.md @@ -0,0 +1,12 @@ +# ObjectSetReferenceTypeDict + +ObjectSetReferenceType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**reference** | RID | Yes | | +**type** | Literal["reference"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetRid.md b/docs/v2/ontologies/models/ObjectSetRid.md new file mode 100644 index 00000000..aa910c88 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetRid.md @@ -0,0 +1,11 @@ +# ObjectSetRid + +ObjectSetRid + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetSearchAroundType.md b/docs/v2/ontologies/models/ObjectSetSearchAroundType.md new file mode 100644 index 00000000..50a37503 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetSearchAroundType.md @@ -0,0 +1,13 @@ +# ObjectSetSearchAroundType + +ObjectSetSearchAroundType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_set** | ObjectSet | Yes | | +**link** | LinkTypeApiName | Yes | | +**type** | Literal["searchAround"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetSearchAroundTypeDict.md b/docs/v2/ontologies/models/ObjectSetSearchAroundTypeDict.md new file mode 100644 index 00000000..1979751d --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetSearchAroundTypeDict.md @@ -0,0 +1,13 @@ +# ObjectSetSearchAroundTypeDict + +ObjectSetSearchAroundType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectSet** | ObjectSetDict | Yes | | +**link** | LinkTypeApiName | Yes | | +**type** | Literal["searchAround"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetStaticType.md b/docs/v2/ontologies/models/ObjectSetStaticType.md new file mode 100644 index 00000000..c520f9b2 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetStaticType.md @@ -0,0 +1,12 @@ +# ObjectSetStaticType + +ObjectSetStaticType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objects** | List[ObjectRid] | Yes | | +**type** | Literal["static"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetStaticTypeDict.md b/docs/v2/ontologies/models/ObjectSetStaticTypeDict.md new file mode 100644 index 00000000..be2504f1 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetStaticTypeDict.md @@ -0,0 +1,12 @@ +# ObjectSetStaticTypeDict + +ObjectSetStaticType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objects** | List[ObjectRid] | Yes | | +**type** | Literal["static"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetSubtractType.md b/docs/v2/ontologies/models/ObjectSetSubtractType.md new file mode 100644 index 00000000..690e7ec5 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetSubtractType.md @@ -0,0 +1,12 @@ +# ObjectSetSubtractType + +ObjectSetSubtractType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_sets** | List[ObjectSet] | Yes | | +**type** | Literal["subtract"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetSubtractTypeDict.md b/docs/v2/ontologies/models/ObjectSetSubtractTypeDict.md new file mode 100644 index 00000000..c71859f0 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetSubtractTypeDict.md @@ -0,0 +1,12 @@ +# ObjectSetSubtractTypeDict + +ObjectSetSubtractType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectSets** | List[ObjectSetDict] | Yes | | +**type** | Literal["subtract"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetUnionType.md b/docs/v2/ontologies/models/ObjectSetUnionType.md new file mode 100644 index 00000000..bac2f4f7 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetUnionType.md @@ -0,0 +1,12 @@ +# ObjectSetUnionType + +ObjectSetUnionType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_sets** | List[ObjectSet] | Yes | | +**type** | Literal["union"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectSetUnionTypeDict.md b/docs/v2/ontologies/models/ObjectSetUnionTypeDict.md new file mode 100644 index 00000000..5e374eab --- /dev/null +++ b/docs/v2/ontologies/models/ObjectSetUnionTypeDict.md @@ -0,0 +1,12 @@ +# ObjectSetUnionTypeDict + +ObjectSetUnionType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectSets** | List[ObjectSetDict] | Yes | | +**type** | Literal["union"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectTypeApiName.md b/docs/v2/ontologies/models/ObjectTypeApiName.md new file mode 100644 index 00000000..459dcf77 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectTypeApiName.md @@ -0,0 +1,13 @@ +# ObjectTypeApiName + +The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the +`List object types` endpoint or check the **Ontology Manager**. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectTypeEdits.md b/docs/v2/ontologies/models/ObjectTypeEdits.md new file mode 100644 index 00000000..5ea25c99 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectTypeEdits.md @@ -0,0 +1,12 @@ +# ObjectTypeEdits + +ObjectTypeEdits + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**edited_object_types** | List[ObjectTypeApiName] | Yes | | +**type** | Literal["largeScaleEdits"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectTypeEditsDict.md b/docs/v2/ontologies/models/ObjectTypeEditsDict.md new file mode 100644 index 00000000..b61ab57a --- /dev/null +++ b/docs/v2/ontologies/models/ObjectTypeEditsDict.md @@ -0,0 +1,12 @@ +# ObjectTypeEditsDict + +ObjectTypeEdits + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**editedObjectTypes** | List[ObjectTypeApiName] | Yes | | +**type** | Literal["largeScaleEdits"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectTypeFullMetadata.md b/docs/v2/ontologies/models/ObjectTypeFullMetadata.md new file mode 100644 index 00000000..f59dd987 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectTypeFullMetadata.md @@ -0,0 +1,15 @@ +# ObjectTypeFullMetadata + +ObjectTypeFullMetadata + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_type** | ObjectTypeV2 | Yes | | +**link_types** | List[LinkTypeSideV2] | Yes | | +**implements_interfaces** | List[InterfaceTypeApiName] | Yes | A list of interfaces that this object type implements. | +**implements_interfaces2** | Dict[InterfaceTypeApiName, ObjectTypeInterfaceImplementation] | Yes | A list of interfaces that this object type implements and how it implements them. | +**shared_property_type_mapping** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | A map from shared property type API name to backing local property API name for the shared property types present on this object type. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectTypeFullMetadataDict.md b/docs/v2/ontologies/models/ObjectTypeFullMetadataDict.md new file mode 100644 index 00000000..a6f49380 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectTypeFullMetadataDict.md @@ -0,0 +1,15 @@ +# ObjectTypeFullMetadataDict + +ObjectTypeFullMetadata + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectType** | ObjectTypeV2Dict | Yes | | +**linkTypes** | List[LinkTypeSideV2Dict] | Yes | | +**implementsInterfaces** | List[InterfaceTypeApiName] | Yes | A list of interfaces that this object type implements. | +**implementsInterfaces2** | Dict[InterfaceTypeApiName, ObjectTypeInterfaceImplementationDict] | Yes | A list of interfaces that this object type implements and how it implements them. | +**sharedPropertyTypeMapping** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | A map from shared property type API name to backing local property API name for the shared property types present on this object type. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectTypeInterfaceImplementation.md b/docs/v2/ontologies/models/ObjectTypeInterfaceImplementation.md new file mode 100644 index 00000000..3aabc417 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectTypeInterfaceImplementation.md @@ -0,0 +1,11 @@ +# ObjectTypeInterfaceImplementation + +ObjectTypeInterfaceImplementation + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**properties** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectTypeInterfaceImplementationDict.md b/docs/v2/ontologies/models/ObjectTypeInterfaceImplementationDict.md new file mode 100644 index 00000000..f9752ca6 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectTypeInterfaceImplementationDict.md @@ -0,0 +1,11 @@ +# ObjectTypeInterfaceImplementationDict + +ObjectTypeInterfaceImplementation + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**properties** | Dict[SharedPropertyTypeApiName, PropertyApiName] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectTypeRid.md b/docs/v2/ontologies/models/ObjectTypeRid.md new file mode 100644 index 00000000..c4904e5f --- /dev/null +++ b/docs/v2/ontologies/models/ObjectTypeRid.md @@ -0,0 +1,11 @@ +# ObjectTypeRid + +The unique resource identifier of an object type, useful for interacting with other Foundry APIs. + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectTypeV2.md b/docs/v2/ontologies/models/ObjectTypeV2.md new file mode 100644 index 00000000..a3ad3e29 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectTypeV2.md @@ -0,0 +1,21 @@ +# ObjectTypeV2 + +Represents an object type in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**api_name** | ObjectTypeApiName | Yes | | +**display_name** | DisplayName | Yes | | +**status** | ReleaseStatus | Yes | | +**description** | Optional[StrictStr] | No | The description of the object type. | +**plural_display_name** | StrictStr | Yes | The plural display name of the object type. | +**icon** | Icon | Yes | | +**primary_key** | PropertyApiName | Yes | | +**properties** | Dict[PropertyApiName, PropertyV2] | Yes | A map of the properties of the object type. | +**rid** | ObjectTypeRid | Yes | | +**title_property** | PropertyApiName | Yes | | +**visibility** | Optional[ObjectTypeVisibility] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectTypeV2Dict.md b/docs/v2/ontologies/models/ObjectTypeV2Dict.md new file mode 100644 index 00000000..618e830a --- /dev/null +++ b/docs/v2/ontologies/models/ObjectTypeV2Dict.md @@ -0,0 +1,21 @@ +# ObjectTypeV2Dict + +Represents an object type in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**apiName** | ObjectTypeApiName | Yes | | +**displayName** | DisplayName | Yes | | +**status** | ReleaseStatus | Yes | | +**description** | NotRequired[StrictStr] | No | The description of the object type. | +**pluralDisplayName** | StrictStr | Yes | The plural display name of the object type. | +**icon** | IconDict | Yes | | +**primaryKey** | PropertyApiName | Yes | | +**properties** | Dict[PropertyApiName, PropertyV2Dict] | Yes | A map of the properties of the object type. | +**rid** | ObjectTypeRid | Yes | | +**titleProperty** | PropertyApiName | Yes | | +**visibility** | NotRequired[ObjectTypeVisibility] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ObjectTypeVisibility.md b/docs/v2/ontologies/models/ObjectTypeVisibility.md new file mode 100644 index 00000000..88392666 --- /dev/null +++ b/docs/v2/ontologies/models/ObjectTypeVisibility.md @@ -0,0 +1,12 @@ +# ObjectTypeVisibility + +The suggested visibility of the object type. + +| **Value** | +| --------- | +| `"NORMAL"` | +| `"PROMINENT"` | +| `"HIDDEN"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OneOfConstraint.md b/docs/v2/ontologies/models/OneOfConstraint.md new file mode 100644 index 00000000..4e42a276 --- /dev/null +++ b/docs/v2/ontologies/models/OneOfConstraint.md @@ -0,0 +1,14 @@ +# OneOfConstraint + +The parameter has a manually predefined set of options. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**options** | List[ParameterOption] | Yes | | +**other_values_allowed** | StrictBool | Yes | A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**. | +**type** | Literal["oneOf"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OneOfConstraintDict.md b/docs/v2/ontologies/models/OneOfConstraintDict.md new file mode 100644 index 00000000..952731a3 --- /dev/null +++ b/docs/v2/ontologies/models/OneOfConstraintDict.md @@ -0,0 +1,14 @@ +# OneOfConstraintDict + +The parameter has a manually predefined set of options. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**options** | List[ParameterOptionDict] | Yes | | +**otherValuesAllowed** | StrictBool | Yes | A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**. | +**type** | Literal["oneOf"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyApiName.md b/docs/v2/ontologies/models/OntologyApiName.md new file mode 100644 index 00000000..2df42d92 --- /dev/null +++ b/docs/v2/ontologies/models/OntologyApiName.md @@ -0,0 +1,11 @@ +# OntologyApiName + +OntologyApiName + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyFullMetadata.md b/docs/v2/ontologies/models/OntologyFullMetadata.md new file mode 100644 index 00000000..aebf2ecd --- /dev/null +++ b/docs/v2/ontologies/models/OntologyFullMetadata.md @@ -0,0 +1,16 @@ +# OntologyFullMetadata + +OntologyFullMetadata + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**ontology** | OntologyV2 | Yes | | +**object_types** | Dict[ObjectTypeApiName, ObjectTypeFullMetadata] | Yes | | +**action_types** | Dict[ActionTypeApiName, ActionTypeV2] | Yes | | +**query_types** | Dict[QueryApiName, QueryTypeV2] | Yes | | +**interface_types** | Dict[InterfaceTypeApiName, InterfaceType] | Yes | | +**shared_property_types** | Dict[SharedPropertyTypeApiName, SharedPropertyType] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyFullMetadataDict.md b/docs/v2/ontologies/models/OntologyFullMetadataDict.md new file mode 100644 index 00000000..9fdc9059 --- /dev/null +++ b/docs/v2/ontologies/models/OntologyFullMetadataDict.md @@ -0,0 +1,16 @@ +# OntologyFullMetadataDict + +OntologyFullMetadata + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**ontology** | OntologyV2Dict | Yes | | +**objectTypes** | Dict[ObjectTypeApiName, ObjectTypeFullMetadataDict] | Yes | | +**actionTypes** | Dict[ActionTypeApiName, ActionTypeV2Dict] | Yes | | +**queryTypes** | Dict[QueryApiName, QueryTypeV2Dict] | Yes | | +**interfaceTypes** | Dict[InterfaceTypeApiName, InterfaceTypeDict] | Yes | | +**sharedPropertyTypes** | Dict[SharedPropertyTypeApiName, SharedPropertyTypeDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyIdentifier.md b/docs/v2/ontologies/models/OntologyIdentifier.md new file mode 100644 index 00000000..6f86e870 --- /dev/null +++ b/docs/v2/ontologies/models/OntologyIdentifier.md @@ -0,0 +1,11 @@ +# OntologyIdentifier + +Either an ontology rid or an ontology api name. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyObjectArrayType.md b/docs/v2/ontologies/models/OntologyObjectArrayType.md new file mode 100644 index 00000000..4d5e63ab --- /dev/null +++ b/docs/v2/ontologies/models/OntologyObjectArrayType.md @@ -0,0 +1,12 @@ +# OntologyObjectArrayType + +OntologyObjectArrayType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**sub_type** | ObjectPropertyType | Yes | | +**type** | Literal["array"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyObjectArrayTypeDict.md b/docs/v2/ontologies/models/OntologyObjectArrayTypeDict.md new file mode 100644 index 00000000..40bed37b --- /dev/null +++ b/docs/v2/ontologies/models/OntologyObjectArrayTypeDict.md @@ -0,0 +1,12 @@ +# OntologyObjectArrayTypeDict + +OntologyObjectArrayType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**subType** | ObjectPropertyTypeDict | Yes | | +**type** | Literal["array"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyObjectSetType.md b/docs/v2/ontologies/models/OntologyObjectSetType.md new file mode 100644 index 00000000..080f1a5b --- /dev/null +++ b/docs/v2/ontologies/models/OntologyObjectSetType.md @@ -0,0 +1,13 @@ +# OntologyObjectSetType + +OntologyObjectSetType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_api_name** | Optional[ObjectTypeApiName] | No | | +**object_type_api_name** | Optional[ObjectTypeApiName] | No | | +**type** | Literal["objectSet"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyObjectSetTypeDict.md b/docs/v2/ontologies/models/OntologyObjectSetTypeDict.md new file mode 100644 index 00000000..993c941a --- /dev/null +++ b/docs/v2/ontologies/models/OntologyObjectSetTypeDict.md @@ -0,0 +1,13 @@ +# OntologyObjectSetTypeDict + +OntologyObjectSetType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectApiName** | NotRequired[ObjectTypeApiName] | No | | +**objectTypeApiName** | NotRequired[ObjectTypeApiName] | No | | +**type** | Literal["objectSet"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyObjectType.md b/docs/v2/ontologies/models/OntologyObjectType.md new file mode 100644 index 00000000..bf276e6f --- /dev/null +++ b/docs/v2/ontologies/models/OntologyObjectType.md @@ -0,0 +1,13 @@ +# OntologyObjectType + +OntologyObjectType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**object_api_name** | ObjectTypeApiName | Yes | | +**object_type_api_name** | ObjectTypeApiName | Yes | | +**type** | Literal["object"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyObjectTypeDict.md b/docs/v2/ontologies/models/OntologyObjectTypeDict.md new file mode 100644 index 00000000..c07be8c4 --- /dev/null +++ b/docs/v2/ontologies/models/OntologyObjectTypeDict.md @@ -0,0 +1,13 @@ +# OntologyObjectTypeDict + +OntologyObjectType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**objectApiName** | ObjectTypeApiName | Yes | | +**objectTypeApiName** | ObjectTypeApiName | Yes | | +**type** | Literal["object"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyObjectV2.md b/docs/v2/ontologies/models/OntologyObjectV2.md new file mode 100644 index 00000000..faa66a96 --- /dev/null +++ b/docs/v2/ontologies/models/OntologyObjectV2.md @@ -0,0 +1,11 @@ +# OntologyObjectV2 + +Represents an object in the Ontology. + +## Type +```python +Dict[PropertyApiName, PropertyValue] +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyRid.md b/docs/v2/ontologies/models/OntologyRid.md new file mode 100644 index 00000000..c38f5a6c --- /dev/null +++ b/docs/v2/ontologies/models/OntologyRid.md @@ -0,0 +1,13 @@ +# OntologyRid + +The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the +`List ontologies` endpoint or check the **Ontology Manager**. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyV2.md b/docs/v2/ontologies/models/OntologyV2.md new file mode 100644 index 00000000..3bfab34c --- /dev/null +++ b/docs/v2/ontologies/models/OntologyV2.md @@ -0,0 +1,14 @@ +# OntologyV2 + +Metadata about an Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**api_name** | OntologyApiName | Yes | | +**display_name** | DisplayName | Yes | | +**description** | StrictStr | Yes | | +**rid** | OntologyRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyV2Dict.md b/docs/v2/ontologies/models/OntologyV2Dict.md new file mode 100644 index 00000000..37000cb6 --- /dev/null +++ b/docs/v2/ontologies/models/OntologyV2Dict.md @@ -0,0 +1,14 @@ +# OntologyV2Dict + +Metadata about an Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**apiName** | OntologyApiName | Yes | | +**displayName** | DisplayName | Yes | | +**description** | StrictStr | Yes | | +**rid** | OntologyRid | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OrQueryV2.md b/docs/v2/ontologies/models/OrQueryV2.md new file mode 100644 index 00000000..86536bb3 --- /dev/null +++ b/docs/v2/ontologies/models/OrQueryV2.md @@ -0,0 +1,12 @@ +# OrQueryV2 + +Returns objects where at least 1 query is satisfied. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | List[SearchJsonQueryV2] | Yes | | +**type** | Literal["or"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OrQueryV2Dict.md b/docs/v2/ontologies/models/OrQueryV2Dict.md new file mode 100644 index 00000000..0fdaa13d --- /dev/null +++ b/docs/v2/ontologies/models/OrQueryV2Dict.md @@ -0,0 +1,12 @@ +# OrQueryV2Dict + +Returns objects where at least 1 query is satisfied. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**value** | List[SearchJsonQueryV2Dict] | Yes | | +**type** | Literal["or"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OrderBy.md b/docs/v2/ontologies/models/OrderBy.md new file mode 100644 index 00000000..2912e655 --- /dev/null +++ b/docs/v2/ontologies/models/OrderBy.md @@ -0,0 +1,21 @@ +# OrderBy + +A command representing the list of properties to order by. Properties should be delimited by commas and +prefixed by `p` or `properties`. The format expected format is +`orderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...` + +By default, the ordering for a property is ascending, and this can be explicitly specified by appending +`:asc` (for ascending) or `:desc` (for descending). + +Example: use `orderBy=properties.lastName:asc` to order by a single property, +`orderBy=properties.lastName,properties.firstName,properties.age:desc` to order by multiple properties. +You may also use the shorthand `p` instead of `properties` such as `orderBy=p.lastName:asc`. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OrderByDirection.md b/docs/v2/ontologies/models/OrderByDirection.md new file mode 100644 index 00000000..f7f92da9 --- /dev/null +++ b/docs/v2/ontologies/models/OrderByDirection.md @@ -0,0 +1,11 @@ +# OrderByDirection + +OrderByDirection + +| **Value** | +| --------- | +| `"ASC"` | +| `"DESC"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ParameterEvaluatedConstraint.md b/docs/v2/ontologies/models/ParameterEvaluatedConstraint.md new file mode 100644 index 00000000..1bc82b0a --- /dev/null +++ b/docs/v2/ontologies/models/ParameterEvaluatedConstraint.md @@ -0,0 +1,40 @@ +# ParameterEvaluatedConstraint + +A constraint that an action parameter value must satisfy in order to be considered valid. +Constraints can be configured on action parameters in the **Ontology Manager**. +Applicable constraints are determined dynamically based on parameter inputs. +Parameter values are evaluated against the final set of constraints. + +The type of the constraint. +| Type | Description | +|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | +| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | +| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | +| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | +| `oneOf` | The parameter has a manually predefined set of options. | +| `range` | The parameter value must be within the defined range. | +| `stringLength` | The parameter value must have a length within the defined range. | +| `stringRegexMatch` | The parameter value must match a predefined regular expression. | +| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +OneOfConstraint | oneOf +GroupMemberConstraint | groupMember +ObjectPropertyValueConstraint | objectPropertyValue +RangeConstraint | range +ArraySizeConstraint | arraySize +ObjectQueryResultConstraint | objectQueryResult +StringLengthConstraint | stringLength +StringRegexMatchConstraint | stringRegexMatch +UnevaluableConstraint | unevaluable + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ParameterEvaluatedConstraintDict.md b/docs/v2/ontologies/models/ParameterEvaluatedConstraintDict.md new file mode 100644 index 00000000..d86a98e0 --- /dev/null +++ b/docs/v2/ontologies/models/ParameterEvaluatedConstraintDict.md @@ -0,0 +1,40 @@ +# ParameterEvaluatedConstraintDict + +A constraint that an action parameter value must satisfy in order to be considered valid. +Constraints can be configured on action parameters in the **Ontology Manager**. +Applicable constraints are determined dynamically based on parameter inputs. +Parameter values are evaluated against the final set of constraints. + +The type of the constraint. +| Type | Description | +|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | +| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | +| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | +| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | +| `oneOf` | The parameter has a manually predefined set of options. | +| `range` | The parameter value must be within the defined range. | +| `stringLength` | The parameter value must have a length within the defined range. | +| `stringRegexMatch` | The parameter value must match a predefined regular expression. | +| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +OneOfConstraintDict | oneOf +GroupMemberConstraintDict | groupMember +ObjectPropertyValueConstraintDict | objectPropertyValue +RangeConstraintDict | range +ArraySizeConstraintDict | arraySize +ObjectQueryResultConstraintDict | objectQueryResult +StringLengthConstraintDict | stringLength +StringRegexMatchConstraintDict | stringRegexMatch +UnevaluableConstraintDict | unevaluable + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ParameterEvaluationResult.md b/docs/v2/ontologies/models/ParameterEvaluationResult.md new file mode 100644 index 00000000..0c343104 --- /dev/null +++ b/docs/v2/ontologies/models/ParameterEvaluationResult.md @@ -0,0 +1,13 @@ +# ParameterEvaluationResult + +Represents the validity of a parameter against the configured constraints. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**result** | ValidationResult | Yes | | +**evaluated_constraints** | List[ParameterEvaluatedConstraint] | Yes | | +**required** | StrictBool | Yes | Represents whether the parameter is a required input to the action. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ParameterEvaluationResultDict.md b/docs/v2/ontologies/models/ParameterEvaluationResultDict.md new file mode 100644 index 00000000..9cce4f1d --- /dev/null +++ b/docs/v2/ontologies/models/ParameterEvaluationResultDict.md @@ -0,0 +1,13 @@ +# ParameterEvaluationResultDict + +Represents the validity of a parameter against the configured constraints. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**result** | ValidationResult | Yes | | +**evaluatedConstraints** | List[ParameterEvaluatedConstraintDict] | Yes | | +**required** | StrictBool | Yes | Represents whether the parameter is a required input to the action. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ParameterId.md b/docs/v2/ontologies/models/ParameterId.md new file mode 100644 index 00000000..c6446719 --- /dev/null +++ b/docs/v2/ontologies/models/ParameterId.md @@ -0,0 +1,13 @@ +# ParameterId + +The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied. +Parameters can be viewed and managed in the **Ontology Manager**. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ParameterOption.md b/docs/v2/ontologies/models/ParameterOption.md new file mode 100644 index 00000000..f81f9cdb --- /dev/null +++ b/docs/v2/ontologies/models/ParameterOption.md @@ -0,0 +1,13 @@ +# ParameterOption + +A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**display_name** | Optional[DisplayName] | No | | +**value** | Optional[Any] | No | An allowed configured value for a parameter within an action. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ParameterOptionDict.md b/docs/v2/ontologies/models/ParameterOptionDict.md new file mode 100644 index 00000000..360a0d06 --- /dev/null +++ b/docs/v2/ontologies/models/ParameterOptionDict.md @@ -0,0 +1,13 @@ +# ParameterOptionDict + +A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**displayName** | NotRequired[DisplayName] | No | | +**value** | NotRequired[Any] | No | An allowed configured value for a parameter within an action. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/PolygonValue.md b/docs/v2/ontologies/models/PolygonValue.md new file mode 100644 index 00000000..b61e30b9 --- /dev/null +++ b/docs/v2/ontologies/models/PolygonValue.md @@ -0,0 +1,11 @@ +# PolygonValue + +PolygonValue + +## Type +```python +Polygon +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/PolygonValueDict.md b/docs/v2/ontologies/models/PolygonValueDict.md new file mode 100644 index 00000000..1bf71417 --- /dev/null +++ b/docs/v2/ontologies/models/PolygonValueDict.md @@ -0,0 +1,11 @@ +# PolygonValueDict + +PolygonValue + +## Type +```python +PolygonDict +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/PropertyApiName.md b/docs/v2/ontologies/models/PropertyApiName.md new file mode 100644 index 00000000..ec687c82 --- /dev/null +++ b/docs/v2/ontologies/models/PropertyApiName.md @@ -0,0 +1,13 @@ +# PropertyApiName + +The name of the property in the API. To find the API name for your property, use the `Get object type` +endpoint or check the **Ontology Manager**. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/PropertyV2.md b/docs/v2/ontologies/models/PropertyV2.md new file mode 100644 index 00000000..87b31bc9 --- /dev/null +++ b/docs/v2/ontologies/models/PropertyV2.md @@ -0,0 +1,13 @@ +# PropertyV2 + +Details about some property of an object. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**description** | Optional[StrictStr] | No | | +**display_name** | Optional[DisplayName] | No | | +**data_type** | ObjectPropertyType | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/PropertyV2Dict.md b/docs/v2/ontologies/models/PropertyV2Dict.md new file mode 100644 index 00000000..3c7b3d7a --- /dev/null +++ b/docs/v2/ontologies/models/PropertyV2Dict.md @@ -0,0 +1,13 @@ +# PropertyV2Dict + +Details about some property of an object. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**description** | NotRequired[StrictStr] | No | | +**displayName** | NotRequired[DisplayName] | No | | +**dataType** | ObjectPropertyTypeDict | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/PropertyValue.md b/docs/v2/ontologies/models/PropertyValue.md new file mode 100644 index 00000000..de077fc8 --- /dev/null +++ b/docs/v2/ontologies/models/PropertyValue.md @@ -0,0 +1,32 @@ +# PropertyValue + +Represents the value of a property in the following format. + +| Type | JSON encoding | Example | +|----------- |-------------------------------------------------------|----------------------------------------------------------------------------------------------------| +| Array | array | `["alpha", "bravo", "charlie"]` | +| Attachment | JSON encoded `AttachmentProperty` object | `{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}` | +| Boolean | boolean | `true` | +| Byte | number | `31` | +| Date | ISO 8601 extended local date string | `"2021-05-01"` | +| Decimal | string | `"2.718281828"` | +| Double | number | `3.14159265` | +| Float | number | `3.14159265` | +| GeoPoint | geojson | `{"type":"Point","coordinates":[102.0,0.5]}` | +| GeoShape | geojson | `{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` | +| Integer | number | `238940` | +| Long | string | `"58319870951433"` | +| Short | number | `8739` | +| String | string | `"Call me Ishmael"` | +| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | + +Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings. + + +## Type +```python +Any +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/PropertyValueEscapedString.md b/docs/v2/ontologies/models/PropertyValueEscapedString.md new file mode 100644 index 00000000..24e6ef24 --- /dev/null +++ b/docs/v2/ontologies/models/PropertyValueEscapedString.md @@ -0,0 +1,11 @@ +# PropertyValueEscapedString + +Represents the value of a property in string format. This is used in URL parameters. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryAggregationKeyType.md b/docs/v2/ontologies/models/QueryAggregationKeyType.md new file mode 100644 index 00000000..af8af64a --- /dev/null +++ b/docs/v2/ontologies/models/QueryAggregationKeyType.md @@ -0,0 +1,22 @@ +# QueryAggregationKeyType + +A union of all the types supported by query aggregation keys. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateType | date +BooleanType | boolean +StringType | string +DoubleType | double +QueryAggregationRangeType | range +IntegerType | integer +TimestampType | timestamp + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryAggregationKeyTypeDict.md b/docs/v2/ontologies/models/QueryAggregationKeyTypeDict.md new file mode 100644 index 00000000..c8def0b1 --- /dev/null +++ b/docs/v2/ontologies/models/QueryAggregationKeyTypeDict.md @@ -0,0 +1,22 @@ +# QueryAggregationKeyTypeDict + +A union of all the types supported by query aggregation keys. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateTypeDict | date +BooleanTypeDict | boolean +StringTypeDict | string +DoubleTypeDict | double +QueryAggregationRangeTypeDict | range +IntegerTypeDict | integer +TimestampTypeDict | timestamp + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryAggregationRangeSubType.md b/docs/v2/ontologies/models/QueryAggregationRangeSubType.md new file mode 100644 index 00000000..b2b00734 --- /dev/null +++ b/docs/v2/ontologies/models/QueryAggregationRangeSubType.md @@ -0,0 +1,19 @@ +# QueryAggregationRangeSubType + +A union of all the types supported by query aggregation ranges. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateType | date +DoubleType | double +IntegerType | integer +TimestampType | timestamp + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryAggregationRangeSubTypeDict.md b/docs/v2/ontologies/models/QueryAggregationRangeSubTypeDict.md new file mode 100644 index 00000000..6ccfc055 --- /dev/null +++ b/docs/v2/ontologies/models/QueryAggregationRangeSubTypeDict.md @@ -0,0 +1,19 @@ +# QueryAggregationRangeSubTypeDict + +A union of all the types supported by query aggregation ranges. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateTypeDict | date +DoubleTypeDict | double +IntegerTypeDict | integer +TimestampTypeDict | timestamp + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryAggregationRangeType.md b/docs/v2/ontologies/models/QueryAggregationRangeType.md new file mode 100644 index 00000000..8f7de155 --- /dev/null +++ b/docs/v2/ontologies/models/QueryAggregationRangeType.md @@ -0,0 +1,12 @@ +# QueryAggregationRangeType + +QueryAggregationRangeType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**sub_type** | QueryAggregationRangeSubType | Yes | | +**type** | Literal["range"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryAggregationRangeTypeDict.md b/docs/v2/ontologies/models/QueryAggregationRangeTypeDict.md new file mode 100644 index 00000000..3d15c61b --- /dev/null +++ b/docs/v2/ontologies/models/QueryAggregationRangeTypeDict.md @@ -0,0 +1,12 @@ +# QueryAggregationRangeTypeDict + +QueryAggregationRangeType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**subType** | QueryAggregationRangeSubTypeDict | Yes | | +**type** | Literal["range"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryAggregationValueType.md b/docs/v2/ontologies/models/QueryAggregationValueType.md new file mode 100644 index 00000000..7802d4da --- /dev/null +++ b/docs/v2/ontologies/models/QueryAggregationValueType.md @@ -0,0 +1,18 @@ +# QueryAggregationValueType + +A union of all the types supported by query aggregation keys. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateType | date +DoubleType | double +TimestampType | timestamp + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryAggregationValueTypeDict.md b/docs/v2/ontologies/models/QueryAggregationValueTypeDict.md new file mode 100644 index 00000000..bbd2be4b --- /dev/null +++ b/docs/v2/ontologies/models/QueryAggregationValueTypeDict.md @@ -0,0 +1,18 @@ +# QueryAggregationValueTypeDict + +A union of all the types supported by query aggregation keys. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateTypeDict | date +DoubleTypeDict | double +TimestampTypeDict | timestamp + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryApiName.md b/docs/v2/ontologies/models/QueryApiName.md new file mode 100644 index 00000000..8c2a6837 --- /dev/null +++ b/docs/v2/ontologies/models/QueryApiName.md @@ -0,0 +1,12 @@ +# QueryApiName + +The name of the Query in the API. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryArrayType.md b/docs/v2/ontologies/models/QueryArrayType.md new file mode 100644 index 00000000..ef02cc33 --- /dev/null +++ b/docs/v2/ontologies/models/QueryArrayType.md @@ -0,0 +1,12 @@ +# QueryArrayType + +QueryArrayType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**sub_type** | QueryDataType | Yes | | +**type** | Literal["array"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryArrayTypeDict.md b/docs/v2/ontologies/models/QueryArrayTypeDict.md new file mode 100644 index 00000000..d1b016f8 --- /dev/null +++ b/docs/v2/ontologies/models/QueryArrayTypeDict.md @@ -0,0 +1,12 @@ +# QueryArrayTypeDict + +QueryArrayType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**subType** | QueryDataTypeDict | Yes | | +**type** | Literal["array"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryDataType.md b/docs/v2/ontologies/models/QueryDataType.md new file mode 100644 index 00000000..05db3b88 --- /dev/null +++ b/docs/v2/ontologies/models/QueryDataType.md @@ -0,0 +1,34 @@ +# QueryDataType + +A union of all the types supported by Ontology Query parameters or outputs. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateType | date +QueryStructType | struct +QuerySetType | set +StringType | string +DoubleType | double +IntegerType | integer +ThreeDimensionalAggregation | threeDimensionalAggregation +QueryUnionType | union +FloatType | float +LongType | long +BooleanType | boolean +UnsupportedType | unsupported +AttachmentType | attachment +NullType | null +QueryArrayType | array +OntologyObjectSetType | objectSet +TwoDimensionalAggregation | twoDimensionalAggregation +OntologyObjectType | object +TimestampType | timestamp + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryDataTypeDict.md b/docs/v2/ontologies/models/QueryDataTypeDict.md new file mode 100644 index 00000000..2df48191 --- /dev/null +++ b/docs/v2/ontologies/models/QueryDataTypeDict.md @@ -0,0 +1,34 @@ +# QueryDataTypeDict + +A union of all the types supported by Ontology Query parameters or outputs. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DateTypeDict | date +QueryStructTypeDict | struct +QuerySetTypeDict | set +StringTypeDict | string +DoubleTypeDict | double +IntegerTypeDict | integer +ThreeDimensionalAggregationDict | threeDimensionalAggregation +QueryUnionTypeDict | union +FloatTypeDict | float +LongTypeDict | long +BooleanTypeDict | boolean +UnsupportedTypeDict | unsupported +AttachmentTypeDict | attachment +NullTypeDict | null +QueryArrayTypeDict | array +OntologyObjectSetTypeDict | objectSet +TwoDimensionalAggregationDict | twoDimensionalAggregation +OntologyObjectTypeDict | object +TimestampTypeDict | timestamp + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryParameterV2.md b/docs/v2/ontologies/models/QueryParameterV2.md new file mode 100644 index 00000000..226f7e5d --- /dev/null +++ b/docs/v2/ontologies/models/QueryParameterV2.md @@ -0,0 +1,12 @@ +# QueryParameterV2 + +Details about a parameter of a query. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**description** | Optional[StrictStr] | No | | +**data_type** | QueryDataType | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryParameterV2Dict.md b/docs/v2/ontologies/models/QueryParameterV2Dict.md new file mode 100644 index 00000000..1b84d59e --- /dev/null +++ b/docs/v2/ontologies/models/QueryParameterV2Dict.md @@ -0,0 +1,12 @@ +# QueryParameterV2Dict + +Details about a parameter of a query. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**description** | NotRequired[StrictStr] | No | | +**dataType** | QueryDataTypeDict | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QuerySetType.md b/docs/v2/ontologies/models/QuerySetType.md new file mode 100644 index 00000000..786ad834 --- /dev/null +++ b/docs/v2/ontologies/models/QuerySetType.md @@ -0,0 +1,12 @@ +# QuerySetType + +QuerySetType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**sub_type** | QueryDataType | Yes | | +**type** | Literal["set"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QuerySetTypeDict.md b/docs/v2/ontologies/models/QuerySetTypeDict.md new file mode 100644 index 00000000..7ee4cc50 --- /dev/null +++ b/docs/v2/ontologies/models/QuerySetTypeDict.md @@ -0,0 +1,12 @@ +# QuerySetTypeDict + +QuerySetType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**subType** | QueryDataTypeDict | Yes | | +**type** | Literal["set"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryStructField.md b/docs/v2/ontologies/models/QueryStructField.md new file mode 100644 index 00000000..0e7bc858 --- /dev/null +++ b/docs/v2/ontologies/models/QueryStructField.md @@ -0,0 +1,12 @@ +# QueryStructField + +QueryStructField + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**name** | StructFieldName | Yes | | +**field_type** | QueryDataType | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryStructFieldDict.md b/docs/v2/ontologies/models/QueryStructFieldDict.md new file mode 100644 index 00000000..fa34f068 --- /dev/null +++ b/docs/v2/ontologies/models/QueryStructFieldDict.md @@ -0,0 +1,12 @@ +# QueryStructFieldDict + +QueryStructField + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**name** | StructFieldName | Yes | | +**fieldType** | QueryDataTypeDict | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryStructType.md b/docs/v2/ontologies/models/QueryStructType.md new file mode 100644 index 00000000..9ccbb086 --- /dev/null +++ b/docs/v2/ontologies/models/QueryStructType.md @@ -0,0 +1,12 @@ +# QueryStructType + +QueryStructType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**fields** | List[QueryStructField] | Yes | | +**type** | Literal["struct"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryStructTypeDict.md b/docs/v2/ontologies/models/QueryStructTypeDict.md new file mode 100644 index 00000000..eadd8ce1 --- /dev/null +++ b/docs/v2/ontologies/models/QueryStructTypeDict.md @@ -0,0 +1,12 @@ +# QueryStructTypeDict + +QueryStructType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**fields** | List[QueryStructFieldDict] | Yes | | +**type** | Literal["struct"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryTypeV2.md b/docs/v2/ontologies/models/QueryTypeV2.md new file mode 100644 index 00000000..52615f1c --- /dev/null +++ b/docs/v2/ontologies/models/QueryTypeV2.md @@ -0,0 +1,17 @@ +# QueryTypeV2 + +Represents a query type in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**api_name** | QueryApiName | Yes | | +**description** | Optional[StrictStr] | No | | +**display_name** | Optional[DisplayName] | No | | +**parameters** | Dict[ParameterId, QueryParameterV2] | Yes | | +**output** | QueryDataType | Yes | | +**rid** | FunctionRid | Yes | | +**version** | FunctionVersion | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryTypeV2Dict.md b/docs/v2/ontologies/models/QueryTypeV2Dict.md new file mode 100644 index 00000000..6b50cb15 --- /dev/null +++ b/docs/v2/ontologies/models/QueryTypeV2Dict.md @@ -0,0 +1,17 @@ +# QueryTypeV2Dict + +Represents a query type in the Ontology. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**apiName** | QueryApiName | Yes | | +**description** | NotRequired[StrictStr] | No | | +**displayName** | NotRequired[DisplayName] | No | | +**parameters** | Dict[ParameterId, QueryParameterV2Dict] | Yes | | +**output** | QueryDataTypeDict | Yes | | +**rid** | FunctionRid | Yes | | +**version** | FunctionVersion | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryUnionType.md b/docs/v2/ontologies/models/QueryUnionType.md new file mode 100644 index 00000000..a1b15ebb --- /dev/null +++ b/docs/v2/ontologies/models/QueryUnionType.md @@ -0,0 +1,12 @@ +# QueryUnionType + +QueryUnionType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**union_types** | List[QueryDataType] | Yes | | +**type** | Literal["union"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/QueryUnionTypeDict.md b/docs/v2/ontologies/models/QueryUnionTypeDict.md new file mode 100644 index 00000000..200ebb65 --- /dev/null +++ b/docs/v2/ontologies/models/QueryUnionTypeDict.md @@ -0,0 +1,12 @@ +# QueryUnionTypeDict + +QueryUnionType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**unionTypes** | List[QueryDataTypeDict] | Yes | | +**type** | Literal["union"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/RangeConstraint.md b/docs/v2/ontologies/models/RangeConstraint.md new file mode 100644 index 00000000..85b59fe7 --- /dev/null +++ b/docs/v2/ontologies/models/RangeConstraint.md @@ -0,0 +1,16 @@ +# RangeConstraint + +The parameter value must be within the defined range. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**lt** | Optional[Any] | No | Less than | +**lte** | Optional[Any] | No | Less than or equal | +**gt** | Optional[Any] | No | Greater than | +**gte** | Optional[Any] | No | Greater than or equal | +**type** | Literal["range"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/RangeConstraintDict.md b/docs/v2/ontologies/models/RangeConstraintDict.md new file mode 100644 index 00000000..58191e7e --- /dev/null +++ b/docs/v2/ontologies/models/RangeConstraintDict.md @@ -0,0 +1,16 @@ +# RangeConstraintDict + +The parameter value must be within the defined range. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**lt** | NotRequired[Any] | No | Less than | +**lte** | NotRequired[Any] | No | Less than or equal | +**gt** | NotRequired[Any] | No | Greater than | +**gte** | NotRequired[Any] | No | Greater than or equal | +**type** | Literal["range"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/RelativeTimeDict.md b/docs/v2/ontologies/models/RelativeTimeDict.md new file mode 100644 index 00000000..076bd513 --- /dev/null +++ b/docs/v2/ontologies/models/RelativeTimeDict.md @@ -0,0 +1,14 @@ +# RelativeTimeDict + +A relative time, such as "3 days before" or "2 hours after" the current moment. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**when** | RelativeTimeRelation | Yes | | +**value** | StrictInt | Yes | | +**unit** | RelativeTimeSeriesTimeUnit | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/RelativeTimeRangeDict.md b/docs/v2/ontologies/models/RelativeTimeRangeDict.md new file mode 100644 index 00000000..dfe8bf51 --- /dev/null +++ b/docs/v2/ontologies/models/RelativeTimeRangeDict.md @@ -0,0 +1,14 @@ +# RelativeTimeRangeDict + +A relative time range for a time series query. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**startTime** | NotRequired[RelativeTimeDict] | No | | +**endTime** | NotRequired[RelativeTimeDict] | No | | +**type** | Literal["relative"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/RelativeTimeRelation.md b/docs/v2/ontologies/models/RelativeTimeRelation.md new file mode 100644 index 00000000..d73c91c5 --- /dev/null +++ b/docs/v2/ontologies/models/RelativeTimeRelation.md @@ -0,0 +1,11 @@ +# RelativeTimeRelation + +RelativeTimeRelation + +| **Value** | +| --------- | +| `"BEFORE"` | +| `"AFTER"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/RelativeTimeSeriesTimeUnit.md b/docs/v2/ontologies/models/RelativeTimeSeriesTimeUnit.md new file mode 100644 index 00000000..66820535 --- /dev/null +++ b/docs/v2/ontologies/models/RelativeTimeSeriesTimeUnit.md @@ -0,0 +1,17 @@ +# RelativeTimeSeriesTimeUnit + +RelativeTimeSeriesTimeUnit + +| **Value** | +| --------- | +| `"MILLISECONDS"` | +| `"SECONDS"` | +| `"MINUTES"` | +| `"HOURS"` | +| `"DAYS"` | +| `"WEEKS"` | +| `"MONTHS"` | +| `"YEARS"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ReturnEditsMode.md b/docs/v2/ontologies/models/ReturnEditsMode.md new file mode 100644 index 00000000..e12a7272 --- /dev/null +++ b/docs/v2/ontologies/models/ReturnEditsMode.md @@ -0,0 +1,11 @@ +# ReturnEditsMode + +ReturnEditsMode + +| **Value** | +| --------- | +| `"ALL"` | +| `"NONE"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SdkPackageName.md b/docs/v2/ontologies/models/SdkPackageName.md new file mode 100644 index 00000000..65ff26b6 --- /dev/null +++ b/docs/v2/ontologies/models/SdkPackageName.md @@ -0,0 +1,11 @@ +# SdkPackageName + +SdkPackageName + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SearchJsonQueryV2.md b/docs/v2/ontologies/models/SearchJsonQueryV2.md new file mode 100644 index 00000000..e1fa25d7 --- /dev/null +++ b/docs/v2/ontologies/models/SearchJsonQueryV2.md @@ -0,0 +1,36 @@ +# SearchJsonQueryV2 + +SearchJsonQueryV2 + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +OrQueryV2 | or +DoesNotIntersectPolygonQuery | doesNotIntersectPolygon +LtQueryV2 | lt +DoesNotIntersectBoundingBoxQuery | doesNotIntersectBoundingBox +EqualsQueryV2 | eq +ContainsAllTermsQuery | containsAllTerms +GtQueryV2 | gt +WithinDistanceOfQuery | withinDistanceOf +WithinBoundingBoxQuery | withinBoundingBox +ContainsQueryV2 | contains +NotQueryV2 | not +IntersectsBoundingBoxQuery | intersectsBoundingBox +AndQueryV2 | and +IsNullQueryV2 | isNull +ContainsAllTermsInOrderPrefixLastTerm | containsAllTermsInOrderPrefixLastTerm +ContainsAnyTermQuery | containsAnyTerm +GteQueryV2 | gte +ContainsAllTermsInOrderQuery | containsAllTermsInOrder +WithinPolygonQuery | withinPolygon +IntersectsPolygonQuery | intersectsPolygon +LteQueryV2 | lte +StartsWithQuery | startsWith + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SearchJsonQueryV2Dict.md b/docs/v2/ontologies/models/SearchJsonQueryV2Dict.md new file mode 100644 index 00000000..97a0916f --- /dev/null +++ b/docs/v2/ontologies/models/SearchJsonQueryV2Dict.md @@ -0,0 +1,36 @@ +# SearchJsonQueryV2Dict + +SearchJsonQueryV2 + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +OrQueryV2Dict | or +DoesNotIntersectPolygonQueryDict | doesNotIntersectPolygon +LtQueryV2Dict | lt +DoesNotIntersectBoundingBoxQueryDict | doesNotIntersectBoundingBox +EqualsQueryV2Dict | eq +ContainsAllTermsQueryDict | containsAllTerms +GtQueryV2Dict | gt +WithinDistanceOfQueryDict | withinDistanceOf +WithinBoundingBoxQueryDict | withinBoundingBox +ContainsQueryV2Dict | contains +NotQueryV2Dict | not +IntersectsBoundingBoxQueryDict | intersectsBoundingBox +AndQueryV2Dict | and +IsNullQueryV2Dict | isNull +ContainsAllTermsInOrderPrefixLastTermDict | containsAllTermsInOrderPrefixLastTerm +ContainsAnyTermQueryDict | containsAnyTerm +GteQueryV2Dict | gte +ContainsAllTermsInOrderQueryDict | containsAllTermsInOrder +WithinPolygonQueryDict | withinPolygon +IntersectsPolygonQueryDict | intersectsPolygon +LteQueryV2Dict | lte +StartsWithQueryDict | startsWith + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SearchObjectsResponseV2.md b/docs/v2/ontologies/models/SearchObjectsResponseV2.md new file mode 100644 index 00000000..864e39be --- /dev/null +++ b/docs/v2/ontologies/models/SearchObjectsResponseV2.md @@ -0,0 +1,13 @@ +# SearchObjectsResponseV2 + +SearchObjectsResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[OntologyObjectV2] | Yes | | +**next_page_token** | Optional[PageToken] | No | | +**total_count** | TotalCount | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SearchObjectsResponseV2Dict.md b/docs/v2/ontologies/models/SearchObjectsResponseV2Dict.md new file mode 100644 index 00000000..52c1b07e --- /dev/null +++ b/docs/v2/ontologies/models/SearchObjectsResponseV2Dict.md @@ -0,0 +1,13 @@ +# SearchObjectsResponseV2Dict + +SearchObjectsResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[OntologyObjectV2] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | +**totalCount** | TotalCount | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SearchOrderByV2Dict.md b/docs/v2/ontologies/models/SearchOrderByV2Dict.md new file mode 100644 index 00000000..7d2d5518 --- /dev/null +++ b/docs/v2/ontologies/models/SearchOrderByV2Dict.md @@ -0,0 +1,11 @@ +# SearchOrderByV2Dict + +Specifies the ordering of search results by a field and an ordering direction. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**fields** | List[SearchOrderingV2Dict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SearchOrderingV2Dict.md b/docs/v2/ontologies/models/SearchOrderingV2Dict.md new file mode 100644 index 00000000..52129feb --- /dev/null +++ b/docs/v2/ontologies/models/SearchOrderingV2Dict.md @@ -0,0 +1,12 @@ +# SearchOrderingV2Dict + +SearchOrderingV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**direction** | NotRequired[StrictStr] | No | Specifies the ordering direction (can be either `asc` or `desc`) | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SelectedPropertyApiName.md b/docs/v2/ontologies/models/SelectedPropertyApiName.md new file mode 100644 index 00000000..6bea4312 --- /dev/null +++ b/docs/v2/ontologies/models/SelectedPropertyApiName.md @@ -0,0 +1,26 @@ +# SelectedPropertyApiName + +By default, anytime an object is requested, every property belonging to that object is returned. +The response can be filtered to only include certain properties using the `properties` query parameter. + +Properties to include can be specified in one of two ways. + +- A comma delimited list as the value for the `properties` query parameter + `properties={property1ApiName},{property2ApiName}` +- Multiple `properties` query parameters. + `properties={property1ApiName}&properties={property2ApiName}` + +The primary key of the object will always be returned even if it wasn't specified in the `properties` values. + +Unknown properties specified in the `properties` list will result in a `PropertiesNotFound` error. + +To find the API name for your property, use the `Get object type` endpoint or check the **Ontology Manager**. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SharedPropertyType.md b/docs/v2/ontologies/models/SharedPropertyType.md new file mode 100644 index 00000000..c8939bf2 --- /dev/null +++ b/docs/v2/ontologies/models/SharedPropertyType.md @@ -0,0 +1,15 @@ +# SharedPropertyType + +A property type that can be shared across object types. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | SharedPropertyTypeRid | Yes | | +**api_name** | SharedPropertyTypeApiName | Yes | | +**display_name** | DisplayName | Yes | | +**description** | Optional[StrictStr] | No | A short text that describes the SharedPropertyType. | +**data_type** | ObjectPropertyType | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SharedPropertyTypeApiName.md b/docs/v2/ontologies/models/SharedPropertyTypeApiName.md new file mode 100644 index 00000000..a5350b4b --- /dev/null +++ b/docs/v2/ontologies/models/SharedPropertyTypeApiName.md @@ -0,0 +1,13 @@ +# SharedPropertyTypeApiName + +The name of the shared property type in the API in lowerCamelCase format. To find the API name for your +shared property type, use the `List shared property types` endpoint or check the **Ontology Manager**. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SharedPropertyTypeDict.md b/docs/v2/ontologies/models/SharedPropertyTypeDict.md new file mode 100644 index 00000000..6ce16c54 --- /dev/null +++ b/docs/v2/ontologies/models/SharedPropertyTypeDict.md @@ -0,0 +1,15 @@ +# SharedPropertyTypeDict + +A property type that can be shared across object types. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | SharedPropertyTypeRid | Yes | | +**apiName** | SharedPropertyTypeApiName | Yes | | +**displayName** | DisplayName | Yes | | +**description** | NotRequired[StrictStr] | No | A short text that describes the SharedPropertyType. | +**dataType** | ObjectPropertyTypeDict | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SharedPropertyTypeRid.md b/docs/v2/ontologies/models/SharedPropertyTypeRid.md new file mode 100644 index 00000000..ea853f6e --- /dev/null +++ b/docs/v2/ontologies/models/SharedPropertyTypeRid.md @@ -0,0 +1,12 @@ +# SharedPropertyTypeRid + +The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/StartsWithQuery.md b/docs/v2/ontologies/models/StartsWithQuery.md new file mode 100644 index 00000000..4d168c81 --- /dev/null +++ b/docs/v2/ontologies/models/StartsWithQuery.md @@ -0,0 +1,13 @@ +# StartsWithQuery + +Returns objects where the specified field starts with the provided value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | StrictStr | Yes | | +**type** | Literal["startsWith"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/StartsWithQueryDict.md b/docs/v2/ontologies/models/StartsWithQueryDict.md new file mode 100644 index 00000000..09014a3e --- /dev/null +++ b/docs/v2/ontologies/models/StartsWithQueryDict.md @@ -0,0 +1,13 @@ +# StartsWithQueryDict + +Returns objects where the specified field starts with the provided value. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | StrictStr | Yes | | +**type** | Literal["startsWith"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/StringLengthConstraint.md b/docs/v2/ontologies/models/StringLengthConstraint.md new file mode 100644 index 00000000..f35990c6 --- /dev/null +++ b/docs/v2/ontologies/models/StringLengthConstraint.md @@ -0,0 +1,17 @@ +# StringLengthConstraint + +The parameter value must have a length within the defined range. +*This range is always inclusive.* + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**lt** | Optional[Any] | No | Less than | +**lte** | Optional[Any] | No | Less than or equal | +**gt** | Optional[Any] | No | Greater than | +**gte** | Optional[Any] | No | Greater than or equal | +**type** | Literal["stringLength"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/StringLengthConstraintDict.md b/docs/v2/ontologies/models/StringLengthConstraintDict.md new file mode 100644 index 00000000..311978cf --- /dev/null +++ b/docs/v2/ontologies/models/StringLengthConstraintDict.md @@ -0,0 +1,17 @@ +# StringLengthConstraintDict + +The parameter value must have a length within the defined range. +*This range is always inclusive.* + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**lt** | NotRequired[Any] | No | Less than | +**lte** | NotRequired[Any] | No | Less than or equal | +**gt** | NotRequired[Any] | No | Greater than | +**gte** | NotRequired[Any] | No | Greater than or equal | +**type** | Literal["stringLength"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/StringRegexMatchConstraint.md b/docs/v2/ontologies/models/StringRegexMatchConstraint.md new file mode 100644 index 00000000..f420e342 --- /dev/null +++ b/docs/v2/ontologies/models/StringRegexMatchConstraint.md @@ -0,0 +1,14 @@ +# StringRegexMatchConstraint + +The parameter value must match a predefined regular expression. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**regex** | StrictStr | Yes | The regular expression configured in the **Ontology Manager**. | +**configured_failure_message** | Optional[StrictStr] | No | The message indicating that the regular expression was not matched. This is configured per parameter in the **Ontology Manager**. | +**type** | Literal["stringRegexMatch"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/StringRegexMatchConstraintDict.md b/docs/v2/ontologies/models/StringRegexMatchConstraintDict.md new file mode 100644 index 00000000..08e240e5 --- /dev/null +++ b/docs/v2/ontologies/models/StringRegexMatchConstraintDict.md @@ -0,0 +1,14 @@ +# StringRegexMatchConstraintDict + +The parameter value must match a predefined regular expression. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**regex** | StrictStr | Yes | The regular expression configured in the **Ontology Manager**. | +**configuredFailureMessage** | NotRequired[StrictStr] | No | The message indicating that the regular expression was not matched. This is configured per parameter in the **Ontology Manager**. | +**type** | Literal["stringRegexMatch"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SubmissionCriteriaEvaluation.md b/docs/v2/ontologies/models/SubmissionCriteriaEvaluation.md new file mode 100644 index 00000000..8eaaaddb --- /dev/null +++ b/docs/v2/ontologies/models/SubmissionCriteriaEvaluation.md @@ -0,0 +1,15 @@ +# SubmissionCriteriaEvaluation + +Contains the status of the **submission criteria**. +**Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. +These are configured in the **Ontology Manager**. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**configured_failure_message** | Optional[StrictStr] | No | The message indicating one of the **submission criteria** was not satisfied. This is configured per **submission criteria** in the **Ontology Manager**. | +**result** | ValidationResult | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SubmissionCriteriaEvaluationDict.md b/docs/v2/ontologies/models/SubmissionCriteriaEvaluationDict.md new file mode 100644 index 00000000..8b2de215 --- /dev/null +++ b/docs/v2/ontologies/models/SubmissionCriteriaEvaluationDict.md @@ -0,0 +1,15 @@ +# SubmissionCriteriaEvaluationDict + +Contains the status of the **submission criteria**. +**Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. +These are configured in the **Ontology Manager**. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**configuredFailureMessage** | NotRequired[StrictStr] | No | The message indicating one of the **submission criteria** was not satisfied. This is configured per **submission criteria** in the **Ontology Manager**. | +**result** | ValidationResult | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SumAggregationV2Dict.md b/docs/v2/ontologies/models/SumAggregationV2Dict.md new file mode 100644 index 00000000..b5f6a83e --- /dev/null +++ b/docs/v2/ontologies/models/SumAggregationV2Dict.md @@ -0,0 +1,14 @@ +# SumAggregationV2Dict + +Computes the sum of values for the provided field. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**name** | NotRequired[AggregationMetricName] | No | | +**direction** | NotRequired[OrderByDirection] | No | | +**type** | Literal["sum"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SyncApplyActionResponseV2.md b/docs/v2/ontologies/models/SyncApplyActionResponseV2.md new file mode 100644 index 00000000..58e5884e --- /dev/null +++ b/docs/v2/ontologies/models/SyncApplyActionResponseV2.md @@ -0,0 +1,12 @@ +# SyncApplyActionResponseV2 + +SyncApplyActionResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**validation** | Optional[ValidateActionResponseV2] | No | | +**edits** | Optional[ActionResults] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/SyncApplyActionResponseV2Dict.md b/docs/v2/ontologies/models/SyncApplyActionResponseV2Dict.md new file mode 100644 index 00000000..4a04d808 --- /dev/null +++ b/docs/v2/ontologies/models/SyncApplyActionResponseV2Dict.md @@ -0,0 +1,12 @@ +# SyncApplyActionResponseV2Dict + +SyncApplyActionResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**validation** | NotRequired[ValidateActionResponseV2Dict] | No | | +**edits** | NotRequired[ActionResultsDict] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ThreeDimensionalAggregation.md b/docs/v2/ontologies/models/ThreeDimensionalAggregation.md new file mode 100644 index 00000000..9fb4c0c8 --- /dev/null +++ b/docs/v2/ontologies/models/ThreeDimensionalAggregation.md @@ -0,0 +1,13 @@ +# ThreeDimensionalAggregation + +ThreeDimensionalAggregation + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**key_type** | QueryAggregationKeyType | Yes | | +**value_type** | TwoDimensionalAggregation | Yes | | +**type** | Literal["threeDimensionalAggregation"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ThreeDimensionalAggregationDict.md b/docs/v2/ontologies/models/ThreeDimensionalAggregationDict.md new file mode 100644 index 00000000..bd9eab2b --- /dev/null +++ b/docs/v2/ontologies/models/ThreeDimensionalAggregationDict.md @@ -0,0 +1,13 @@ +# ThreeDimensionalAggregationDict + +ThreeDimensionalAggregation + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**keyType** | QueryAggregationKeyTypeDict | Yes | | +**valueType** | TwoDimensionalAggregationDict | Yes | | +**type** | Literal["threeDimensionalAggregation"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/TimeRangeDict.md b/docs/v2/ontologies/models/TimeRangeDict.md new file mode 100644 index 00000000..4071a261 --- /dev/null +++ b/docs/v2/ontologies/models/TimeRangeDict.md @@ -0,0 +1,16 @@ +# TimeRangeDict + +An absolute or relative range for a time series query. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +AbsoluteTimeRangeDict | absolute +RelativeTimeRangeDict | relative + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/TimeSeriesPoint.md b/docs/v2/ontologies/models/TimeSeriesPoint.md new file mode 100644 index 00000000..23fa01c0 --- /dev/null +++ b/docs/v2/ontologies/models/TimeSeriesPoint.md @@ -0,0 +1,13 @@ +# TimeSeriesPoint + +A time and value pair. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**time** | datetime | Yes | An ISO 8601 timestamp | +**value** | Any | Yes | An object which is either an enum String or a double number. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/TimeSeriesPointDict.md b/docs/v2/ontologies/models/TimeSeriesPointDict.md new file mode 100644 index 00000000..6ad25940 --- /dev/null +++ b/docs/v2/ontologies/models/TimeSeriesPointDict.md @@ -0,0 +1,13 @@ +# TimeSeriesPointDict + +A time and value pair. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**time** | datetime | Yes | An ISO 8601 timestamp | +**value** | Any | Yes | An object which is either an enum String or a double number. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/TwoDimensionalAggregation.md b/docs/v2/ontologies/models/TwoDimensionalAggregation.md new file mode 100644 index 00000000..b6f42990 --- /dev/null +++ b/docs/v2/ontologies/models/TwoDimensionalAggregation.md @@ -0,0 +1,13 @@ +# TwoDimensionalAggregation + +TwoDimensionalAggregation + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**key_type** | QueryAggregationKeyType | Yes | | +**value_type** | QueryAggregationValueType | Yes | | +**type** | Literal["twoDimensionalAggregation"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/TwoDimensionalAggregationDict.md b/docs/v2/ontologies/models/TwoDimensionalAggregationDict.md new file mode 100644 index 00000000..0bf09bf9 --- /dev/null +++ b/docs/v2/ontologies/models/TwoDimensionalAggregationDict.md @@ -0,0 +1,13 @@ +# TwoDimensionalAggregationDict + +TwoDimensionalAggregation + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**keyType** | QueryAggregationKeyTypeDict | Yes | | +**valueType** | QueryAggregationValueTypeDict | Yes | | +**type** | Literal["twoDimensionalAggregation"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/UnevaluableConstraint.md b/docs/v2/ontologies/models/UnevaluableConstraint.md new file mode 100644 index 00000000..14eb00cb --- /dev/null +++ b/docs/v2/ontologies/models/UnevaluableConstraint.md @@ -0,0 +1,13 @@ +# UnevaluableConstraint + +The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. +This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["unevaluable"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/UnevaluableConstraintDict.md b/docs/v2/ontologies/models/UnevaluableConstraintDict.md new file mode 100644 index 00000000..25c68ee4 --- /dev/null +++ b/docs/v2/ontologies/models/UnevaluableConstraintDict.md @@ -0,0 +1,13 @@ +# UnevaluableConstraintDict + +The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. +This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["unevaluable"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ValidateActionResponseV2.md b/docs/v2/ontologies/models/ValidateActionResponseV2.md new file mode 100644 index 00000000..f3a2a2c4 --- /dev/null +++ b/docs/v2/ontologies/models/ValidateActionResponseV2.md @@ -0,0 +1,13 @@ +# ValidateActionResponseV2 + +ValidateActionResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**result** | ValidationResult | Yes | | +**submission_criteria** | List[SubmissionCriteriaEvaluation] | Yes | | +**parameters** | Dict[ParameterId, ParameterEvaluationResult] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ValidateActionResponseV2Dict.md b/docs/v2/ontologies/models/ValidateActionResponseV2Dict.md new file mode 100644 index 00000000..b38cbb8f --- /dev/null +++ b/docs/v2/ontologies/models/ValidateActionResponseV2Dict.md @@ -0,0 +1,13 @@ +# ValidateActionResponseV2Dict + +ValidateActionResponseV2 + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**result** | ValidationResult | Yes | | +**submissionCriteria** | List[SubmissionCriteriaEvaluationDict] | Yes | | +**parameters** | Dict[ParameterId, ParameterEvaluationResultDict] | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ValidationResult.md b/docs/v2/ontologies/models/ValidationResult.md new file mode 100644 index 00000000..6b6498fb --- /dev/null +++ b/docs/v2/ontologies/models/ValidationResult.md @@ -0,0 +1,12 @@ +# ValidationResult + +Represents the state of a validation. + + +| **Value** | +| --------- | +| `"VALID"` | +| `"INVALID"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/WithinBoundingBoxPoint.md b/docs/v2/ontologies/models/WithinBoundingBoxPoint.md new file mode 100644 index 00000000..e476994d --- /dev/null +++ b/docs/v2/ontologies/models/WithinBoundingBoxPoint.md @@ -0,0 +1,11 @@ +# WithinBoundingBoxPoint + +WithinBoundingBoxPoint + +## Type +```python +GeoPoint +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/WithinBoundingBoxPointDict.md b/docs/v2/ontologies/models/WithinBoundingBoxPointDict.md new file mode 100644 index 00000000..2548033e --- /dev/null +++ b/docs/v2/ontologies/models/WithinBoundingBoxPointDict.md @@ -0,0 +1,11 @@ +# WithinBoundingBoxPointDict + +WithinBoundingBoxPoint + +## Type +```python +GeoPointDict +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/WithinBoundingBoxQuery.md b/docs/v2/ontologies/models/WithinBoundingBoxQuery.md new file mode 100644 index 00000000..d91240c0 --- /dev/null +++ b/docs/v2/ontologies/models/WithinBoundingBoxQuery.md @@ -0,0 +1,14 @@ +# WithinBoundingBoxQuery + +Returns objects where the specified field contains a point within the bounding box provided. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | BoundingBoxValue | Yes | | +**type** | Literal["withinBoundingBox"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/WithinBoundingBoxQueryDict.md b/docs/v2/ontologies/models/WithinBoundingBoxQueryDict.md new file mode 100644 index 00000000..8252bcab --- /dev/null +++ b/docs/v2/ontologies/models/WithinBoundingBoxQueryDict.md @@ -0,0 +1,14 @@ +# WithinBoundingBoxQueryDict + +Returns objects where the specified field contains a point within the bounding box provided. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | BoundingBoxValueDict | Yes | | +**type** | Literal["withinBoundingBox"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/WithinDistanceOfQuery.md b/docs/v2/ontologies/models/WithinDistanceOfQuery.md new file mode 100644 index 00000000..92311cde --- /dev/null +++ b/docs/v2/ontologies/models/WithinDistanceOfQuery.md @@ -0,0 +1,14 @@ +# WithinDistanceOfQuery + +Returns objects where the specified field contains a point within the distance provided of the center point. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | CenterPoint | Yes | | +**type** | Literal["withinDistanceOf"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/WithinDistanceOfQueryDict.md b/docs/v2/ontologies/models/WithinDistanceOfQueryDict.md new file mode 100644 index 00000000..91dea247 --- /dev/null +++ b/docs/v2/ontologies/models/WithinDistanceOfQueryDict.md @@ -0,0 +1,14 @@ +# WithinDistanceOfQueryDict + +Returns objects where the specified field contains a point within the distance provided of the center point. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | CenterPointDict | Yes | | +**type** | Literal["withinDistanceOf"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/WithinPolygonQuery.md b/docs/v2/ontologies/models/WithinPolygonQuery.md new file mode 100644 index 00000000..6f6e92ff --- /dev/null +++ b/docs/v2/ontologies/models/WithinPolygonQuery.md @@ -0,0 +1,14 @@ +# WithinPolygonQuery + +Returns objects where the specified field contains a point within the polygon provided. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PolygonValue | Yes | | +**type** | Literal["withinPolygon"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/WithinPolygonQueryDict.md b/docs/v2/ontologies/models/WithinPolygonQueryDict.md new file mode 100644 index 00000000..a96d75ee --- /dev/null +++ b/docs/v2/ontologies/models/WithinPolygonQueryDict.md @@ -0,0 +1,14 @@ +# WithinPolygonQueryDict + +Returns objects where the specified field contains a point within the polygon provided. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**field** | PropertyApiName | Yes | | +**value** | PolygonValueDict | Yes | | +**type** | Literal["withinPolygon"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/AbortOnFailure.md b/docs/v2/orchestration/models/AbortOnFailure.md new file mode 100644 index 00000000..c4223fed --- /dev/null +++ b/docs/v2/orchestration/models/AbortOnFailure.md @@ -0,0 +1,13 @@ +# AbortOnFailure + +If any job in the build is unsuccessful, immediately finish the +build by cancelling all other jobs. + + +## Type +```python +StrictBool +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/Action.md b/docs/v2/orchestration/models/Action.md new file mode 100644 index 00000000..c2e145a7 --- /dev/null +++ b/docs/v2/orchestration/models/Action.md @@ -0,0 +1,18 @@ +# Action + +Action + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**target** | BuildTarget | Yes | | +**branch_name** | BranchName | Yes | The target branch the schedule should run on. | +**fallback_branches** | FallbackBranches | Yes | | +**force_build** | ForceBuild | Yes | | +**retry_count** | Optional[RetryCount] | No | | +**retry_backoff_duration** | Optional[RetryBackoffDuration] | No | | +**abort_on_failure** | AbortOnFailure | Yes | | +**notifications_enabled** | NotificationsEnabled | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/models/ActionDict.md b/docs/v2/orchestration/models/ActionDict.md similarity index 78% rename from docs/v2/models/ActionDict.md rename to docs/v2/orchestration/models/ActionDict.md index 401f883e..20cc6c57 100644 --- a/docs/v2/models/ActionDict.md +++ b/docs/v2/orchestration/models/ActionDict.md @@ -15,4 +15,4 @@ Action **notificationsEnabled** | NotificationsEnabled | Yes | | -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/AndTrigger.md b/docs/v2/orchestration/models/AndTrigger.md new file mode 100644 index 00000000..5de996e0 --- /dev/null +++ b/docs/v2/orchestration/models/AndTrigger.md @@ -0,0 +1,12 @@ +# AndTrigger + +Trigger after all of the given triggers emit an event. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**triggers** | List[Trigger] | Yes | | +**type** | Literal["and"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/AndTriggerDict.md b/docs/v2/orchestration/models/AndTriggerDict.md new file mode 100644 index 00000000..2b7259fe --- /dev/null +++ b/docs/v2/orchestration/models/AndTriggerDict.md @@ -0,0 +1,12 @@ +# AndTriggerDict + +Trigger after all of the given triggers emit an event. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**triggers** | List[TriggerDict] | Yes | | +**type** | Literal["and"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/Build.md b/docs/v2/orchestration/models/Build.md new file mode 100644 index 00000000..0b09523d --- /dev/null +++ b/docs/v2/orchestration/models/Build.md @@ -0,0 +1,19 @@ +# Build + +Build + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | BuildRid | Yes | The RID of a build | +**branch_name** | BranchName | Yes | The branch that the build is running on. | +**created_time** | CreatedTime | Yes | The timestamp that the build was created. | +**created_by** | CreatedBy | Yes | The user who created the build. | +**fallback_branches** | FallbackBranches | Yes | | +**retry_count** | RetryCount | Yes | | +**retry_backoff_duration** | RetryBackoffDuration | Yes | | +**abort_on_failure** | AbortOnFailure | Yes | | +**status** | BuildStatus | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/models/BuildDict.md b/docs/v2/orchestration/models/BuildDict.md similarity index 80% rename from docs/v2/models/BuildDict.md rename to docs/v2/orchestration/models/BuildDict.md index d71f4822..ecc033c4 100644 --- a/docs/v2/models/BuildDict.md +++ b/docs/v2/orchestration/models/BuildDict.md @@ -16,4 +16,4 @@ Build **status** | BuildStatus | Yes | | -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/BuildRid.md b/docs/v2/orchestration/models/BuildRid.md new file mode 100644 index 00000000..972d5a58 --- /dev/null +++ b/docs/v2/orchestration/models/BuildRid.md @@ -0,0 +1,11 @@ +# BuildRid + +The RID of a build + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/BuildStatus.md b/docs/v2/orchestration/models/BuildStatus.md new file mode 100644 index 00000000..2bbb5d4f --- /dev/null +++ b/docs/v2/orchestration/models/BuildStatus.md @@ -0,0 +1,13 @@ +# BuildStatus + +The status of the build. + +| **Value** | +| --------- | +| `"RUNNING"` | +| `"SUCCEEDED"` | +| `"FAILED"` | +| `"CANCELED"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/BuildTarget.md b/docs/v2/orchestration/models/BuildTarget.md new file mode 100644 index 00000000..ff25a8f3 --- /dev/null +++ b/docs/v2/orchestration/models/BuildTarget.md @@ -0,0 +1,17 @@ +# BuildTarget + +The targets of the build. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +UpstreamTarget | upstream +ManualTarget | manual +ConnectingTarget | connecting + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/BuildTargetDict.md b/docs/v2/orchestration/models/BuildTargetDict.md new file mode 100644 index 00000000..44f22e18 --- /dev/null +++ b/docs/v2/orchestration/models/BuildTargetDict.md @@ -0,0 +1,17 @@ +# BuildTargetDict + +The targets of the build. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +UpstreamTargetDict | upstream +ManualTargetDict | manual +ConnectingTargetDict | connecting + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/models/ConnectingTarget.md b/docs/v2/orchestration/models/ConnectingTarget.md similarity index 79% rename from docs/v2/models/ConnectingTarget.md rename to docs/v2/orchestration/models/ConnectingTarget.md index 843fd830..75f0b97b 100644 --- a/docs/v2/models/ConnectingTarget.md +++ b/docs/v2/orchestration/models/ConnectingTarget.md @@ -13,4 +13,4 @@ target datasets (inclusive) except for the datasets to ignore. **type** | Literal["connecting"] | Yes | None | -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/models/ConnectingTargetDict.md b/docs/v2/orchestration/models/ConnectingTargetDict.md similarity index 79% rename from docs/v2/models/ConnectingTargetDict.md rename to docs/v2/orchestration/models/ConnectingTargetDict.md index 2222bb87..e119d58f 100644 --- a/docs/v2/models/ConnectingTargetDict.md +++ b/docs/v2/orchestration/models/ConnectingTargetDict.md @@ -13,4 +13,4 @@ target datasets (inclusive) except for the datasets to ignore. **type** | Literal["connecting"] | Yes | None | -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/CronExpression.md b/docs/v2/orchestration/models/CronExpression.md new file mode 100644 index 00000000..de42f4e9 --- /dev/null +++ b/docs/v2/orchestration/models/CronExpression.md @@ -0,0 +1,13 @@ +# CronExpression + +A standard CRON expression with minute, hour, day, month +and day of week. + + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/DatasetUpdatedTrigger.md b/docs/v2/orchestration/models/DatasetUpdatedTrigger.md new file mode 100644 index 00000000..21f4b16b --- /dev/null +++ b/docs/v2/orchestration/models/DatasetUpdatedTrigger.md @@ -0,0 +1,15 @@ +# DatasetUpdatedTrigger + +Trigger whenever a new transaction is committed to the +dataset on the target branch. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | Yes | | +**branch_name** | BranchName | Yes | | +**type** | Literal["datasetUpdated"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/DatasetUpdatedTriggerDict.md b/docs/v2/orchestration/models/DatasetUpdatedTriggerDict.md new file mode 100644 index 00000000..4c0c7f73 --- /dev/null +++ b/docs/v2/orchestration/models/DatasetUpdatedTriggerDict.md @@ -0,0 +1,15 @@ +# DatasetUpdatedTriggerDict + +Trigger whenever a new transaction is committed to the +dataset on the target branch. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**datasetRid** | DatasetRid | Yes | | +**branchName** | BranchName | Yes | | +**type** | Literal["datasetUpdated"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/FallbackBranches.md b/docs/v2/orchestration/models/FallbackBranches.md new file mode 100644 index 00000000..4858227e --- /dev/null +++ b/docs/v2/orchestration/models/FallbackBranches.md @@ -0,0 +1,13 @@ +# FallbackBranches + +The branches to retrieve JobSpecs from if no JobSpec is found on the +target branch. + + +## Type +```python +List[BranchName] +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ForceBuild.md b/docs/v2/orchestration/models/ForceBuild.md new file mode 100644 index 00000000..d8d4c7f1 --- /dev/null +++ b/docs/v2/orchestration/models/ForceBuild.md @@ -0,0 +1,11 @@ +# ForceBuild + +Whether to ignore staleness information when running the build. + +## Type +```python +StrictBool +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/JobSucceededTrigger.md b/docs/v2/orchestration/models/JobSucceededTrigger.md new file mode 100644 index 00000000..3eeb1258 --- /dev/null +++ b/docs/v2/orchestration/models/JobSucceededTrigger.md @@ -0,0 +1,15 @@ +# JobSucceededTrigger + +Trigger whenever a job succeeds on the dataset and on the target +branch. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**dataset_rid** | DatasetRid | Yes | | +**branch_name** | BranchName | Yes | | +**type** | Literal["jobSucceeded"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/JobSucceededTriggerDict.md b/docs/v2/orchestration/models/JobSucceededTriggerDict.md new file mode 100644 index 00000000..9cc13140 --- /dev/null +++ b/docs/v2/orchestration/models/JobSucceededTriggerDict.md @@ -0,0 +1,15 @@ +# JobSucceededTriggerDict + +Trigger whenever a job succeeds on the dataset and on the target +branch. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**datasetRid** | DatasetRid | Yes | | +**branchName** | BranchName | Yes | | +**type** | Literal["jobSucceeded"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ManualTarget.md b/docs/v2/orchestration/models/ManualTarget.md new file mode 100644 index 00000000..7903a872 --- /dev/null +++ b/docs/v2/orchestration/models/ManualTarget.md @@ -0,0 +1,12 @@ +# ManualTarget + +Manually specify all datasets to build. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**dataset_rids** | List[DatasetRid] | Yes | | +**type** | Literal["manual"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ManualTargetDict.md b/docs/v2/orchestration/models/ManualTargetDict.md new file mode 100644 index 00000000..380b8647 --- /dev/null +++ b/docs/v2/orchestration/models/ManualTargetDict.md @@ -0,0 +1,12 @@ +# ManualTargetDict + +Manually specify all datasets to build. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**datasetRids** | List[DatasetRid] | Yes | | +**type** | Literal["manual"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/models/MediaSetUpdatedTrigger.md b/docs/v2/orchestration/models/MediaSetUpdatedTrigger.md similarity index 77% rename from docs/v2/models/MediaSetUpdatedTrigger.md rename to docs/v2/orchestration/models/MediaSetUpdatedTrigger.md index 5858fcbe..67838822 100644 --- a/docs/v2/models/MediaSetUpdatedTrigger.md +++ b/docs/v2/orchestration/models/MediaSetUpdatedTrigger.md @@ -14,4 +14,4 @@ eventually (but not necessary immediately) after an update. **type** | Literal["mediaSetUpdated"] | Yes | None | -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/models/MediaSetUpdatedTriggerDict.md b/docs/v2/orchestration/models/MediaSetUpdatedTriggerDict.md similarity index 77% rename from docs/v2/models/MediaSetUpdatedTriggerDict.md rename to docs/v2/orchestration/models/MediaSetUpdatedTriggerDict.md index d6ce99b2..b90dfd68 100644 --- a/docs/v2/models/MediaSetUpdatedTriggerDict.md +++ b/docs/v2/orchestration/models/MediaSetUpdatedTriggerDict.md @@ -14,4 +14,4 @@ eventually (but not necessary immediately) after an update. **type** | Literal["mediaSetUpdated"] | Yes | None | -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/NewLogicTrigger.md b/docs/v2/orchestration/models/NewLogicTrigger.md new file mode 100644 index 00000000..a3353814 --- /dev/null +++ b/docs/v2/orchestration/models/NewLogicTrigger.md @@ -0,0 +1,15 @@ +# NewLogicTrigger + +Trigger whenever a new JobSpec is put on the dataset and on +that branch. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**branch_name** | BranchName | Yes | | +**dataset_rid** | DatasetRid | Yes | | +**type** | Literal["newLogic"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/NewLogicTriggerDict.md b/docs/v2/orchestration/models/NewLogicTriggerDict.md new file mode 100644 index 00000000..9c157832 --- /dev/null +++ b/docs/v2/orchestration/models/NewLogicTriggerDict.md @@ -0,0 +1,15 @@ +# NewLogicTriggerDict + +Trigger whenever a new JobSpec is put on the dataset and on +that branch. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**branchName** | BranchName | Yes | | +**datasetRid** | DatasetRid | Yes | | +**type** | Literal["newLogic"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/NotificationsEnabled.md b/docs/v2/orchestration/models/NotificationsEnabled.md new file mode 100644 index 00000000..4a38228a --- /dev/null +++ b/docs/v2/orchestration/models/NotificationsEnabled.md @@ -0,0 +1,11 @@ +# NotificationsEnabled + +Whether to receive a notification at the end of scheduled builds. + +## Type +```python +StrictBool +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/OrTrigger.md b/docs/v2/orchestration/models/OrTrigger.md new file mode 100644 index 00000000..b67f0448 --- /dev/null +++ b/docs/v2/orchestration/models/OrTrigger.md @@ -0,0 +1,12 @@ +# OrTrigger + +Trigger whenever any of the given triggers emit an event. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**triggers** | List[Trigger] | Yes | | +**type** | Literal["or"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/OrTriggerDict.md b/docs/v2/orchestration/models/OrTriggerDict.md new file mode 100644 index 00000000..10cf4b58 --- /dev/null +++ b/docs/v2/orchestration/models/OrTriggerDict.md @@ -0,0 +1,12 @@ +# OrTriggerDict + +Trigger whenever any of the given triggers emit an event. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**triggers** | List[TriggerDict] | Yes | | +**type** | Literal["or"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ProjectScope.md b/docs/v2/orchestration/models/ProjectScope.md new file mode 100644 index 00000000..3721a9e1 --- /dev/null +++ b/docs/v2/orchestration/models/ProjectScope.md @@ -0,0 +1,13 @@ +# ProjectScope + +The schedule will only build resources in the following projects. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**project_rids** | List[ProjectRid] | Yes | | +**type** | Literal["project"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ProjectScopeDict.md b/docs/v2/orchestration/models/ProjectScopeDict.md new file mode 100644 index 00000000..1e29e00c --- /dev/null +++ b/docs/v2/orchestration/models/ProjectScopeDict.md @@ -0,0 +1,13 @@ +# ProjectScopeDict + +The schedule will only build resources in the following projects. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**projectRids** | List[ProjectRid] | Yes | | +**type** | Literal["project"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/RetryBackoffDuration.md b/docs/v2/orchestration/models/RetryBackoffDuration.md new file mode 100644 index 00000000..f743e6e5 --- /dev/null +++ b/docs/v2/orchestration/models/RetryBackoffDuration.md @@ -0,0 +1,12 @@ +# RetryBackoffDuration + +The duration to wait before retrying after a Job fails. + + +## Type +```python +Duration +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/RetryBackoffDurationDict.md b/docs/v2/orchestration/models/RetryBackoffDurationDict.md new file mode 100644 index 00000000..310d7f30 --- /dev/null +++ b/docs/v2/orchestration/models/RetryBackoffDurationDict.md @@ -0,0 +1,12 @@ +# RetryBackoffDurationDict + +The duration to wait before retrying after a Job fails. + + +## Type +```python +DurationDict +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/RetryCount.md b/docs/v2/orchestration/models/RetryCount.md new file mode 100644 index 00000000..4e2e1754 --- /dev/null +++ b/docs/v2/orchestration/models/RetryCount.md @@ -0,0 +1,14 @@ +# RetryCount + +The number of retry attempts for failed Jobs within the Build. A Job's failure is not considered final until +all retries have been attempted or an error occurs indicating that retries cannot be performed. Be aware, +not all types of failures can be retried. + + +## Type +```python +StrictInt +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/Schedule.md b/docs/v2/orchestration/models/Schedule.md new file mode 100644 index 00000000..b9e83520 --- /dev/null +++ b/docs/v2/orchestration/models/Schedule.md @@ -0,0 +1,22 @@ +# Schedule + +Schedule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | ScheduleRid | Yes | | +**display_name** | Optional[StrictStr] | No | | +**description** | Optional[StrictStr] | No | | +**current_version_rid** | ScheduleVersionRid | Yes | The RID of the current schedule version | +**created_time** | CreatedTime | Yes | | +**created_by** | CreatedBy | Yes | | +**updated_time** | UpdatedTime | Yes | | +**updated_by** | UpdatedBy | Yes | | +**paused** | SchedulePaused | Yes | | +**trigger** | Optional[Trigger] | No | The schedule trigger. If the requesting user does not have permission to see the trigger, this will be empty. | +**action** | Action | Yes | | +**scope_mode** | ScopeMode | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/models/ScheduleDict.md b/docs/v2/orchestration/models/ScheduleDict.md similarity index 83% rename from docs/v2/models/ScheduleDict.md rename to docs/v2/orchestration/models/ScheduleDict.md index 0821431b..ec5babad 100644 --- a/docs/v2/models/ScheduleDict.md +++ b/docs/v2/orchestration/models/ScheduleDict.md @@ -19,4 +19,4 @@ Schedule **scopeMode** | ScopeModeDict | Yes | | -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/SchedulePaused.md b/docs/v2/orchestration/models/SchedulePaused.md new file mode 100644 index 00000000..aca95bfa --- /dev/null +++ b/docs/v2/orchestration/models/SchedulePaused.md @@ -0,0 +1,11 @@ +# SchedulePaused + +SchedulePaused + +## Type +```python +StrictBool +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScheduleRid.md b/docs/v2/orchestration/models/ScheduleRid.md new file mode 100644 index 00000000..82361166 --- /dev/null +++ b/docs/v2/orchestration/models/ScheduleRid.md @@ -0,0 +1,11 @@ +# ScheduleRid + +The Resource Identifier (RID) of a Schedule. + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/models/ScheduleRun.md b/docs/v2/orchestration/models/ScheduleRun.md similarity index 81% rename from docs/v2/models/ScheduleRun.md rename to docs/v2/orchestration/models/ScheduleRun.md index 2c355fdd..b128d684 100644 --- a/docs/v2/models/ScheduleRun.md +++ b/docs/v2/orchestration/models/ScheduleRun.md @@ -13,4 +13,4 @@ ScheduleRun **result** | Optional[ScheduleRunResult] | No | The result of triggering the schedule. If empty, it means the service is still working on triggering the schedule. | -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/models/ScheduleRunDict.md b/docs/v2/orchestration/models/ScheduleRunDict.md similarity index 82% rename from docs/v2/models/ScheduleRunDict.md rename to docs/v2/orchestration/models/ScheduleRunDict.md index 0db25724..39084a0d 100644 --- a/docs/v2/models/ScheduleRunDict.md +++ b/docs/v2/orchestration/models/ScheduleRunDict.md @@ -13,4 +13,4 @@ ScheduleRun **result** | NotRequired[ScheduleRunResultDict] | No | The result of triggering the schedule. If empty, it means the service is still working on triggering the schedule. | -[[Back to Model list]](../../../README.md#models-v2-link) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to README]](../../../README.md) +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScheduleRunError.md b/docs/v2/orchestration/models/ScheduleRunError.md new file mode 100644 index 00000000..c0d95b3b --- /dev/null +++ b/docs/v2/orchestration/models/ScheduleRunError.md @@ -0,0 +1,13 @@ +# ScheduleRunError + +An error occurred attempting to run the schedule. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**error_name** | ScheduleRunErrorName | Yes | | +**description** | StrictStr | Yes | | +**type** | Literal["error"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScheduleRunErrorDict.md b/docs/v2/orchestration/models/ScheduleRunErrorDict.md new file mode 100644 index 00000000..f3313525 --- /dev/null +++ b/docs/v2/orchestration/models/ScheduleRunErrorDict.md @@ -0,0 +1,13 @@ +# ScheduleRunErrorDict + +An error occurred attempting to run the schedule. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**errorName** | ScheduleRunErrorName | Yes | | +**description** | StrictStr | Yes | | +**type** | Literal["error"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScheduleRunErrorName.md b/docs/v2/orchestration/models/ScheduleRunErrorName.md new file mode 100644 index 00000000..e8c14463 --- /dev/null +++ b/docs/v2/orchestration/models/ScheduleRunErrorName.md @@ -0,0 +1,16 @@ +# ScheduleRunErrorName + +ScheduleRunErrorName + +| **Value** | +| --------- | +| `"TargetResolutionFailure"` | +| `"CyclicDependency"` | +| `"IncompatibleTargets"` | +| `"PermissionDenied"` | +| `"JobSpecNotFound"` | +| `"ScheduleOwnerNotFound"` | +| `"Internal"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScheduleRunIgnored.md b/docs/v2/orchestration/models/ScheduleRunIgnored.md new file mode 100644 index 00000000..7a347caf --- /dev/null +++ b/docs/v2/orchestration/models/ScheduleRunIgnored.md @@ -0,0 +1,12 @@ +# ScheduleRunIgnored + +The schedule is not running as all targets are up-to-date. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["ignored"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScheduleRunIgnoredDict.md b/docs/v2/orchestration/models/ScheduleRunIgnoredDict.md new file mode 100644 index 00000000..27787722 --- /dev/null +++ b/docs/v2/orchestration/models/ScheduleRunIgnoredDict.md @@ -0,0 +1,12 @@ +# ScheduleRunIgnoredDict + +The schedule is not running as all targets are up-to-date. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["ignored"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScheduleRunResult.md b/docs/v2/orchestration/models/ScheduleRunResult.md new file mode 100644 index 00000000..f780f213 --- /dev/null +++ b/docs/v2/orchestration/models/ScheduleRunResult.md @@ -0,0 +1,19 @@ +# ScheduleRunResult + +The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, +ignored if all targets are up-to-date or error. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ScheduleRunIgnored | ignored +ScheduleRunSubmitted | submitted +ScheduleRunError | error + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScheduleRunResultDict.md b/docs/v2/orchestration/models/ScheduleRunResultDict.md new file mode 100644 index 00000000..21fd258d --- /dev/null +++ b/docs/v2/orchestration/models/ScheduleRunResultDict.md @@ -0,0 +1,19 @@ +# ScheduleRunResultDict + +The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, +ignored if all targets are up-to-date or error. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ScheduleRunIgnoredDict | ignored +ScheduleRunSubmittedDict | submitted +ScheduleRunErrorDict | error + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScheduleRunRid.md b/docs/v2/orchestration/models/ScheduleRunRid.md new file mode 100644 index 00000000..05108882 --- /dev/null +++ b/docs/v2/orchestration/models/ScheduleRunRid.md @@ -0,0 +1,11 @@ +# ScheduleRunRid + +The RID of a schedule run + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScheduleRunSubmitted.md b/docs/v2/orchestration/models/ScheduleRunSubmitted.md new file mode 100644 index 00000000..fe43a08b --- /dev/null +++ b/docs/v2/orchestration/models/ScheduleRunSubmitted.md @@ -0,0 +1,12 @@ +# ScheduleRunSubmitted + +The schedule has been successfully triggered. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**build_rid** | BuildRid | Yes | | +**type** | Literal["submitted"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScheduleRunSubmittedDict.md b/docs/v2/orchestration/models/ScheduleRunSubmittedDict.md new file mode 100644 index 00000000..823a7229 --- /dev/null +++ b/docs/v2/orchestration/models/ScheduleRunSubmittedDict.md @@ -0,0 +1,12 @@ +# ScheduleRunSubmittedDict + +The schedule has been successfully triggered. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**buildRid** | BuildRid | Yes | | +**type** | Literal["submitted"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScheduleSucceededTrigger.md b/docs/v2/orchestration/models/ScheduleSucceededTrigger.md new file mode 100644 index 00000000..9bee6723 --- /dev/null +++ b/docs/v2/orchestration/models/ScheduleSucceededTrigger.md @@ -0,0 +1,14 @@ +# ScheduleSucceededTrigger + +Trigger whenever the specified schedule completes its action +successfully. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**schedule_rid** | ScheduleRid | Yes | | +**type** | Literal["scheduleSucceeded"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScheduleSucceededTriggerDict.md b/docs/v2/orchestration/models/ScheduleSucceededTriggerDict.md new file mode 100644 index 00000000..800975e8 --- /dev/null +++ b/docs/v2/orchestration/models/ScheduleSucceededTriggerDict.md @@ -0,0 +1,14 @@ +# ScheduleSucceededTriggerDict + +Trigger whenever the specified schedule completes its action +successfully. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**scheduleRid** | ScheduleRid | Yes | | +**type** | Literal["scheduleSucceeded"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScheduleVersionRid.md b/docs/v2/orchestration/models/ScheduleVersionRid.md new file mode 100644 index 00000000..d10d65f1 --- /dev/null +++ b/docs/v2/orchestration/models/ScheduleVersionRid.md @@ -0,0 +1,11 @@ +# ScheduleVersionRid + +The RID of a schedule version + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScopeMode.md b/docs/v2/orchestration/models/ScopeMode.md new file mode 100644 index 00000000..4e111829 --- /dev/null +++ b/docs/v2/orchestration/models/ScopeMode.md @@ -0,0 +1,16 @@ +# ScopeMode + +The boundaries for the schedule build. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ProjectScope | project +UserScope | user + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ScopeModeDict.md b/docs/v2/orchestration/models/ScopeModeDict.md new file mode 100644 index 00000000..12a35f72 --- /dev/null +++ b/docs/v2/orchestration/models/ScopeModeDict.md @@ -0,0 +1,16 @@ +# ScopeModeDict + +The boundaries for the schedule build. + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +ProjectScopeDict | project +UserScopeDict | user + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/TimeTrigger.md b/docs/v2/orchestration/models/TimeTrigger.md new file mode 100644 index 00000000..da2f5814 --- /dev/null +++ b/docs/v2/orchestration/models/TimeTrigger.md @@ -0,0 +1,13 @@ +# TimeTrigger + +Trigger on a time based schedule. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**cron_expression** | CronExpression | Yes | | +**time_zone** | ZoneId | Yes | | +**type** | Literal["time"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/TimeTriggerDict.md b/docs/v2/orchestration/models/TimeTriggerDict.md new file mode 100644 index 00000000..b5deee78 --- /dev/null +++ b/docs/v2/orchestration/models/TimeTriggerDict.md @@ -0,0 +1,13 @@ +# TimeTriggerDict + +Trigger on a time based schedule. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**cronExpression** | CronExpression | Yes | | +**timeZone** | ZoneId | Yes | | +**type** | Literal["time"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/Trigger.md b/docs/v2/orchestration/models/Trigger.md new file mode 100644 index 00000000..bec14f29 --- /dev/null +++ b/docs/v2/orchestration/models/Trigger.md @@ -0,0 +1,22 @@ +# Trigger + +Trigger + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +JobSucceededTrigger | jobSucceeded +OrTrigger | or +NewLogicTrigger | newLogic +AndTrigger | and +DatasetUpdatedTrigger | datasetUpdated +ScheduleSucceededTrigger | scheduleSucceeded +MediaSetUpdatedTrigger | mediaSetUpdated +TimeTrigger | time + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/TriggerDict.md b/docs/v2/orchestration/models/TriggerDict.md new file mode 100644 index 00000000..f8d0722d --- /dev/null +++ b/docs/v2/orchestration/models/TriggerDict.md @@ -0,0 +1,22 @@ +# TriggerDict + +Trigger + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +JobSucceededTriggerDict | jobSucceeded +OrTriggerDict | or +NewLogicTriggerDict | newLogic +AndTriggerDict | and +DatasetUpdatedTriggerDict | datasetUpdated +ScheduleSucceededTriggerDict | scheduleSucceeded +MediaSetUpdatedTriggerDict | mediaSetUpdated +TimeTriggerDict | time + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/UpstreamTarget.md b/docs/v2/orchestration/models/UpstreamTarget.md new file mode 100644 index 00000000..cd16d488 --- /dev/null +++ b/docs/v2/orchestration/models/UpstreamTarget.md @@ -0,0 +1,13 @@ +# UpstreamTarget + +Target the specified datasets along with all upstream datasets except the ignored datasets. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**dataset_rids** | List[DatasetRid] | Yes | The target datasets. | +**ignored_dataset_rids** | List[DatasetRid] | Yes | The datasets to ignore when calculating the final set of dataset to build. | +**type** | Literal["upstream"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/UpstreamTargetDict.md b/docs/v2/orchestration/models/UpstreamTargetDict.md new file mode 100644 index 00000000..59ef27d4 --- /dev/null +++ b/docs/v2/orchestration/models/UpstreamTargetDict.md @@ -0,0 +1,13 @@ +# UpstreamTargetDict + +Target the specified datasets along with all upstream datasets except the ignored datasets. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**datasetRids** | List[DatasetRid] | Yes | The target datasets. | +**ignoredDatasetRids** | List[DatasetRid] | Yes | The datasets to ignore when calculating the final set of dataset to build. | +**type** | Literal["upstream"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/UserScope.md b/docs/v2/orchestration/models/UserScope.md new file mode 100644 index 00000000..d4eca155 --- /dev/null +++ b/docs/v2/orchestration/models/UserScope.md @@ -0,0 +1,13 @@ +# UserScope + +When triggered, the schedule will build all resources that the +associated user is permitted to build. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["user"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/UserScopeDict.md b/docs/v2/orchestration/models/UserScopeDict.md new file mode 100644 index 00000000..e65c15e5 --- /dev/null +++ b/docs/v2/orchestration/models/UserScopeDict.md @@ -0,0 +1,13 @@ +# UserScopeDict + +When triggered, the schedule will build all resources that the +associated user is permitted to build. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["user"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ZoneId.md b/docs/v2/orchestration/models/ZoneId.md new file mode 100644 index 00000000..bbdc971a --- /dev/null +++ b/docs/v2/orchestration/models/ZoneId.md @@ -0,0 +1,11 @@ +# ZoneId + +A string representation of a java.time.ZoneId + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/third_party_applications/models/ListVersionsResponse.md b/docs/v2/third_party_applications/models/ListVersionsResponse.md new file mode 100644 index 00000000..48e6eefe --- /dev/null +++ b/docs/v2/third_party_applications/models/ListVersionsResponse.md @@ -0,0 +1,12 @@ +# ListVersionsResponse + +ListVersionsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[Version] | Yes | | +**next_page_token** | Optional[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/third_party_applications/models/ListVersionsResponseDict.md b/docs/v2/third_party_applications/models/ListVersionsResponseDict.md new file mode 100644 index 00000000..6b6ed9c0 --- /dev/null +++ b/docs/v2/third_party_applications/models/ListVersionsResponseDict.md @@ -0,0 +1,12 @@ +# ListVersionsResponseDict + +ListVersionsResponse + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**data** | List[VersionDict] | Yes | | +**nextPageToken** | NotRequired[PageToken] | No | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/third_party_applications/models/Subdomain.md b/docs/v2/third_party_applications/models/Subdomain.md new file mode 100644 index 00000000..fdbd566b --- /dev/null +++ b/docs/v2/third_party_applications/models/Subdomain.md @@ -0,0 +1,11 @@ +# Subdomain + +A subdomain from which a website is served. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/third_party_applications/models/ThirdPartyApplication.md b/docs/v2/third_party_applications/models/ThirdPartyApplication.md new file mode 100644 index 00000000..9e347d0a --- /dev/null +++ b/docs/v2/third_party_applications/models/ThirdPartyApplication.md @@ -0,0 +1,11 @@ +# ThirdPartyApplication + +ThirdPartyApplication + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | ThirdPartyApplicationRid | Yes | An RID identifying a third-party application created in Developer Console. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/third_party_applications/models/ThirdPartyApplicationDict.md b/docs/v2/third_party_applications/models/ThirdPartyApplicationDict.md new file mode 100644 index 00000000..bed2fca7 --- /dev/null +++ b/docs/v2/third_party_applications/models/ThirdPartyApplicationDict.md @@ -0,0 +1,11 @@ +# ThirdPartyApplicationDict + +ThirdPartyApplication + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | ThirdPartyApplicationRid | Yes | An RID identifying a third-party application created in Developer Console. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/third_party_applications/models/ThirdPartyApplicationRid.md b/docs/v2/third_party_applications/models/ThirdPartyApplicationRid.md new file mode 100644 index 00000000..a8e9754f --- /dev/null +++ b/docs/v2/third_party_applications/models/ThirdPartyApplicationRid.md @@ -0,0 +1,11 @@ +# ThirdPartyApplicationRid + +An RID identifying a third-party application created in Developer Console. + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/third_party_applications/models/Version.md b/docs/v2/third_party_applications/models/Version.md new file mode 100644 index 00000000..6048048b --- /dev/null +++ b/docs/v2/third_party_applications/models/Version.md @@ -0,0 +1,11 @@ +# Version + +Version + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**version** | VersionVersion | Yes | The semantic version of the Website. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/third_party_applications/models/VersionDict.md b/docs/v2/third_party_applications/models/VersionDict.md new file mode 100644 index 00000000..6ebdfef3 --- /dev/null +++ b/docs/v2/third_party_applications/models/VersionDict.md @@ -0,0 +1,11 @@ +# VersionDict + +Version + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**version** | VersionVersion | Yes | The semantic version of the Website. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/third_party_applications/models/VersionVersion.md b/docs/v2/third_party_applications/models/VersionVersion.md new file mode 100644 index 00000000..d4236383 --- /dev/null +++ b/docs/v2/third_party_applications/models/VersionVersion.md @@ -0,0 +1,11 @@ +# VersionVersion + +The semantic version of the Website. + +## Type +```python +StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/third_party_applications/models/Website.md b/docs/v2/third_party_applications/models/Website.md new file mode 100644 index 00000000..d247582a --- /dev/null +++ b/docs/v2/third_party_applications/models/Website.md @@ -0,0 +1,12 @@ +# Website + +Website + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**deployed_version** | Optional[VersionVersion] | No | The version of the Website that is currently deployed. | +**subdomains** | List[Subdomain] | Yes | The subdomains from which the Website is currently served. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/third_party_applications/models/WebsiteDict.md b/docs/v2/third_party_applications/models/WebsiteDict.md new file mode 100644 index 00000000..c656ff2e --- /dev/null +++ b/docs/v2/third_party_applications/models/WebsiteDict.md @@ -0,0 +1,12 @@ +# WebsiteDict + +Website + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**deployedVersion** | NotRequired[VersionVersion] | No | The version of the Website that is currently deployed. | +**subdomains** | List[Subdomain] | Yes | The subdomains from which the Website is currently served. | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/foundry/_core/__init__.py b/foundry/_core/__init__.py index 13257254..8eb2143b 100644 --- a/foundry/_core/__init__.py +++ b/foundry/_core/__init__.py @@ -13,4 +13,7 @@ # limitations under the License. +from foundry._core.api_client import ApiClient +from foundry._core.api_client import RequestInfo +from foundry._core.auth_utils import Auth from foundry._core.resource_iterator import ResourceIterator diff --git a/foundry/api_client.py b/foundry/_core/api_client.py similarity index 88% rename from foundry/api_client.py rename to foundry/_core/api_client.py index f01d1e6e..46972528 100644 --- a/foundry/api_client.py +++ b/foundry/_core/api_client.py @@ -41,6 +41,9 @@ QueryParameters = Dict[str, Union[Any, List[Any]]] +_TYPE_ADAPTERS: Dict[Any, Any] = {} + + @dataclass(frozen=True) class RequestInfo: method: str @@ -169,16 +172,15 @@ def _serialize(self, value: Any, value_type: Any) -> Optional[bytes]: elif value_type is None: return None + json_bytes: bytes if value_type is Any: json_bytes = json.dumps(value).encode() else: - self._ensure_type_adapter(value_type) + type_adapter = self._get_type_adapter(value_type) # Use "exclude_unset" to remove optional inputs that weren't explicitely set # Use "by_alias" to use the expected field name rather than the class property name - json_bytes: bytes = value_type.type_adapter.dump_json( - value, exclude_unset=True, by_alias=True - ) + json_bytes = type_adapter.dump_json(value, exclude_unset=True, by_alias=True) return json_bytes @@ -202,17 +204,17 @@ def _deserialize(self, res: Response, response_type: Any) -> Any: if response_type is Any: return data - self._ensure_type_adapter(response_type) - return response_type.type_adapter.validate_python(data) + type_adapter = self._get_type_adapter(response_type) + return type_adapter.validate_python(data) @staticmethod - def _ensure_type_adapter(_type: Any): - if hasattr(_type, "type_adapter"): - return - - if isclass(_type) and issubclass(_type, BaseModel): - _type.type_adapter = _BaseModelTypeAdapter(_type) # type: ignore - else: - # Create an instance of a type adapter. This has a non-trivial overhead according - # to the documentation so we do this once the first time we encounter this type - object.__setattr__(_type, "type_adapter", TypeAdapter(_type)) + def _get_type_adapter(_type: Any): + if _type not in _TYPE_ADAPTERS: + if isclass(_type) and issubclass(_type, BaseModel): + _TYPE_ADAPTERS[_type] = _BaseModelTypeAdapter(_type) # type: ignore + else: + # Create an instance of a type adapter. This has a non-trivial overhead according + # to the documentation so we do this once the first time we encounter this type + _TYPE_ADAPTERS[_type] = TypeAdapter(_type) + + return _TYPE_ADAPTERS[_type] diff --git a/foundry/_core/auth_utils.py b/foundry/_core/auth_utils.py index 4e1485cf..8ce02d4a 100644 --- a/foundry/_core/auth_utils.py +++ b/foundry/_core/auth_utils.py @@ -22,6 +22,7 @@ class Token(ABC): + @property @abstractmethod def access_token(self) -> str: @@ -29,6 +30,7 @@ def access_token(self) -> str: class Auth(ABC): + @abstractmethod def get_token(self) -> "Token": pass diff --git a/foundry/_core/confidential_client_auth.py b/foundry/_core/confidential_client_auth.py index a1774bd4..9d9da03c 100644 --- a/foundry/_core/confidential_client_auth.py +++ b/foundry/_core/confidential_client_auth.py @@ -26,6 +26,7 @@ from foundry._core.oauth import SignOutResponse from foundry._core.oauth_utils import ConfidentialClientOAuthFlowProvider from foundry._core.oauth_utils import OAuthToken +from foundry._core.utils import remove_prefixes from foundry._errors.environment_not_configured import EnvironmentNotConfigured from foundry._errors.not_authenticated import NotAuthenticated @@ -101,7 +102,7 @@ def _run_with_attempted_refresh(self, func: Callable[[OAuthToken], T]) -> T: @property def url(self): - return self._hostname.removeprefix("https://").removeprefix("http://") + return remove_prefixes(self._hostname, ["https://", "http://"]) def _refresh_token(self): self._token = self._server_oauth_flow_provider.get_token() diff --git a/foundry/_core/foundry_token_auth_client.py b/foundry/_core/foundry_token_auth_client.py index 2fadcbf8..dbdb482e 100644 --- a/foundry/_core/foundry_token_auth_client.py +++ b/foundry/_core/foundry_token_auth_client.py @@ -27,6 +27,7 @@ class _UserToken(Token): + def __init__(self, token: str) -> None: self._token = token diff --git a/foundry/_core/page_iterator.py b/foundry/_core/page_iterator.py index 40f3cf81..91692bd2 100644 --- a/foundry/_core/page_iterator.py +++ b/foundry/_core/page_iterator.py @@ -26,8 +26,7 @@ class PageFunction(Generic[T], Protocol): def __call__( self, page_size: Optional[int], next_page_token: Optional[str] - ) -> Tuple[Optional[str], List[T]]: - ... + ) -> Tuple[Optional[str], List[T]]: ... class PageIterator(Generic[T]): diff --git a/foundry/_core/palantir_session.py b/foundry/_core/palantir_session.py index fb717844..1ae5de48 100644 --- a/foundry/_core/palantir_session.py +++ b/foundry/_core/palantir_session.py @@ -26,6 +26,7 @@ from foundry._core.auth_utils import Auth from foundry._core.auth_utils import Token +from foundry._core.utils import remove_prefixes def _run_with_401_status_check( @@ -53,7 +54,7 @@ class PalantirSession: def __init__(self, auth: Auth, hostname: str, preview: bool = False) -> None: self._auth = auth - self._hostname = hostname.removeprefix("https://").removeprefix("http://") + self._hostname = remove_prefixes(hostname, ["https://", "http://"]) self.preview = preview self._session = requests.Session() @@ -201,4 +202,4 @@ def _add_user_agent_and_auth_headers( } def _remove_host_prefix(self, url: str) -> str: - return url.removeprefix("https://").removeprefix("http://") + return remove_prefixes(url, ["https://", "http://"]) diff --git a/foundry/_core/public_client_auth.py b/foundry/_core/public_client_auth.py index 0e4fd1e2..7174fa49 100644 --- a/foundry/_core/public_client_auth.py +++ b/foundry/_core/public_client_auth.py @@ -28,6 +28,7 @@ from foundry._core.oauth_utils import AuthorizeRequest from foundry._core.oauth_utils import OAuthToken from foundry._core.oauth_utils import PublicClientOAuthFlowProvider +from foundry._core.utils import remove_prefixes from foundry._errors.not_authenticated import NotAuthenticated from foundry._errors.sdk_internal_error import SDKInternalError @@ -105,7 +106,7 @@ def _run_with_attempted_refresh(self, func: Callable[[OAuthToken], T]) -> T: @property def url(self): - return self._hostname.removeprefix("https://").removeprefix("http://") + return remove_prefixes(self._hostname, ["https://", "http://"]) def sign_in(self) -> None: self._auth_request = self._server_oauth_flow_provider.generate_auth_request() diff --git a/foundry/_core/resource_iterator.py b/foundry/_core/resource_iterator.py index 602fc106..d4b6b18d 100644 --- a/foundry/_core/resource_iterator.py +++ b/foundry/_core/resource_iterator.py @@ -14,6 +14,7 @@ from typing import Generic +from typing import List from typing import Optional from typing import TypeVar @@ -28,7 +29,7 @@ class ResourceIterator(Generic[T]): def __init__(self, paged_func: PageFunction[T], page_size: Optional[int] = None) -> None: self._page_iterator = PageIterator(paged_func, page_size) - self._data = [] + self._data: List[T] = [] self._index = 0 @property diff --git a/foundry/_core/utils.py b/foundry/_core/utils.py index 0b1d36cd..6e8d573e 100644 --- a/foundry/_core/utils.py +++ b/foundry/_core/utils.py @@ -13,10 +13,11 @@ # limitations under the License. -from typing import Annotated +from typing import List from pydantic import StrictStr from pydantic import StringConstraints +from typing_extensions import Annotated RID = Annotated[ StrictStr, @@ -32,3 +33,10 @@ pattern=r"^[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}$", ), ] + + +def remove_prefixes(text: str, prefixes: List[str]): + for prefix in prefixes: + if text.startswith(prefix): + text = text[len(prefix) :] + return text diff --git a/foundry/_errors/helpers.py b/foundry/_errors/helpers.py index 0a8f02a2..0502cd86 100644 --- a/foundry/_errors/helpers.py +++ b/foundry/_errors/helpers.py @@ -19,8 +19,6 @@ from typing import Any from typing import Dict -import requests - def format_error_message(fields: Dict[str, Any]) -> str: return json.dumps(fields, sort_keys=True, indent=4) diff --git a/foundry/_versions.py b/foundry/_versions.py index 74115456..74331455 100644 --- a/foundry/_versions.py +++ b/foundry/_versions.py @@ -17,4 +17,4 @@ # using the autorelease bot __version__ = "0.0.0" -__openapi_document_version__ = "1.921.0" +__openapi_document_version__ = "1.926.0" diff --git a/foundry/v1/__init__.py b/foundry/v1/__init__.py index e5b9d88d..6a6f8047 100644 --- a/foundry/v1/__init__.py +++ b/foundry/v1/__init__.py @@ -13,8 +13,8 @@ # limitations under the License. -from foundry.v1.foundry_client import FoundryV1Client +from foundry.v1.client import FoundryClient __all__ = [ - "FoundryV1Client", + "FoundryClient", ] diff --git a/foundry/v1/_namespaces/datasets/branch.py b/foundry/v1/_namespaces/datasets/branch.py deleted file mode 100644 index f55a7cb5..00000000 --- a/foundry/v1/_namespaces/datasets/branch.py +++ /dev/null @@ -1,290 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v1.models._branch import Branch -from foundry.v1.models._branch_id import BranchId -from foundry.v1.models._create_branch_request import CreateBranchRequest -from foundry.v1.models._create_branch_request_dict import CreateBranchRequestDict -from foundry.v1.models._dataset_rid import DatasetRid -from foundry.v1.models._list_branches_response import ListBranchesResponse -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken - - -class BranchResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def create( - self, - dataset_rid: DatasetRid, - create_branch_request: Union[CreateBranchRequest, CreateBranchRequestDict], - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Branch: - """ - Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param create_branch_request: Body of the request - :type create_branch_request: Union[CreateBranchRequest, CreateBranchRequestDict] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Branch - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = create_branch_request - - _path_params["datasetRid"] = dataset_rid - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v1/datasets/{datasetRid}/branches", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[CreateBranchRequest, CreateBranchRequestDict], - response_type=Branch, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def delete( - self, - dataset_rid: DatasetRid, - branch_id: BranchId, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> None: - """ - Deletes the Branch with the given BranchId. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param branch_id: branchId - :type branch_id: BranchId - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["datasetRid"] = dataset_rid - - _path_params["branchId"] = branch_id - - return self._api_client.call_api( - RequestInfo( - method="DELETE", - resource_path="/v1/datasets/{datasetRid}/branches/{branchId}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=None, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - dataset_rid: DatasetRid, - branch_id: BranchId, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Branch: - """ - Get a Branch of a Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param branch_id: branchId - :type branch_id: BranchId - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Branch - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["datasetRid"] = dataset_rid - - _path_params["branchId"] = branch_id - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/datasets/{datasetRid}/branches/{branchId}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Branch, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - dataset_rid: DatasetRid, - *, - page_size: Optional[PageSize] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[Branch]: - """ - Lists the Branches of a Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[Branch] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _path_params["datasetRid"] = dataset_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v1/datasets/{datasetRid}/branches", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListBranchesResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - dataset_rid: DatasetRid, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListBranchesResponse: - """ - Lists the Branches of a Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListBranchesResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _path_params["datasetRid"] = dataset_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/datasets/{datasetRid}/branches", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListBranchesResponse, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v1/_namespaces/datasets/dataset.py b/foundry/v1/_namespaces/datasets/dataset.py deleted file mode 100644 index 57e49db2..00000000 --- a/foundry/v1/_namespaces/datasets/dataset.py +++ /dev/null @@ -1,379 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import List -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import StrictStr -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v1._namespaces.datasets.branch import BranchResource -from foundry.v1._namespaces.datasets.file import FileResource -from foundry.v1._namespaces.datasets.transaction import TransactionResource -from foundry.v1.models._branch_id import BranchId -from foundry.v1.models._create_dataset_request import CreateDatasetRequest -from foundry.v1.models._create_dataset_request_dict import CreateDatasetRequestDict -from foundry.v1.models._dataset import Dataset -from foundry.v1.models._dataset_rid import DatasetRid -from foundry.v1.models._preview_mode import PreviewMode -from foundry.v1.models._table_export_format import TableExportFormat -from foundry.v1.models._transaction_rid import TransactionRid - - -class DatasetResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - self.Branch = BranchResource(api_client=api_client) - self.File = FileResource(api_client=api_client) - self.Transaction = TransactionResource(api_client=api_client) - - @validate_call - @handle_unexpected - def create( - self, - create_dataset_request: Union[CreateDatasetRequest, CreateDatasetRequestDict], - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Dataset: - """ - Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - :param create_dataset_request: Body of the request - :type create_dataset_request: Union[CreateDatasetRequest, CreateDatasetRequestDict] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Dataset - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = create_dataset_request - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v1/datasets", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[CreateDatasetRequest, CreateDatasetRequestDict], - response_type=Dataset, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def delete_schema( - self, - dataset_rid: DatasetRid, - *, - branch_id: Optional[BranchId] = None, - preview: Optional[PreviewMode] = None, - transaction_rid: Optional[TransactionRid] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> None: - """ - Deletes the Schema from a Dataset and Branch. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param branch_id: branchId - :type branch_id: Optional[BranchId] - :param preview: preview - :type preview: Optional[PreviewMode] - :param transaction_rid: transactionRid - :type transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["branchId"] = branch_id - - _query_params["preview"] = preview - - _query_params["transactionRid"] = transaction_rid - - _path_params["datasetRid"] = dataset_rid - - return self._api_client.call_api( - RequestInfo( - method="DELETE", - resource_path="/v1/datasets/{datasetRid}/schema", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=None, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - dataset_rid: DatasetRid, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Dataset: - """ - Gets the Dataset with the given DatasetRid. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Dataset - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["datasetRid"] = dataset_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/datasets/{datasetRid}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Dataset, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get_schema( - self, - dataset_rid: DatasetRid, - *, - branch_id: Optional[BranchId] = None, - preview: Optional[PreviewMode] = None, - transaction_rid: Optional[TransactionRid] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Any: - """ - Retrieves the Schema for a Dataset and Branch, if it exists. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param branch_id: branchId - :type branch_id: Optional[BranchId] - :param preview: preview - :type preview: Optional[PreviewMode] - :param transaction_rid: transactionRid - :type transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Any - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["branchId"] = branch_id - - _query_params["preview"] = preview - - _query_params["transactionRid"] = transaction_rid - - _path_params["datasetRid"] = dataset_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/datasets/{datasetRid}/schema", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Any, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def read( - self, - dataset_rid: DatasetRid, - *, - format: TableExportFormat, - branch_id: Optional[BranchId] = None, - columns: Optional[List[StrictStr]] = None, - end_transaction_rid: Optional[TransactionRid] = None, - row_limit: Optional[StrictInt] = None, - start_transaction_rid: Optional[TransactionRid] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> bytes: - """ - Gets the content of a dataset as a table in the specified format. - - This endpoint currently does not support views (Virtual datasets composed of other datasets). - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param format: format - :type format: TableExportFormat - :param branch_id: branchId - :type branch_id: Optional[BranchId] - :param columns: columns - :type columns: Optional[List[StrictStr]] - :param end_transaction_rid: endTransactionRid - :type end_transaction_rid: Optional[TransactionRid] - :param row_limit: rowLimit - :type row_limit: Optional[StrictInt] - :param start_transaction_rid: startTransactionRid - :type start_transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: bytes - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["format"] = format - - _query_params["branchId"] = branch_id - - _query_params["columns"] = columns - - _query_params["endTransactionRid"] = end_transaction_rid - - _query_params["rowLimit"] = row_limit - - _query_params["startTransactionRid"] = start_transaction_rid - - _path_params["datasetRid"] = dataset_rid - - _header_params["Accept"] = "*/*" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/datasets/{datasetRid}/readTable", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=bytes, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def replace_schema( - self, - dataset_rid: DatasetRid, - body: Any, - *, - branch_id: Optional[BranchId] = None, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> None: - """ - Puts a Schema on an existing Dataset and Branch. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param body: Body of the request - :type body: Any - :param branch_id: branchId - :type branch_id: Optional[BranchId] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = body - _query_params["branchId"] = branch_id - - _query_params["preview"] = preview - - _path_params["datasetRid"] = dataset_rid - - _header_params["Content-Type"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="PUT", - resource_path="/v1/datasets/{datasetRid}/schema", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Any, - response_type=None, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v1/_namespaces/datasets/file.py b/foundry/v1/_namespaces/datasets/file.py deleted file mode 100644 index 1514df82..00000000 --- a/foundry/v1/_namespaces/datasets/file.py +++ /dev/null @@ -1,544 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v1.models._branch_id import BranchId -from foundry.v1.models._dataset_rid import DatasetRid -from foundry.v1.models._file import File -from foundry.v1.models._file_path import FilePath -from foundry.v1.models._list_files_response import ListFilesResponse -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._transaction_rid import TransactionRid -from foundry.v1.models._transaction_type import TransactionType - - -class FileResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def delete( - self, - dataset_rid: DatasetRid, - file_path: FilePath, - *, - branch_id: Optional[BranchId] = None, - transaction_rid: Optional[TransactionRid] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> None: - """ - Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default - branch - `master` for most enrollments. The file will still be visible on historical views. - - #### Advanced Usage - - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - - To **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction - will be created and committed on this branch. - - To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier - as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a - single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to - open a transaction. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param file_path: filePath - :type file_path: FilePath - :param branch_id: branchId - :type branch_id: Optional[BranchId] - :param transaction_rid: transactionRid - :type transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["branchId"] = branch_id - - _query_params["transactionRid"] = transaction_rid - - _path_params["datasetRid"] = dataset_rid - - _path_params["filePath"] = file_path - - return self._api_client.call_api( - RequestInfo( - method="DELETE", - resource_path="/v1/datasets/{datasetRid}/files/{filePath}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=None, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - dataset_rid: DatasetRid, - file_path: FilePath, - *, - branch_id: Optional[BranchId] = None, - end_transaction_rid: Optional[TransactionRid] = None, - start_transaction_rid: Optional[TransactionRid] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> File: - """ - Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest - view of the default branch - `master` for most enrollments. - - #### Advanced Usage - - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - - To **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will - retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest - ancestor transaction of the branch if there are no snapshot transactions. - - To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier - as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot - transaction, or the earliest ancestor transaction if there are no snapshot transactions. - - To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's - resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. - This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the - `endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path. - - To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the - `startTransactionRid` and `endTransactionRid`. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param file_path: filePath - :type file_path: FilePath - :param branch_id: branchId - :type branch_id: Optional[BranchId] - :param end_transaction_rid: endTransactionRid - :type end_transaction_rid: Optional[TransactionRid] - :param start_transaction_rid: startTransactionRid - :type start_transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: File - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["branchId"] = branch_id - - _query_params["endTransactionRid"] = end_transaction_rid - - _query_params["startTransactionRid"] = start_transaction_rid - - _path_params["datasetRid"] = dataset_rid - - _path_params["filePath"] = file_path - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/datasets/{datasetRid}/files/{filePath}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=File, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - dataset_rid: DatasetRid, - *, - branch_id: Optional[BranchId] = None, - end_transaction_rid: Optional[TransactionRid] = None, - page_size: Optional[PageSize] = None, - start_transaction_rid: Optional[TransactionRid] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[File]: - """ - Lists Files contained in a Dataset. By default files are listed on the latest view of the default - branch - `master` for most enrollments. - - #### Advanced Usage - - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - - To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most - recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the - branch if there are no snapshot transactions. - - To **list files on the resolved view of a transaction** specify the Transaction's resource identifier - as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot - transaction, or the earliest ancestor transaction if there are no snapshot transactions. - - To **list files on the resolved view of a range of transactions** specify the the start transaction's resource - identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This - will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. - Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when - the start and end transactions do not belong to the same root-to-leaf path. - - To **list files on a specific transaction** specify the Transaction's resource identifier as both the - `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that - Transaction. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param branch_id: branchId - :type branch_id: Optional[BranchId] - :param end_transaction_rid: endTransactionRid - :type end_transaction_rid: Optional[TransactionRid] - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param start_transaction_rid: startTransactionRid - :type start_transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[File] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["branchId"] = branch_id - - _query_params["endTransactionRid"] = end_transaction_rid - - _query_params["pageSize"] = page_size - - _query_params["startTransactionRid"] = start_transaction_rid - - _path_params["datasetRid"] = dataset_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v1/datasets/{datasetRid}/files", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListFilesResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - dataset_rid: DatasetRid, - *, - branch_id: Optional[BranchId] = None, - end_transaction_rid: Optional[TransactionRid] = None, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - start_transaction_rid: Optional[TransactionRid] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListFilesResponse: - """ - Lists Files contained in a Dataset. By default files are listed on the latest view of the default - branch - `master` for most enrollments. - - #### Advanced Usage - - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - - To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most - recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the - branch if there are no snapshot transactions. - - To **list files on the resolved view of a transaction** specify the Transaction's resource identifier - as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot - transaction, or the earliest ancestor transaction if there are no snapshot transactions. - - To **list files on the resolved view of a range of transactions** specify the the start transaction's resource - identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This - will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. - Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when - the start and end transactions do not belong to the same root-to-leaf path. - - To **list files on a specific transaction** specify the Transaction's resource identifier as both the - `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that - Transaction. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param branch_id: branchId - :type branch_id: Optional[BranchId] - :param end_transaction_rid: endTransactionRid - :type end_transaction_rid: Optional[TransactionRid] - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param start_transaction_rid: startTransactionRid - :type start_transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListFilesResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["branchId"] = branch_id - - _query_params["endTransactionRid"] = end_transaction_rid - - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _query_params["startTransactionRid"] = start_transaction_rid - - _path_params["datasetRid"] = dataset_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/datasets/{datasetRid}/files", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListFilesResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def read( - self, - dataset_rid: DatasetRid, - file_path: FilePath, - *, - branch_id: Optional[BranchId] = None, - end_transaction_rid: Optional[TransactionRid] = None, - start_transaction_rid: Optional[TransactionRid] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> bytes: - """ - Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest - view of the default branch - `master` for most enrollments. - - #### Advanced Usage - - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - - To **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will - retrieve the content for the most recent version of the file since the latest snapshot transaction, or the - earliest ancestor transaction of the branch if there are no snapshot transactions. - - To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier - as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest - snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions. - - To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's - resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. - This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the - `endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior - is undefined when the start and end transactions do not belong to the same root-to-leaf path. - - To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the - `startTransactionRid` and `endTransactionRid`. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param file_path: filePath - :type file_path: FilePath - :param branch_id: branchId - :type branch_id: Optional[BranchId] - :param end_transaction_rid: endTransactionRid - :type end_transaction_rid: Optional[TransactionRid] - :param start_transaction_rid: startTransactionRid - :type start_transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: bytes - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["branchId"] = branch_id - - _query_params["endTransactionRid"] = end_transaction_rid - - _query_params["startTransactionRid"] = start_transaction_rid - - _path_params["datasetRid"] = dataset_rid - - _path_params["filePath"] = file_path - - _header_params["Accept"] = "*/*" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/datasets/{datasetRid}/files/{filePath}/content", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=bytes, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def upload( - self, - dataset_rid: DatasetRid, - body: bytes, - *, - file_path: FilePath, - branch_id: Optional[BranchId] = None, - transaction_rid: Optional[TransactionRid] = None, - transaction_type: Optional[TransactionType] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> File: - """ - Uploads a File to an existing Dataset. - The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. - - By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments. - If the file already exists only the most recent version will be visible in the updated view. - - #### Advanced Usage - - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - - To **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will - be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this - default specify `transactionType` in addition to `branchId`. - See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. - - To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as - `transactionRid`. This is useful for uploading multiple files in a single transaction. - See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param body: Body of the request - :type body: bytes - :param file_path: filePath - :type file_path: FilePath - :param branch_id: branchId - :type branch_id: Optional[BranchId] - :param transaction_rid: transactionRid - :type transaction_rid: Optional[TransactionRid] - :param transaction_type: transactionType - :type transaction_type: Optional[TransactionType] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: File - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = body - _query_params["filePath"] = file_path - - _query_params["branchId"] = branch_id - - _query_params["transactionRid"] = transaction_rid - - _query_params["transactionType"] = transaction_type - - _path_params["datasetRid"] = dataset_rid - - _header_params["Content-Type"] = "*/*" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v1/datasets/{datasetRid}/files:upload", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=bytes, - response_type=File, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v1/_namespaces/datasets/transaction.py b/foundry/v1/_namespaces/datasets/transaction.py deleted file mode 100644 index 01dcdb6b..00000000 --- a/foundry/v1/_namespaces/datasets/transaction.py +++ /dev/null @@ -1,243 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v1.models._branch_id import BranchId -from foundry.v1.models._create_transaction_request import CreateTransactionRequest -from foundry.v1.models._create_transaction_request_dict import CreateTransactionRequestDict # NOQA -from foundry.v1.models._dataset_rid import DatasetRid -from foundry.v1.models._transaction import Transaction -from foundry.v1.models._transaction_rid import TransactionRid - - -class TransactionResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def abort( - self, - dataset_rid: DatasetRid, - transaction_rid: TransactionRid, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Transaction: - """ - Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is - not updated. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param transaction_rid: transactionRid - :type transaction_rid: TransactionRid - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Transaction - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["datasetRid"] = dataset_rid - - _path_params["transactionRid"] = transaction_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v1/datasets/{datasetRid}/transactions/{transactionRid}/abort", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Transaction, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def commit( - self, - dataset_rid: DatasetRid, - transaction_rid: TransactionRid, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Transaction: - """ - Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is - updated to point to the Transaction. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param transaction_rid: transactionRid - :type transaction_rid: TransactionRid - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Transaction - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["datasetRid"] = dataset_rid - - _path_params["transactionRid"] = transaction_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v1/datasets/{datasetRid}/transactions/{transactionRid}/commit", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Transaction, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def create( - self, - dataset_rid: DatasetRid, - create_transaction_request: Union[CreateTransactionRequest, CreateTransactionRequestDict], - *, - branch_id: Optional[BranchId] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Transaction: - """ - Creates a Transaction on a Branch of a Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param create_transaction_request: Body of the request - :type create_transaction_request: Union[CreateTransactionRequest, CreateTransactionRequestDict] - :param branch_id: branchId - :type branch_id: Optional[BranchId] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Transaction - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = create_transaction_request - _query_params["branchId"] = branch_id - - _path_params["datasetRid"] = dataset_rid - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v1/datasets/{datasetRid}/transactions", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[CreateTransactionRequest, CreateTransactionRequestDict], - response_type=Transaction, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - dataset_rid: DatasetRid, - transaction_rid: TransactionRid, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Transaction: - """ - Gets a Transaction of a Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param transaction_rid: transactionRid - :type transaction_rid: TransactionRid - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Transaction - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["datasetRid"] = dataset_rid - - _path_params["transactionRid"] = transaction_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/datasets/{datasetRid}/transactions/{transactionRid}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Transaction, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v1/_namespaces/namespaces.py b/foundry/v1/_namespaces/namespaces.py deleted file mode 100644 index 0d4f2e87..00000000 --- a/foundry/v1/_namespaces/namespaces.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.api_client import ApiClient -from foundry.v1._namespaces.datasets.dataset import DatasetResource -from foundry.v1._namespaces.ontologies.action import ActionResource -from foundry.v1._namespaces.ontologies.ontology import OntologyResource -from foundry.v1._namespaces.ontologies.ontology_object import OntologyObjectResource -from foundry.v1._namespaces.ontologies.query import QueryResource - - -class Datasets: - def __init__(self, api_client: ApiClient): - self.Dataset = DatasetResource(api_client=api_client) - - -class Ontologies: - def __init__(self, api_client: ApiClient): - self.Action = ActionResource(api_client=api_client) - self.Ontology = OntologyResource(api_client=api_client) - self.OntologyObject = OntologyObjectResource(api_client=api_client) - self.Query = QueryResource(api_client=api_client) diff --git a/foundry/v1/_namespaces/ontologies/action.py b/foundry/v1/_namespaces/ontologies/action.py deleted file mode 100644 index d12871f2..00000000 --- a/foundry/v1/_namespaces/ontologies/action.py +++ /dev/null @@ -1,228 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v1.models._action_type_api_name import ActionTypeApiName -from foundry.v1.models._apply_action_request import ApplyActionRequest -from foundry.v1.models._apply_action_request_dict import ApplyActionRequestDict -from foundry.v1.models._apply_action_response import ApplyActionResponse -from foundry.v1.models._batch_apply_action_request import BatchApplyActionRequest -from foundry.v1.models._batch_apply_action_request_dict import BatchApplyActionRequestDict # NOQA -from foundry.v1.models._batch_apply_action_response import BatchApplyActionResponse -from foundry.v1.models._ontology_rid import OntologyRid -from foundry.v1.models._validate_action_request import ValidateActionRequest -from foundry.v1.models._validate_action_request_dict import ValidateActionRequestDict -from foundry.v1.models._validate_action_response import ValidateActionResponse - - -class ActionResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def apply( - self, - ontology_rid: OntologyRid, - action_type: ActionTypeApiName, - apply_action_request: Union[ApplyActionRequest, ApplyActionRequestDict], - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ApplyActionResponse: - """ - Applies an action using the given parameters. Changes to the Ontology are eventually consistent and may take - some time to be visible. - - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by - this endpoint. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read api:ontologies-write`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param action_type: actionType - :type action_type: ActionTypeApiName - :param apply_action_request: Body of the request - :type apply_action_request: Union[ApplyActionRequest, ApplyActionRequestDict] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ApplyActionResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = apply_action_request - - _path_params["ontologyRid"] = ontology_rid - - _path_params["actionType"] = action_type - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v1/ontologies/{ontologyRid}/actions/{actionType}/apply", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[ApplyActionRequest, ApplyActionRequestDict], - response_type=ApplyActionResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def apply_batch( - self, - ontology_rid: OntologyRid, - action_type: ActionTypeApiName, - batch_apply_action_request: Union[BatchApplyActionRequest, BatchApplyActionRequestDict], - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> BatchApplyActionResponse: - """ - Applies multiple actions (of the same Action Type) using the given parameters. - Changes to the Ontology are eventually consistent and may take some time to be visible. - - Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not - call Functions may receive a higher limit. - - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) and - [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read api:ontologies-write`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param action_type: actionType - :type action_type: ActionTypeApiName - :param batch_apply_action_request: Body of the request - :type batch_apply_action_request: Union[BatchApplyActionRequest, BatchApplyActionRequestDict] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: BatchApplyActionResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = batch_apply_action_request - - _path_params["ontologyRid"] = ontology_rid - - _path_params["actionType"] = action_type - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[BatchApplyActionRequest, BatchApplyActionRequestDict], - response_type=BatchApplyActionResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def validate( - self, - ontology_rid: OntologyRid, - action_type: ActionTypeApiName, - validate_action_request: Union[ValidateActionRequest, ValidateActionRequestDict], - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ValidateActionResponse: - """ - Validates if an action can be run with the given set of parameters. - The response contains the evaluation of parameters and **submission criteria** - that determine if the request is `VALID` or `INVALID`. - For performance reasons, validations will not consider existing objects or other data in Foundry. - For example, the uniqueness of a primary key or the existence of a user ID will not be checked. - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by - this endpoint. Unspecified parameters will be given a default value of `null`. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param action_type: actionType - :type action_type: ActionTypeApiName - :param validate_action_request: Body of the request - :type validate_action_request: Union[ValidateActionRequest, ValidateActionRequestDict] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ValidateActionResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = validate_action_request - - _path_params["ontologyRid"] = ontology_rid - - _path_params["actionType"] = action_type - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v1/ontologies/{ontologyRid}/actions/{actionType}/validate", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[ValidateActionRequest, ValidateActionRequestDict], - response_type=ValidateActionResponse, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v1/_namespaces/ontologies/action_type.py b/foundry/v1/_namespaces/ontologies/action_type.py deleted file mode 100644 index 8c7d2cd9..00000000 --- a/foundry/v1/_namespaces/ontologies/action_type.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v1.models._action_type import ActionType -from foundry.v1.models._action_type_api_name import ActionTypeApiName -from foundry.v1.models._list_action_types_response import ListActionTypesResponse -from foundry.v1.models._ontology_rid import OntologyRid -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken - - -class ActionTypeResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def get( - self, - ontology_rid: OntologyRid, - action_type_api_name: ActionTypeApiName, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ActionType: - """ - Gets a specific action type with the given API name. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param action_type_api_name: actionTypeApiName - :type action_type_api_name: ActionTypeApiName - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ActionType - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["ontologyRid"] = ontology_rid - - _path_params["actionTypeApiName"] = action_type_api_name - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ActionType, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - ontology_rid: OntologyRid, - *, - page_size: Optional[PageSize] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[ActionType]: - """ - Lists the action types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[ActionType] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _path_params["ontologyRid"] = ontology_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/actionTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListActionTypesResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - ontology_rid: OntologyRid, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListActionTypesResponse: - """ - Lists the action types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListActionTypesResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _path_params["ontologyRid"] = ontology_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/actionTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListActionTypesResponse, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v1/_namespaces/ontologies/object_type.py b/foundry/v1/_namespaces/ontologies/object_type.py deleted file mode 100644 index e517a941..00000000 --- a/foundry/v1/_namespaces/ontologies/object_type.py +++ /dev/null @@ -1,372 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v1.models._link_type_api_name import LinkTypeApiName -from foundry.v1.models._link_type_side import LinkTypeSide -from foundry.v1.models._list_object_types_response import ListObjectTypesResponse -from foundry.v1.models._list_outgoing_link_types_response import ( - ListOutgoingLinkTypesResponse, -) # NOQA -from foundry.v1.models._object_type import ObjectType -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._ontology_rid import OntologyRid -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken - - -class ObjectTypeResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def get( - self, - ontology_rid: OntologyRid, - object_type: ObjectTypeApiName, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ObjectType: - """ - Gets a specific object type with the given API name. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ObjectType - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["ontologyRid"] = ontology_rid - - _path_params["objectType"] = object_type - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objectTypes/{objectType}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ObjectType, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get_outgoing_link_type( - self, - ontology_rid: OntologyRid, - object_type: ObjectTypeApiName, - link_type: LinkTypeApiName, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> LinkTypeSide: - """ - Get an outgoing link for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param link_type: linkType - :type link_type: LinkTypeApiName - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: LinkTypeSide - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["ontologyRid"] = ontology_rid - - _path_params["objectType"] = object_type - - _path_params["linkType"] = link_type - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=LinkTypeSide, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - ontology_rid: OntologyRid, - *, - page_size: Optional[PageSize] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[ObjectType]: - """ - Lists the object types for the given Ontology. - - Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are - more results available, at least one result will be present in the - response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[ObjectType] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _path_params["ontologyRid"] = ontology_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objectTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListObjectTypesResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list_outgoing_link_types( - self, - ontology_rid: OntologyRid, - object_type: ObjectTypeApiName, - *, - page_size: Optional[PageSize] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[LinkTypeSide]: - """ - List the outgoing links for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[LinkTypeSide] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _path_params["ontologyRid"] = ontology_rid - - _path_params["objectType"] = object_type - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListOutgoingLinkTypesResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - ontology_rid: OntologyRid, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListObjectTypesResponse: - """ - Lists the object types for the given Ontology. - - Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are - more results available, at least one result will be present in the - response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListObjectTypesResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _path_params["ontologyRid"] = ontology_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objectTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListObjectTypesResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page_outgoing_link_types( - self, - ontology_rid: OntologyRid, - object_type: ObjectTypeApiName, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListOutgoingLinkTypesResponse: - """ - List the outgoing links for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListOutgoingLinkTypesResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _path_params["ontologyRid"] = ontology_rid - - _path_params["objectType"] = object_type - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListOutgoingLinkTypesResponse, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v1/_namespaces/ontologies/ontology.py b/foundry/v1/_namespaces/ontologies/ontology.py deleted file mode 100644 index 4dfa51ba..00000000 --- a/foundry/v1/_namespaces/ontologies/ontology.py +++ /dev/null @@ -1,127 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v1._namespaces.ontologies.action_type import ActionTypeResource -from foundry.v1._namespaces.ontologies.object_type import ObjectTypeResource -from foundry.v1._namespaces.ontologies.query_type import QueryTypeResource -from foundry.v1.models._list_ontologies_response import ListOntologiesResponse -from foundry.v1.models._ontology import Ontology -from foundry.v1.models._ontology_rid import OntologyRid - - -class OntologyResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - self.ActionType = ActionTypeResource(api_client=api_client) - self.ObjectType = ObjectTypeResource(api_client=api_client) - self.QueryType = QueryTypeResource(api_client=api_client) - - @validate_call - @handle_unexpected - def get( - self, - ontology_rid: OntologyRid, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Ontology: - """ - Gets a specific ontology with the given Ontology RID. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Ontology - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["ontologyRid"] = ontology_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Ontology, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListOntologiesResponse: - """ - Lists the Ontologies visible to the current user. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListOntologiesResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListOntologiesResponse, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v1/_namespaces/ontologies/ontology_object.py b/foundry/v1/_namespaces/ontologies/ontology_object.py deleted file mode 100644 index d81e2455..00000000 --- a/foundry/v1/_namespaces/ontologies/ontology_object.py +++ /dev/null @@ -1,649 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import List -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v1.models._aggregate_objects_request import AggregateObjectsRequest -from foundry.v1.models._aggregate_objects_request_dict import AggregateObjectsRequestDict # NOQA -from foundry.v1.models._aggregate_objects_response import AggregateObjectsResponse -from foundry.v1.models._link_type_api_name import LinkTypeApiName -from foundry.v1.models._list_linked_objects_response import ListLinkedObjectsResponse -from foundry.v1.models._list_objects_response import ListObjectsResponse -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._ontology_object import OntologyObject -from foundry.v1.models._ontology_rid import OntologyRid -from foundry.v1.models._order_by import OrderBy -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._property_value_escaped_string import PropertyValueEscapedString -from foundry.v1.models._search_objects_request import SearchObjectsRequest -from foundry.v1.models._search_objects_request_dict import SearchObjectsRequestDict -from foundry.v1.models._search_objects_response import SearchObjectsResponse -from foundry.v1.models._selected_property_api_name import SelectedPropertyApiName - - -class OntologyObjectResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def aggregate( - self, - ontology_rid: OntologyRid, - object_type: ObjectTypeApiName, - aggregate_objects_request: Union[AggregateObjectsRequest, AggregateObjectsRequestDict], - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> AggregateObjectsResponse: - """ - Perform functions on object fields in the specified ontology and object type. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param aggregate_objects_request: Body of the request - :type aggregate_objects_request: Union[AggregateObjectsRequest, AggregateObjectsRequestDict] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: AggregateObjectsResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = aggregate_objects_request - - _path_params["ontologyRid"] = ontology_rid - - _path_params["objectType"] = object_type - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[AggregateObjectsRequest, AggregateObjectsRequestDict], - response_type=AggregateObjectsResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - ontology_rid: OntologyRid, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - *, - properties: Optional[List[SelectedPropertyApiName]] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> OntologyObject: - """ - Gets a specific object with the given primary key. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param properties: properties - :type properties: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: OntologyObject - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["properties"] = properties - - _path_params["ontologyRid"] = ontology_rid - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=OntologyObject, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get_linked_object( - self, - ontology_rid: OntologyRid, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - link_type: LinkTypeApiName, - linked_object_primary_key: PropertyValueEscapedString, - *, - properties: Optional[List[SelectedPropertyApiName]] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> OntologyObject: - """ - Get a specific linked object that originates from another object. If there is no link between the two objects, - LinkedObjectNotFound is thrown. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param link_type: linkType - :type link_type: LinkTypeApiName - :param linked_object_primary_key: linkedObjectPrimaryKey - :type linked_object_primary_key: PropertyValueEscapedString - :param properties: properties - :type properties: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: OntologyObject - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["properties"] = properties - - _path_params["ontologyRid"] = ontology_rid - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _path_params["linkType"] = link_type - - _path_params["linkedObjectPrimaryKey"] = linked_object_primary_key - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=OntologyObject, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - ontology_rid: OntologyRid, - object_type: ObjectTypeApiName, - *, - order_by: Optional[OrderBy] = None, - page_size: Optional[PageSize] = None, - properties: Optional[List[SelectedPropertyApiName]] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[OntologyObject]: - """ - Lists the objects for the given Ontology and object type. - - This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param order_by: orderBy - :type order_by: Optional[OrderBy] - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param properties: properties - :type properties: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[OntologyObject] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["orderBy"] = order_by - - _query_params["pageSize"] = page_size - - _query_params["properties"] = properties - - _path_params["ontologyRid"] = ontology_rid - - _path_params["objectType"] = object_type - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListObjectsResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list_linked_objects( - self, - ontology_rid: OntologyRid, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - link_type: LinkTypeApiName, - *, - order_by: Optional[OrderBy] = None, - page_size: Optional[PageSize] = None, - properties: Optional[List[SelectedPropertyApiName]] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[OntologyObject]: - """ - Lists the linked objects for a specific object and the given link type. - - This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param link_type: linkType - :type link_type: LinkTypeApiName - :param order_by: orderBy - :type order_by: Optional[OrderBy] - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param properties: properties - :type properties: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[OntologyObject] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["orderBy"] = order_by - - _query_params["pageSize"] = page_size - - _query_params["properties"] = properties - - _path_params["ontologyRid"] = ontology_rid - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _path_params["linkType"] = link_type - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListLinkedObjectsResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - ontology_rid: OntologyRid, - object_type: ObjectTypeApiName, - *, - order_by: Optional[OrderBy] = None, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - properties: Optional[List[SelectedPropertyApiName]] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListObjectsResponse: - """ - Lists the objects for the given Ontology and object type. - - This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param order_by: orderBy - :type order_by: Optional[OrderBy] - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param properties: properties - :type properties: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListObjectsResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["orderBy"] = order_by - - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _query_params["properties"] = properties - - _path_params["ontologyRid"] = ontology_rid - - _path_params["objectType"] = object_type - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListObjectsResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page_linked_objects( - self, - ontology_rid: OntologyRid, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - link_type: LinkTypeApiName, - *, - order_by: Optional[OrderBy] = None, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - properties: Optional[List[SelectedPropertyApiName]] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListLinkedObjectsResponse: - """ - Lists the linked objects for a specific object and the given link type. - - This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param link_type: linkType - :type link_type: LinkTypeApiName - :param order_by: orderBy - :type order_by: Optional[OrderBy] - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param properties: properties - :type properties: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListLinkedObjectsResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["orderBy"] = order_by - - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _query_params["properties"] = properties - - _path_params["ontologyRid"] = ontology_rid - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _path_params["linkType"] = link_type - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListLinkedObjectsResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def search( - self, - ontology_rid: OntologyRid, - object_type: ObjectTypeApiName, - search_objects_request: Union[SearchObjectsRequest, SearchObjectsRequestDict], - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> SearchObjectsResponse: - """ - Search for objects in the specified ontology and object type. The request body is used - to filter objects based on the specified query. The supported queries are: - - | Query type | Description | Supported Types | - |----------|-----------------------------------------------------------------------------------|---------------------------------| - | lt | The provided property is less than the provided value. | number, string, date, timestamp | - | gt | The provided property is greater than the provided value. | number, string, date, timestamp | - | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp | - | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp | - | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp | - | isNull | The provided property is (or is not) null. | all | - | contains | The provided property contains the provided value. | array | - | not | The sub-query does not match. | N/A (applied on a query) | - | and | All the sub-queries match. | N/A (applied on queries) | - | or | At least one of the sub-queries match. | N/A (applied on queries) | - | prefix | The provided property starts with the provided value. | string | - | phrase | The provided property contains the provided value as a substring. | string | - | anyTerm | The provided property contains at least one of the terms separated by whitespace. | string | - | allTerms | The provided property contains all the terms separated by whitespace. | string | | - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param search_objects_request: Body of the request - :type search_objects_request: Union[SearchObjectsRequest, SearchObjectsRequestDict] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: SearchObjectsResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = search_objects_request - - _path_params["ontologyRid"] = ontology_rid - - _path_params["objectType"] = object_type - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}/search", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[SearchObjectsRequest, SearchObjectsRequestDict], - response_type=SearchObjectsResponse, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v1/_namespaces/ontologies/query.py b/foundry/v1/_namespaces/ontologies/query.py deleted file mode 100644 index 9ab201f3..00000000 --- a/foundry/v1/_namespaces/ontologies/query.py +++ /dev/null @@ -1,94 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v1.models._execute_query_request import ExecuteQueryRequest -from foundry.v1.models._execute_query_request_dict import ExecuteQueryRequestDict -from foundry.v1.models._execute_query_response import ExecuteQueryResponse -from foundry.v1.models._ontology_rid import OntologyRid -from foundry.v1.models._query_api_name import QueryApiName - - -class QueryResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def execute( - self, - ontology_rid: OntologyRid, - query_api_name: QueryApiName, - execute_query_request: Union[ExecuteQueryRequest, ExecuteQueryRequestDict], - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ExecuteQueryResponse: - """ - Executes a Query using the given parameters. Optional parameters do not need to be supplied. - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param query_api_name: queryApiName - :type query_api_name: QueryApiName - :param execute_query_request: Body of the request - :type execute_query_request: Union[ExecuteQueryRequest, ExecuteQueryRequestDict] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ExecuteQueryResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = execute_query_request - - _path_params["ontologyRid"] = ontology_rid - - _path_params["queryApiName"] = query_api_name - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[ExecuteQueryRequest, ExecuteQueryRequestDict], - response_type=ExecuteQueryResponse, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v1/_namespaces/ontologies/query_type.py b/foundry/v1/_namespaces/ontologies/query_type.py deleted file mode 100644 index beeef48e..00000000 --- a/foundry/v1/_namespaces/ontologies/query_type.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v1.models._list_query_types_response import ListQueryTypesResponse -from foundry.v1.models._ontology_rid import OntologyRid -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._query_api_name import QueryApiName -from foundry.v1.models._query_type import QueryType - - -class QueryTypeResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def get( - self, - ontology_rid: OntologyRid, - query_api_name: QueryApiName, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> QueryType: - """ - Gets a specific query type with the given API name. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param query_api_name: queryApiName - :type query_api_name: QueryApiName - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: QueryType - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["ontologyRid"] = ontology_rid - - _path_params["queryApiName"] = query_api_name - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/queryTypes/{queryApiName}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=QueryType, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - ontology_rid: OntologyRid, - *, - page_size: Optional[PageSize] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[QueryType]: - """ - Lists the query types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[QueryType] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _path_params["ontologyRid"] = ontology_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/queryTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListQueryTypesResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - ontology_rid: OntologyRid, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListQueryTypesResponse: - """ - Lists the query types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology_rid: ontologyRid - :type ontology_rid: OntologyRid - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListQueryTypesResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _path_params["ontologyRid"] = ontology_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v1/ontologies/{ontologyRid}/queryTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListQueryTypesResponse, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v1/cli.py b/foundry/v1/cli.py index 2ed867eb..4a4d76bf 100644 --- a/foundry/v1/cli.py +++ b/foundry/v1/cli.py @@ -19,18 +19,18 @@ import io import json import os +from datetime import datetime from typing import Literal from typing import Optional import click import foundry.v1 -import foundry.v1.models @dataclasses.dataclass class _Context: - obj: foundry.v1.FoundryV1Client + obj: foundry.v1.FoundryClient def get_from_environ(key: str) -> str: @@ -41,11 +41,11 @@ def get_from_environ(key: str) -> str: return value -@click.group() +@click.group() # type: ignore @click.pass_context # type: ignore def cli(ctx: _Context): "An experimental CLI for the Foundry API" - ctx.obj = foundry.v1.FoundryV1Client( + ctx.obj = foundry.v1.FoundryClient( auth=foundry.UserTokenAuth( hostname=get_from_environ("FOUNDRY_HOSTNAME"), token=get_from_environ("FOUNDRY_TOKEN"), @@ -54,6 +54,11 @@ def cli(ctx: _Context): ) +@cli.group("core") +def core(): + pass + + @cli.group("datasets") def datasets(): pass @@ -69,7 +74,7 @@ def datasets_dataset(): @click.option("--parent_folder_rid", type=str, required=True, help="""""") @click.pass_obj def datasets_dataset_create( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, name: str, parent_folder_rid: str, ): @@ -80,12 +85,8 @@ def datasets_dataset_create( """ result = client.datasets.Dataset.create( - create_dataset_request=foundry.v1.models.CreateDatasetRequest.model_validate( - { - "name": name, - "parentFolderRid": parent_folder_rid, - } - ), + name=name, + parent_folder_rid=parent_folder_rid, ) click.echo(repr(result)) @@ -97,7 +98,7 @@ def datasets_dataset_create( @click.option("--transaction_rid", type=str, required=False, help="""transactionRid""") @click.pass_obj def datasets_dataset_delete_schema( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, branch_id: Optional[str], preview: Optional[bool], @@ -120,7 +121,7 @@ def datasets_dataset_delete_schema( @click.argument("dataset_rid", type=str, required=True) @click.pass_obj def datasets_dataset_get( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, ): """ @@ -142,7 +143,7 @@ def datasets_dataset_get( @click.option("--transaction_rid", type=str, required=False, help="""transactionRid""") @click.pass_obj def datasets_dataset_get_schema( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, branch_id: Optional[str], preview: Optional[bool], @@ -171,7 +172,7 @@ def datasets_dataset_get_schema( @click.option("--start_transaction_rid", type=str, required=False, help="""startTransactionRid""") @click.pass_obj def datasets_dataset_read( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, format: Literal["ARROW", "CSV"], branch_id: Optional[str], @@ -207,7 +208,7 @@ def datasets_dataset_read( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def datasets_dataset_replace_schema( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, body: str, branch_id: Optional[str], @@ -236,7 +237,7 @@ def datasets_dataset_transaction(): @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_abort( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -259,7 +260,7 @@ def datasets_dataset_transaction_abort( @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_commit( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -279,19 +280,19 @@ def datasets_dataset_transaction_commit( @datasets_dataset_transaction.command("create") @click.argument("dataset_rid", type=str, required=True) +@click.option("--branch_id", type=str, required=False, help="""branchId""") @click.option( "--transaction_type", type=click.Choice(["APPEND", "UPDATE", "SNAPSHOT", "DELETE"]), required=False, help="""""", ) -@click.option("--branch_id", type=str, required=False, help="""branchId""") @click.pass_obj def datasets_dataset_transaction_create( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, - transaction_type: Optional[Literal["APPEND", "UPDATE", "SNAPSHOT", "DELETE"]], branch_id: Optional[str], + transaction_type: Optional[Literal["APPEND", "UPDATE", "SNAPSHOT", "DELETE"]], ): """ Creates a Transaction on a Branch of a Dataset. @@ -301,12 +302,8 @@ def datasets_dataset_transaction_create( """ result = client.datasets.Dataset.Transaction.create( dataset_rid=dataset_rid, - create_transaction_request=foundry.v1.models.CreateTransactionRequest.model_validate( - { - "transactionType": transaction_type, - } - ), branch_id=branch_id, + transaction_type=transaction_type, ) click.echo(repr(result)) @@ -316,7 +313,7 @@ def datasets_dataset_transaction_create( @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_get( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -345,7 +342,7 @@ def datasets_dataset_file(): @click.option("--transaction_rid", type=str, required=False, help="""transactionRid""") @click.pass_obj def datasets_dataset_file_delete( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, file_path: str, branch_id: Optional[str], @@ -387,7 +384,7 @@ def datasets_dataset_file_delete( @click.option("--start_transaction_rid", type=str, required=False, help="""startTransactionRid""") @click.pass_obj def datasets_dataset_file_get( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, file_path: str, branch_id: Optional[str], @@ -439,7 +436,7 @@ def datasets_dataset_file_get( @click.option("--start_transaction_rid", type=str, required=False, help="""startTransactionRid""") @click.pass_obj def datasets_dataset_file_list( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, branch_id: Optional[str], end_transaction_rid: Optional[str], @@ -494,7 +491,7 @@ def datasets_dataset_file_list( @click.option("--start_transaction_rid", type=str, required=False, help="""startTransactionRid""") @click.pass_obj def datasets_dataset_file_page( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, branch_id: Optional[str], end_transaction_rid: Optional[str], @@ -550,7 +547,7 @@ def datasets_dataset_file_page( @click.option("--start_transaction_rid", type=str, required=False, help="""startTransactionRid""") @click.pass_obj def datasets_dataset_file_read( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, file_path: str, branch_id: Optional[str], @@ -609,7 +606,7 @@ def datasets_dataset_file_read( ) @click.pass_obj def datasets_dataset_file_upload( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, body: io.BufferedReader, file_path: str, @@ -662,7 +659,7 @@ def datasets_dataset_branch(): @click.option("--transaction_rid", type=str, required=False, help="""""") @click.pass_obj def datasets_dataset_branch_create( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, branch_id: str, transaction_rid: Optional[str], @@ -675,12 +672,8 @@ def datasets_dataset_branch_create( """ result = client.datasets.Dataset.Branch.create( dataset_rid=dataset_rid, - create_branch_request=foundry.v1.models.CreateBranchRequest.model_validate( - { - "branchId": branch_id, - "transactionRid": transaction_rid, - } - ), + branch_id=branch_id, + transaction_rid=transaction_rid, ) click.echo(repr(result)) @@ -690,7 +683,7 @@ def datasets_dataset_branch_create( @click.argument("branch_id", type=str, required=True) @click.pass_obj def datasets_dataset_branch_delete( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, branch_id: str, ): @@ -712,7 +705,7 @@ def datasets_dataset_branch_delete( @click.argument("branch_id", type=str, required=True) @click.pass_obj def datasets_dataset_branch_get( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, branch_id: str, ): @@ -734,7 +727,7 @@ def datasets_dataset_branch_get( @click.option("--page_size", type=int, required=False, help="""pageSize""") @click.pass_obj def datasets_dataset_branch_list( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, page_size: Optional[int], ): @@ -757,7 +750,7 @@ def datasets_dataset_branch_list( @click.option("--page_token", type=str, required=False, help="""pageToken""") @click.pass_obj def datasets_dataset_branch_page( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, dataset_rid: str, page_size: Optional[int], page_token: Optional[str], @@ -776,6 +769,11 @@ def datasets_dataset_branch_page( click.echo(repr(result)) +@cli.group("geo") +def geo(): + pass + + @cli.group("ontologies") def ontologies(): pass @@ -792,7 +790,7 @@ def ontologies_query(): @click.option("--parameters", type=str, required=True, help="""""") @click.pass_obj def ontologies_query_execute( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, query_api_name: str, parameters: str, @@ -806,11 +804,7 @@ def ontologies_query_execute( result = client.ontologies.Query.execute( ontology_rid=ontology_rid, query_api_name=query_api_name, - execute_query_request=foundry.v1.models.ExecuteQueryRequest.model_validate( - { - "parameters": parameters, - } - ), + parameters=json.loads(parameters), ) click.echo(repr(result)) @@ -824,16 +818,16 @@ def ontologies_ontology_object(): @click.argument("ontology_rid", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.option("--aggregation", type=str, required=True, help="""""") -@click.option("--query", type=str, required=False, help="""""") @click.option("--group_by", type=str, required=True, help="""""") +@click.option("--query", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_aggregate( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, object_type: str, aggregation: str, - query: Optional[str], group_by: str, + query: Optional[str], ): """ Perform functions on object fields in the specified ontology and object type. @@ -844,13 +838,9 @@ def ontologies_ontology_object_aggregate( result = client.ontologies.OntologyObject.aggregate( ontology_rid=ontology_rid, object_type=object_type, - aggregate_objects_request=foundry.v1.models.AggregateObjectsRequest.model_validate( - { - "aggregation": aggregation, - "query": query, - "groupBy": group_by, - } - ), + aggregation=json.loads(aggregation), + group_by=json.loads(group_by), + query=None if query is None else json.loads(query), ) click.echo(repr(result)) @@ -862,7 +852,7 @@ def ontologies_ontology_object_aggregate( @click.option("--properties", type=str, required=False, help="""properties""") @click.pass_obj def ontologies_ontology_object_get( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, object_type: str, primary_key: str, @@ -892,7 +882,7 @@ def ontologies_ontology_object_get( @click.option("--properties", type=str, required=False, help="""properties""") @click.pass_obj def ontologies_ontology_object_get_linked_object( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, object_type: str, primary_key: str, @@ -926,7 +916,7 @@ def ontologies_ontology_object_get_linked_object( @click.option("--properties", type=str, required=False, help="""properties""") @click.pass_obj def ontologies_ontology_object_list( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, object_type: str, order_by: Optional[str], @@ -974,7 +964,7 @@ def ontologies_ontology_object_list( @click.option("--properties", type=str, required=False, help="""properties""") @click.pass_obj def ontologies_ontology_object_list_linked_objects( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, object_type: str, primary_key: str, @@ -1025,7 +1015,7 @@ def ontologies_ontology_object_list_linked_objects( @click.option("--properties", type=str, required=False, help="""properties""") @click.pass_obj def ontologies_ontology_object_page( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, object_type: str, order_by: Optional[str], @@ -1076,7 +1066,7 @@ def ontologies_ontology_object_page( @click.option("--properties", type=str, required=False, help="""properties""") @click.pass_obj def ontologies_ontology_object_page_linked_objects( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, object_type: str, primary_key: str, @@ -1123,10 +1113,6 @@ def ontologies_ontology_object_page_linked_objects( @ontologies_ontology_object.command("search") @click.argument("ontology_rid", type=str, required=True) @click.argument("object_type", type=str, required=True) -@click.option("--query", type=str, required=True, help="""""") -@click.option("--order_by", type=str, required=False, help="""""") -@click.option("--page_size", type=int, required=False, help="""""") -@click.option("--page_token", type=str, required=False, help="""""") @click.option( "--fields", type=str, @@ -1134,16 +1120,20 @@ def ontologies_ontology_object_page_linked_objects( help="""The API names of the object type properties to include in the response. """, ) +@click.option("--query", type=str, required=True, help="""""") +@click.option("--order_by", type=str, required=False, help="""""") +@click.option("--page_size", type=int, required=False, help="""""") +@click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_search( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, object_type: str, + fields: str, query: str, order_by: Optional[str], page_size: Optional[int], page_token: Optional[str], - fields: str, ): """ Search for objects in the specified ontology and object type. The request body is used @@ -1172,15 +1162,11 @@ def ontologies_ontology_object_search( result = client.ontologies.OntologyObject.search( ontology_rid=ontology_rid, object_type=object_type, - search_objects_request=foundry.v1.models.SearchObjectsRequest.model_validate( - { - "query": query, - "orderBy": order_by, - "pageSize": page_size, - "pageToken": page_token, - "fields": fields, - } - ), + fields=json.loads(fields), + query=json.loads(query), + order_by=None if order_by is None else json.loads(order_by), + page_size=page_size, + page_token=page_token, ) click.echo(repr(result)) @@ -1194,7 +1180,7 @@ def ontologies_ontology(): @click.argument("ontology_rid", type=str, required=True) @click.pass_obj def ontologies_ontology_get( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, ): """ @@ -1212,7 +1198,7 @@ def ontologies_ontology_get( @ontologies_ontology.command("list") @click.pass_obj def ontologies_ontology_list( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ): """ Lists the Ontologies visible to the current user. @@ -1234,7 +1220,7 @@ def ontologies_ontology_query_type(): @click.argument("query_api_name", type=str, required=True) @click.pass_obj def ontologies_ontology_query_type_get( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, query_api_name: str, ): @@ -1256,7 +1242,7 @@ def ontologies_ontology_query_type_get( @click.option("--page_size", type=int, required=False, help="""pageSize""") @click.pass_obj def ontologies_ontology_query_type_list( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, page_size: Optional[int], ): @@ -1282,7 +1268,7 @@ def ontologies_ontology_query_type_list( @click.option("--page_token", type=str, required=False, help="""pageToken""") @click.pass_obj def ontologies_ontology_query_type_page( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, page_size: Optional[int], page_token: Optional[str], @@ -1314,7 +1300,7 @@ def ontologies_ontology_object_type(): @click.argument("object_type", type=str, required=True) @click.pass_obj def ontologies_ontology_object_type_get( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, object_type: str, ): @@ -1337,7 +1323,7 @@ def ontologies_ontology_object_type_get( @click.argument("link_type", type=str, required=True) @click.pass_obj def ontologies_ontology_object_type_get_outgoing_link_type( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, object_type: str, link_type: str, @@ -1362,7 +1348,7 @@ def ontologies_ontology_object_type_get_outgoing_link_type( @click.option("--page_size", type=int, required=False, help="""pageSize""") @click.pass_obj def ontologies_ontology_object_type_list( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, page_size: Optional[int], ): @@ -1389,7 +1375,7 @@ def ontologies_ontology_object_type_list( @click.option("--page_size", type=int, required=False, help="""pageSize""") @click.pass_obj def ontologies_ontology_object_type_list_outgoing_link_types( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, object_type: str, page_size: Optional[int], @@ -1415,7 +1401,7 @@ def ontologies_ontology_object_type_list_outgoing_link_types( @click.option("--page_token", type=str, required=False, help="""pageToken""") @click.pass_obj def ontologies_ontology_object_type_page( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, page_size: Optional[int], page_token: Optional[str], @@ -1445,7 +1431,7 @@ def ontologies_ontology_object_type_page( @click.option("--page_token", type=str, required=False, help="""pageToken""") @click.pass_obj def ontologies_ontology_object_type_page_outgoing_link_types( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, object_type: str, page_size: Optional[int], @@ -1477,7 +1463,7 @@ def ontologies_ontology_action_type(): @click.argument("action_type_api_name", type=str, required=True) @click.pass_obj def ontologies_ontology_action_type_get( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, action_type_api_name: str, ): @@ -1499,7 +1485,7 @@ def ontologies_ontology_action_type_get( @click.option("--page_size", type=int, required=False, help="""pageSize""") @click.pass_obj def ontologies_ontology_action_type_list( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, page_size: Optional[int], ): @@ -1525,7 +1511,7 @@ def ontologies_ontology_action_type_list( @click.option("--page_token", type=str, required=False, help="""pageToken""") @click.pass_obj def ontologies_ontology_action_type_page( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, page_size: Optional[int], page_token: Optional[str], @@ -1558,7 +1544,7 @@ def ontologies_action(): @click.option("--parameters", type=str, required=True, help="""""") @click.pass_obj def ontologies_action_apply( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, action_type: str, parameters: str, @@ -1577,11 +1563,7 @@ def ontologies_action_apply( result = client.ontologies.Action.apply( ontology_rid=ontology_rid, action_type=action_type, - apply_action_request=foundry.v1.models.ApplyActionRequest.model_validate( - { - "parameters": parameters, - } - ), + parameters=json.loads(parameters), ) click.echo(repr(result)) @@ -1592,7 +1574,7 @@ def ontologies_action_apply( @click.option("--requests", type=str, required=True, help="""""") @click.pass_obj def ontologies_action_apply_batch( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, action_type: str, requests: str, @@ -1614,11 +1596,7 @@ def ontologies_action_apply_batch( result = client.ontologies.Action.apply_batch( ontology_rid=ontology_rid, action_type=action_type, - batch_apply_action_request=foundry.v1.models.BatchApplyActionRequest.model_validate( - { - "requests": requests, - } - ), + requests=json.loads(requests), ) click.echo(repr(result)) @@ -1629,7 +1607,7 @@ def ontologies_action_apply_batch( @click.option("--parameters", type=str, required=True, help="""""") @click.pass_obj def ontologies_action_validate( - client: foundry.v1.FoundryV1Client, + client: foundry.v1.FoundryClient, ontology_rid: str, action_type: str, parameters: str, @@ -1650,11 +1628,7 @@ def ontologies_action_validate( result = client.ontologies.Action.validate( ontology_rid=ontology_rid, action_type=action_type, - validate_action_request=foundry.v1.models.ValidateActionRequest.model_validate( - { - "parameters": parameters, - } - ), + parameters=json.loads(parameters), ) click.echo(repr(result)) diff --git a/foundry/v1/client.py b/foundry/v1/client.py new file mode 100644 index 00000000..1a5785df --- /dev/null +++ b/foundry/v1/client.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from foundry._core import Auth + + +class FoundryClient: + """ + The Foundry V1 API client. + + :param auth: Your auth configuration. + :param hostname: Your Foundry hostname (for example, "myfoundry.palantirfoundry.com"). + """ + + def __init__(self, auth: Auth, hostname: str): + from foundry.v1.datasets.client import DatasetsClient + from foundry.v1.ontologies.client import OntologiesClient + + self.datasets = DatasetsClient(auth=auth, hostname=hostname) + self.ontologies = OntologiesClient(auth=auth, hostname=hostname) diff --git a/foundry/v1/core/models/__init__.py b/foundry/v1/core/models/__init__.py new file mode 100644 index 00000000..81d8711d --- /dev/null +++ b/foundry/v1/core/models/__init__.py @@ -0,0 +1,98 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from foundry.v1.core.models._any_type import AnyType +from foundry.v1.core.models._any_type_dict import AnyTypeDict +from foundry.v1.core.models._binary_type import BinaryType +from foundry.v1.core.models._binary_type_dict import BinaryTypeDict +from foundry.v1.core.models._boolean_type import BooleanType +from foundry.v1.core.models._boolean_type_dict import BooleanTypeDict +from foundry.v1.core.models._byte_type import ByteType +from foundry.v1.core.models._byte_type_dict import ByteTypeDict +from foundry.v1.core.models._date_type import DateType +from foundry.v1.core.models._date_type_dict import DateTypeDict +from foundry.v1.core.models._decimal_type import DecimalType +from foundry.v1.core.models._decimal_type_dict import DecimalTypeDict +from foundry.v1.core.models._display_name import DisplayName +from foundry.v1.core.models._double_type import DoubleType +from foundry.v1.core.models._double_type_dict import DoubleTypeDict +from foundry.v1.core.models._duration import Duration +from foundry.v1.core.models._file_path import FilePath +from foundry.v1.core.models._float_type import FloatType +from foundry.v1.core.models._float_type_dict import FloatTypeDict +from foundry.v1.core.models._folder_rid import FolderRid +from foundry.v1.core.models._integer_type import IntegerType +from foundry.v1.core.models._integer_type_dict import IntegerTypeDict +from foundry.v1.core.models._long_type import LongType +from foundry.v1.core.models._long_type_dict import LongTypeDict +from foundry.v1.core.models._marking_type import MarkingType +from foundry.v1.core.models._marking_type_dict import MarkingTypeDict +from foundry.v1.core.models._page_size import PageSize +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.core.models._preview_mode import PreviewMode +from foundry.v1.core.models._release_status import ReleaseStatus +from foundry.v1.core.models._short_type import ShortType +from foundry.v1.core.models._short_type_dict import ShortTypeDict +from foundry.v1.core.models._string_type import StringType +from foundry.v1.core.models._string_type_dict import StringTypeDict +from foundry.v1.core.models._struct_field_name import StructFieldName +from foundry.v1.core.models._timestamp_type import TimestampType +from foundry.v1.core.models._timestamp_type_dict import TimestampTypeDict +from foundry.v1.core.models._total_count import TotalCount +from foundry.v1.core.models._unsupported_type import UnsupportedType +from foundry.v1.core.models._unsupported_type_dict import UnsupportedTypeDict + +__all__ = [ + "AnyType", + "AnyTypeDict", + "BinaryType", + "BinaryTypeDict", + "BooleanType", + "BooleanTypeDict", + "ByteType", + "ByteTypeDict", + "DateType", + "DateTypeDict", + "DecimalType", + "DecimalTypeDict", + "DisplayName", + "DoubleType", + "DoubleTypeDict", + "Duration", + "FilePath", + "FloatType", + "FloatTypeDict", + "FolderRid", + "IntegerType", + "IntegerTypeDict", + "LongType", + "LongTypeDict", + "MarkingType", + "MarkingTypeDict", + "PageSize", + "PageToken", + "PreviewMode", + "ReleaseStatus", + "ShortType", + "ShortTypeDict", + "StringType", + "StringTypeDict", + "StructFieldName", + "TimestampType", + "TimestampTypeDict", + "TotalCount", + "UnsupportedType", + "UnsupportedTypeDict", +] diff --git a/foundry/v1/core/models/_any_type.py b/foundry/v1/core/models/_any_type.py new file mode 100644 index 00000000..351aed10 --- /dev/null +++ b/foundry/v1/core/models/_any_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.core.models._any_type_dict import AnyTypeDict + + +class AnyType(BaseModel): + """AnyType""" + + type: Literal["any"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> AnyTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(AnyTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_any_type_dict.py b/foundry/v1/core/models/_any_type_dict.py similarity index 100% rename from foundry/v1/models/_any_type_dict.py rename to foundry/v1/core/models/_any_type_dict.py diff --git a/foundry/v1/core/models/_binary_type.py b/foundry/v1/core/models/_binary_type.py new file mode 100644 index 00000000..a0f75ee1 --- /dev/null +++ b/foundry/v1/core/models/_binary_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.core.models._binary_type_dict import BinaryTypeDict + + +class BinaryType(BaseModel): + """BinaryType""" + + type: Literal["binary"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> BinaryTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(BinaryTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_binary_type_dict.py b/foundry/v1/core/models/_binary_type_dict.py similarity index 100% rename from foundry/v1/models/_binary_type_dict.py rename to foundry/v1/core/models/_binary_type_dict.py diff --git a/foundry/v1/core/models/_boolean_type.py b/foundry/v1/core/models/_boolean_type.py new file mode 100644 index 00000000..e922ae9e --- /dev/null +++ b/foundry/v1/core/models/_boolean_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.core.models._boolean_type_dict import BooleanTypeDict + + +class BooleanType(BaseModel): + """BooleanType""" + + type: Literal["boolean"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> BooleanTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(BooleanTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_boolean_type_dict.py b/foundry/v1/core/models/_boolean_type_dict.py similarity index 100% rename from foundry/v1/models/_boolean_type_dict.py rename to foundry/v1/core/models/_boolean_type_dict.py diff --git a/foundry/v1/core/models/_byte_type.py b/foundry/v1/core/models/_byte_type.py new file mode 100644 index 00000000..bd8290a5 --- /dev/null +++ b/foundry/v1/core/models/_byte_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.core.models._byte_type_dict import ByteTypeDict + + +class ByteType(BaseModel): + """ByteType""" + + type: Literal["byte"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ByteTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ByteTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_byte_type_dict.py b/foundry/v1/core/models/_byte_type_dict.py similarity index 100% rename from foundry/v1/models/_byte_type_dict.py rename to foundry/v1/core/models/_byte_type_dict.py diff --git a/foundry/v1/core/models/_date_type.py b/foundry/v1/core/models/_date_type.py new file mode 100644 index 00000000..75bd985f --- /dev/null +++ b/foundry/v1/core/models/_date_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.core.models._date_type_dict import DateTypeDict + + +class DateType(BaseModel): + """DateType""" + + type: Literal["date"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> DateTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(DateTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_date_type_dict.py b/foundry/v1/core/models/_date_type_dict.py similarity index 100% rename from foundry/v1/models/_date_type_dict.py rename to foundry/v1/core/models/_date_type_dict.py diff --git a/foundry/v1/core/models/_decimal_type.py b/foundry/v1/core/models/_decimal_type.py new file mode 100644 index 00000000..2d3973a6 --- /dev/null +++ b/foundry/v1/core/models/_decimal_type.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import StrictInt + +from foundry.v1.core.models._decimal_type_dict import DecimalTypeDict + + +class DecimalType(BaseModel): + """DecimalType""" + + precision: Optional[StrictInt] = None + + scale: Optional[StrictInt] = None + + type: Literal["decimal"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> DecimalTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(DecimalTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_decimal_type_dict.py b/foundry/v1/core/models/_decimal_type_dict.py similarity index 100% rename from foundry/v1/models/_decimal_type_dict.py rename to foundry/v1/core/models/_decimal_type_dict.py diff --git a/foundry/v1/models/_display_name.py b/foundry/v1/core/models/_display_name.py similarity index 100% rename from foundry/v1/models/_display_name.py rename to foundry/v1/core/models/_display_name.py diff --git a/foundry/v1/core/models/_double_type.py b/foundry/v1/core/models/_double_type.py new file mode 100644 index 00000000..838cbb94 --- /dev/null +++ b/foundry/v1/core/models/_double_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.core.models._double_type_dict import DoubleTypeDict + + +class DoubleType(BaseModel): + """DoubleType""" + + type: Literal["double"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> DoubleTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(DoubleTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_double_type_dict.py b/foundry/v1/core/models/_double_type_dict.py similarity index 100% rename from foundry/v1/models/_double_type_dict.py rename to foundry/v1/core/models/_double_type_dict.py diff --git a/foundry/v1/models/_duration.py b/foundry/v1/core/models/_duration.py similarity index 100% rename from foundry/v1/models/_duration.py rename to foundry/v1/core/models/_duration.py diff --git a/foundry/v1/models/_file_path.py b/foundry/v1/core/models/_file_path.py similarity index 100% rename from foundry/v1/models/_file_path.py rename to foundry/v1/core/models/_file_path.py diff --git a/foundry/v1/core/models/_float_type.py b/foundry/v1/core/models/_float_type.py new file mode 100644 index 00000000..774cfbd9 --- /dev/null +++ b/foundry/v1/core/models/_float_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.core.models._float_type_dict import FloatTypeDict + + +class FloatType(BaseModel): + """FloatType""" + + type: Literal["float"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> FloatTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(FloatTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_float_type_dict.py b/foundry/v1/core/models/_float_type_dict.py similarity index 100% rename from foundry/v1/models/_float_type_dict.py rename to foundry/v1/core/models/_float_type_dict.py diff --git a/foundry/v1/models/_folder_rid.py b/foundry/v1/core/models/_folder_rid.py similarity index 100% rename from foundry/v1/models/_folder_rid.py rename to foundry/v1/core/models/_folder_rid.py diff --git a/foundry/v1/core/models/_integer_type.py b/foundry/v1/core/models/_integer_type.py new file mode 100644 index 00000000..540efb74 --- /dev/null +++ b/foundry/v1/core/models/_integer_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.core.models._integer_type_dict import IntegerTypeDict + + +class IntegerType(BaseModel): + """IntegerType""" + + type: Literal["integer"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> IntegerTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(IntegerTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_integer_type_dict.py b/foundry/v1/core/models/_integer_type_dict.py similarity index 100% rename from foundry/v1/models/_integer_type_dict.py rename to foundry/v1/core/models/_integer_type_dict.py diff --git a/foundry/v1/core/models/_long_type.py b/foundry/v1/core/models/_long_type.py new file mode 100644 index 00000000..e2a5088c --- /dev/null +++ b/foundry/v1/core/models/_long_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.core.models._long_type_dict import LongTypeDict + + +class LongType(BaseModel): + """LongType""" + + type: Literal["long"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> LongTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(LongTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_long_type_dict.py b/foundry/v1/core/models/_long_type_dict.py similarity index 100% rename from foundry/v1/models/_long_type_dict.py rename to foundry/v1/core/models/_long_type_dict.py diff --git a/foundry/v1/core/models/_marking_type.py b/foundry/v1/core/models/_marking_type.py new file mode 100644 index 00000000..1cccd01b --- /dev/null +++ b/foundry/v1/core/models/_marking_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.core.models._marking_type_dict import MarkingTypeDict + + +class MarkingType(BaseModel): + """MarkingType""" + + type: Literal["marking"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> MarkingTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(MarkingTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_marking_type_dict.py b/foundry/v1/core/models/_marking_type_dict.py similarity index 100% rename from foundry/v1/models/_marking_type_dict.py rename to foundry/v1/core/models/_marking_type_dict.py diff --git a/foundry/v1/models/_page_size.py b/foundry/v1/core/models/_page_size.py similarity index 100% rename from foundry/v1/models/_page_size.py rename to foundry/v1/core/models/_page_size.py diff --git a/foundry/v1/models/_page_token.py b/foundry/v1/core/models/_page_token.py similarity index 100% rename from foundry/v1/models/_page_token.py rename to foundry/v1/core/models/_page_token.py diff --git a/foundry/v1/models/_preview_mode.py b/foundry/v1/core/models/_preview_mode.py similarity index 100% rename from foundry/v1/models/_preview_mode.py rename to foundry/v1/core/models/_preview_mode.py diff --git a/foundry/v1/models/_release_status.py b/foundry/v1/core/models/_release_status.py similarity index 100% rename from foundry/v1/models/_release_status.py rename to foundry/v1/core/models/_release_status.py diff --git a/foundry/v1/core/models/_short_type.py b/foundry/v1/core/models/_short_type.py new file mode 100644 index 00000000..8b125457 --- /dev/null +++ b/foundry/v1/core/models/_short_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.core.models._short_type_dict import ShortTypeDict + + +class ShortType(BaseModel): + """ShortType""" + + type: Literal["short"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ShortTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ShortTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_short_type_dict.py b/foundry/v1/core/models/_short_type_dict.py similarity index 100% rename from foundry/v1/models/_short_type_dict.py rename to foundry/v1/core/models/_short_type_dict.py diff --git a/foundry/v1/core/models/_string_type.py b/foundry/v1/core/models/_string_type.py new file mode 100644 index 00000000..3582fba1 --- /dev/null +++ b/foundry/v1/core/models/_string_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.core.models._string_type_dict import StringTypeDict + + +class StringType(BaseModel): + """StringType""" + + type: Literal["string"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> StringTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(StringTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_string_type_dict.py b/foundry/v1/core/models/_string_type_dict.py similarity index 100% rename from foundry/v1/models/_string_type_dict.py rename to foundry/v1/core/models/_string_type_dict.py diff --git a/foundry/v1/models/_struct_field_name.py b/foundry/v1/core/models/_struct_field_name.py similarity index 100% rename from foundry/v1/models/_struct_field_name.py rename to foundry/v1/core/models/_struct_field_name.py diff --git a/foundry/v1/core/models/_timestamp_type.py b/foundry/v1/core/models/_timestamp_type.py new file mode 100644 index 00000000..dbf382f6 --- /dev/null +++ b/foundry/v1/core/models/_timestamp_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.core.models._timestamp_type_dict import TimestampTypeDict + + +class TimestampType(BaseModel): + """TimestampType""" + + type: Literal["timestamp"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> TimestampTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(TimestampTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_timestamp_type_dict.py b/foundry/v1/core/models/_timestamp_type_dict.py similarity index 100% rename from foundry/v1/models/_timestamp_type_dict.py rename to foundry/v1/core/models/_timestamp_type_dict.py diff --git a/foundry/v1/models/_total_count.py b/foundry/v1/core/models/_total_count.py similarity index 100% rename from foundry/v1/models/_total_count.py rename to foundry/v1/core/models/_total_count.py diff --git a/foundry/v1/core/models/_unsupported_type.py b/foundry/v1/core/models/_unsupported_type.py new file mode 100644 index 00000000..dcf7325c --- /dev/null +++ b/foundry/v1/core/models/_unsupported_type.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v1.core.models._unsupported_type_dict import UnsupportedTypeDict + + +class UnsupportedType(BaseModel): + """UnsupportedType""" + + unsupported_type: StrictStr = Field(alias="unsupportedType") + + type: Literal["unsupported"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> UnsupportedTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(UnsupportedTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_unsupported_type_dict.py b/foundry/v1/core/models/_unsupported_type_dict.py similarity index 100% rename from foundry/v1/models/_unsupported_type_dict.py rename to foundry/v1/core/models/_unsupported_type_dict.py diff --git a/foundry/v1/datasets/branch.py b/foundry/v1/datasets/branch.py new file mode 100644 index 00000000..cb1bf2d4 --- /dev/null +++ b/foundry/v1/datasets/branch.py @@ -0,0 +1,275 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v1.core.models._page_size import PageSize +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.datasets.models._branch import Branch +from foundry.v1.datasets.models._branch_id import BranchId +from foundry.v1.datasets.models._dataset_rid import DatasetRid +from foundry.v1.datasets.models._list_branches_response import ListBranchesResponse +from foundry.v1.datasets.models._transaction_rid import TransactionRid + + +class BranchClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def create( + self, + dataset_rid: DatasetRid, + *, + branch_id: BranchId, + transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Branch: + """ + Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param branch_id: + :type branch_id: BranchId + :param transaction_rid: + :type transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Branch + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v1/datasets/{datasetRid}/branches", + query_params={}, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "branchId": branch_id, + "transactionRid": transaction_rid, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "branchId": BranchId, + "transactionRid": Optional[TransactionRid], + }, + ), + response_type=Branch, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def delete( + self, + dataset_rid: DatasetRid, + branch_id: BranchId, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + Deletes the Branch with the given BranchId. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param branch_id: branchId + :type branch_id: BranchId + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="DELETE", + resource_path="/v1/datasets/{datasetRid}/branches/{branchId}", + query_params={}, + path_params={ + "datasetRid": dataset_rid, + "branchId": branch_id, + }, + header_params={}, + body=None, + body_type=None, + response_type=None, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + dataset_rid: DatasetRid, + branch_id: BranchId, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Branch: + """ + Get a Branch of a Dataset. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param branch_id: branchId + :type branch_id: BranchId + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Branch + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/datasets/{datasetRid}/branches/{branchId}", + query_params={}, + path_params={ + "datasetRid": dataset_rid, + "branchId": branch_id, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Branch, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + dataset_rid: DatasetRid, + *, + page_size: Optional[PageSize] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[Branch]: + """ + Lists the Branches of a Dataset. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[Branch] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v1/datasets/{datasetRid}/branches", + query_params={ + "pageSize": page_size, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListBranchesResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + dataset_rid: DatasetRid, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListBranchesResponse: + """ + Lists the Branches of a Dataset. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListBranchesResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/datasets/{datasetRid}/branches", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListBranchesResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v1/datasets/client.py b/foundry/v1/datasets/client.py new file mode 100644 index 00000000..d08a139d --- /dev/null +++ b/foundry/v1/datasets/client.py @@ -0,0 +1,24 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry._core import Auth +from foundry.v1.datasets.dataset import DatasetClient + + +class DatasetsClient: + def __init__(self, auth: Auth, hostname: str): + self.Dataset = DatasetClient(auth=auth, hostname=hostname) diff --git a/foundry/v1/datasets/dataset.py b/foundry/v1/datasets/dataset.py new file mode 100644 index 00000000..ec0a0544 --- /dev/null +++ b/foundry/v1/datasets/dataset.py @@ -0,0 +1,355 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import List +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import StrictStr +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v1.core.models._folder_rid import FolderRid +from foundry.v1.core.models._preview_mode import PreviewMode +from foundry.v1.datasets.branch import BranchClient +from foundry.v1.datasets.file import FileClient +from foundry.v1.datasets.models._branch_id import BranchId +from foundry.v1.datasets.models._dataset import Dataset +from foundry.v1.datasets.models._dataset_name import DatasetName +from foundry.v1.datasets.models._dataset_rid import DatasetRid +from foundry.v1.datasets.models._table_export_format import TableExportFormat +from foundry.v1.datasets.models._transaction_rid import TransactionRid +from foundry.v1.datasets.transaction import TransactionClient + + +class DatasetClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + self.Branch = BranchClient(auth=auth, hostname=hostname) + self.File = FileClient(auth=auth, hostname=hostname) + self.Transaction = TransactionClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def create( + self, + *, + name: DatasetName, + parent_folder_rid: FolderRid, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Dataset: + """ + Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + :param name: + :type name: DatasetName + :param parent_folder_rid: + :type parent_folder_rid: FolderRid + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Dataset + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v1/datasets", + query_params={}, + path_params={}, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "name": name, + "parentFolderRid": parent_folder_rid, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "name": DatasetName, + "parentFolderRid": FolderRid, + }, + ), + response_type=Dataset, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def delete_schema( + self, + dataset_rid: DatasetRid, + *, + branch_id: Optional[BranchId] = None, + preview: Optional[PreviewMode] = None, + transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + Deletes the Schema from a Dataset and Branch. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param branch_id: branchId + :type branch_id: Optional[BranchId] + :param preview: preview + :type preview: Optional[PreviewMode] + :param transaction_rid: transactionRid + :type transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="DELETE", + resource_path="/v1/datasets/{datasetRid}/schema", + query_params={ + "branchId": branch_id, + "preview": preview, + "transactionRid": transaction_rid, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={}, + body=None, + body_type=None, + response_type=None, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + dataset_rid: DatasetRid, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Dataset: + """ + Gets the Dataset with the given DatasetRid. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Dataset + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/datasets/{datasetRid}", + query_params={}, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Dataset, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get_schema( + self, + dataset_rid: DatasetRid, + *, + branch_id: Optional[BranchId] = None, + preview: Optional[PreviewMode] = None, + transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Any: + """ + Retrieves the Schema for a Dataset and Branch, if it exists. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param branch_id: branchId + :type branch_id: Optional[BranchId] + :param preview: preview + :type preview: Optional[PreviewMode] + :param transaction_rid: transactionRid + :type transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Any + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/datasets/{datasetRid}/schema", + query_params={ + "branchId": branch_id, + "preview": preview, + "transactionRid": transaction_rid, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Any, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def read( + self, + dataset_rid: DatasetRid, + *, + format: TableExportFormat, + branch_id: Optional[BranchId] = None, + columns: Optional[List[StrictStr]] = None, + end_transaction_rid: Optional[TransactionRid] = None, + row_limit: Optional[StrictInt] = None, + start_transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> bytes: + """ + Gets the content of a dataset as a table in the specified format. + + This endpoint currently does not support views (Virtual datasets composed of other datasets). + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param format: format + :type format: TableExportFormat + :param branch_id: branchId + :type branch_id: Optional[BranchId] + :param columns: columns + :type columns: Optional[List[StrictStr]] + :param end_transaction_rid: endTransactionRid + :type end_transaction_rid: Optional[TransactionRid] + :param row_limit: rowLimit + :type row_limit: Optional[StrictInt] + :param start_transaction_rid: startTransactionRid + :type start_transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: bytes + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/datasets/{datasetRid}/readTable", + query_params={ + "format": format, + "branchId": branch_id, + "columns": columns, + "endTransactionRid": end_transaction_rid, + "rowLimit": row_limit, + "startTransactionRid": start_transaction_rid, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Accept": "*/*", + }, + body=None, + body_type=None, + response_type=bytes, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def replace_schema( + self, + dataset_rid: DatasetRid, + body: Any, + *, + branch_id: Optional[BranchId] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + Puts a Schema on an existing Dataset and Branch. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param body: Body of the request + :type body: Any + :param branch_id: branchId + :type branch_id: Optional[BranchId] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="PUT", + resource_path="/v1/datasets/{datasetRid}/schema", + query_params={ + "branchId": branch_id, + "preview": preview, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Content-Type": "application/json", + }, + body=body, + body_type=Any, + response_type=None, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v1/datasets/file.py b/foundry/v1/datasets/file.py new file mode 100644 index 00000000..fc2450a0 --- /dev/null +++ b/foundry/v1/datasets/file.py @@ -0,0 +1,502 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v1.core.models._file_path import FilePath +from foundry.v1.core.models._page_size import PageSize +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.datasets.models._branch_id import BranchId +from foundry.v1.datasets.models._dataset_rid import DatasetRid +from foundry.v1.datasets.models._file import File +from foundry.v1.datasets.models._list_files_response import ListFilesResponse +from foundry.v1.datasets.models._transaction_rid import TransactionRid +from foundry.v1.datasets.models._transaction_type import TransactionType + + +class FileClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def delete( + self, + dataset_rid: DatasetRid, + file_path: FilePath, + *, + branch_id: Optional[BranchId] = None, + transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default + branch - `master` for most enrollments. The file will still be visible on historical views. + + #### Advanced Usage + + See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + + To **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction + will be created and committed on this branch. + + To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier + as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a + single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to + open a transaction. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param file_path: filePath + :type file_path: FilePath + :param branch_id: branchId + :type branch_id: Optional[BranchId] + :param transaction_rid: transactionRid + :type transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="DELETE", + resource_path="/v1/datasets/{datasetRid}/files/{filePath}", + query_params={ + "branchId": branch_id, + "transactionRid": transaction_rid, + }, + path_params={ + "datasetRid": dataset_rid, + "filePath": file_path, + }, + header_params={}, + body=None, + body_type=None, + response_type=None, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + dataset_rid: DatasetRid, + file_path: FilePath, + *, + branch_id: Optional[BranchId] = None, + end_transaction_rid: Optional[TransactionRid] = None, + start_transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> File: + """ + Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest + view of the default branch - `master` for most enrollments. + + #### Advanced Usage + + See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + + To **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will + retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest + ancestor transaction of the branch if there are no snapshot transactions. + + To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier + as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot + transaction, or the earliest ancestor transaction if there are no snapshot transactions. + + To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's + resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. + This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the + `endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path. + + To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the + `startTransactionRid` and `endTransactionRid`. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param file_path: filePath + :type file_path: FilePath + :param branch_id: branchId + :type branch_id: Optional[BranchId] + :param end_transaction_rid: endTransactionRid + :type end_transaction_rid: Optional[TransactionRid] + :param start_transaction_rid: startTransactionRid + :type start_transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: File + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/datasets/{datasetRid}/files/{filePath}", + query_params={ + "branchId": branch_id, + "endTransactionRid": end_transaction_rid, + "startTransactionRid": start_transaction_rid, + }, + path_params={ + "datasetRid": dataset_rid, + "filePath": file_path, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=File, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + dataset_rid: DatasetRid, + *, + branch_id: Optional[BranchId] = None, + end_transaction_rid: Optional[TransactionRid] = None, + page_size: Optional[PageSize] = None, + start_transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[File]: + """ + Lists Files contained in a Dataset. By default files are listed on the latest view of the default + branch - `master` for most enrollments. + + #### Advanced Usage + + See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + + To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most + recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the + branch if there are no snapshot transactions. + + To **list files on the resolved view of a transaction** specify the Transaction's resource identifier + as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot + transaction, or the earliest ancestor transaction if there are no snapshot transactions. + + To **list files on the resolved view of a range of transactions** specify the the start transaction's resource + identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This + will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. + Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when + the start and end transactions do not belong to the same root-to-leaf path. + + To **list files on a specific transaction** specify the Transaction's resource identifier as both the + `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that + Transaction. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param branch_id: branchId + :type branch_id: Optional[BranchId] + :param end_transaction_rid: endTransactionRid + :type end_transaction_rid: Optional[TransactionRid] + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param start_transaction_rid: startTransactionRid + :type start_transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[File] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v1/datasets/{datasetRid}/files", + query_params={ + "branchId": branch_id, + "endTransactionRid": end_transaction_rid, + "pageSize": page_size, + "startTransactionRid": start_transaction_rid, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListFilesResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + dataset_rid: DatasetRid, + *, + branch_id: Optional[BranchId] = None, + end_transaction_rid: Optional[TransactionRid] = None, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + start_transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListFilesResponse: + """ + Lists Files contained in a Dataset. By default files are listed on the latest view of the default + branch - `master` for most enrollments. + + #### Advanced Usage + + See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + + To **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most + recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the + branch if there are no snapshot transactions. + + To **list files on the resolved view of a transaction** specify the Transaction's resource identifier + as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot + transaction, or the earliest ancestor transaction if there are no snapshot transactions. + + To **list files on the resolved view of a range of transactions** specify the the start transaction's resource + identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This + will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. + Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when + the start and end transactions do not belong to the same root-to-leaf path. + + To **list files on a specific transaction** specify the Transaction's resource identifier as both the + `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that + Transaction. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param branch_id: branchId + :type branch_id: Optional[BranchId] + :param end_transaction_rid: endTransactionRid + :type end_transaction_rid: Optional[TransactionRid] + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param start_transaction_rid: startTransactionRid + :type start_transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListFilesResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/datasets/{datasetRid}/files", + query_params={ + "branchId": branch_id, + "endTransactionRid": end_transaction_rid, + "pageSize": page_size, + "pageToken": page_token, + "startTransactionRid": start_transaction_rid, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListFilesResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def read( + self, + dataset_rid: DatasetRid, + file_path: FilePath, + *, + branch_id: Optional[BranchId] = None, + end_transaction_rid: Optional[TransactionRid] = None, + start_transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> bytes: + """ + Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest + view of the default branch - `master` for most enrollments. + + #### Advanced Usage + + See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + + To **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will + retrieve the content for the most recent version of the file since the latest snapshot transaction, or the + earliest ancestor transaction of the branch if there are no snapshot transactions. + + To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier + as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest + snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions. + + To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's + resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. + This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the + `endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior + is undefined when the start and end transactions do not belong to the same root-to-leaf path. + + To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the + `startTransactionRid` and `endTransactionRid`. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param file_path: filePath + :type file_path: FilePath + :param branch_id: branchId + :type branch_id: Optional[BranchId] + :param end_transaction_rid: endTransactionRid + :type end_transaction_rid: Optional[TransactionRid] + :param start_transaction_rid: startTransactionRid + :type start_transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: bytes + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/datasets/{datasetRid}/files/{filePath}/content", + query_params={ + "branchId": branch_id, + "endTransactionRid": end_transaction_rid, + "startTransactionRid": start_transaction_rid, + }, + path_params={ + "datasetRid": dataset_rid, + "filePath": file_path, + }, + header_params={ + "Accept": "*/*", + }, + body=None, + body_type=None, + response_type=bytes, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def upload( + self, + dataset_rid: DatasetRid, + body: bytes, + *, + file_path: FilePath, + branch_id: Optional[BranchId] = None, + transaction_rid: Optional[TransactionRid] = None, + transaction_type: Optional[TransactionType] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> File: + """ + Uploads a File to an existing Dataset. + The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. + + By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments. + If the file already exists only the most recent version will be visible in the updated view. + + #### Advanced Usage + + See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + + To **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will + be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this + default specify `transactionType` in addition to `branchId`. + See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. + + To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as + `transactionRid`. This is useful for uploading multiple files in a single transaction. + See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param body: Body of the request + :type body: bytes + :param file_path: filePath + :type file_path: FilePath + :param branch_id: branchId + :type branch_id: Optional[BranchId] + :param transaction_rid: transactionRid + :type transaction_rid: Optional[TransactionRid] + :param transaction_type: transactionType + :type transaction_type: Optional[TransactionType] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: File + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v1/datasets/{datasetRid}/files:upload", + query_params={ + "filePath": file_path, + "branchId": branch_id, + "transactionRid": transaction_rid, + "transactionType": transaction_type, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Content-Type": "*/*", + "Accept": "application/json", + }, + body=body, + body_type=bytes, + response_type=File, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v1/datasets/models/__init__.py b/foundry/v1/datasets/models/__init__.py new file mode 100644 index 00000000..f0fe372d --- /dev/null +++ b/foundry/v1/datasets/models/__init__.py @@ -0,0 +1,56 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from foundry.v1.datasets.models._branch import Branch +from foundry.v1.datasets.models._branch_dict import BranchDict +from foundry.v1.datasets.models._branch_id import BranchId +from foundry.v1.datasets.models._dataset import Dataset +from foundry.v1.datasets.models._dataset_dict import DatasetDict +from foundry.v1.datasets.models._dataset_name import DatasetName +from foundry.v1.datasets.models._dataset_rid import DatasetRid +from foundry.v1.datasets.models._file import File +from foundry.v1.datasets.models._file_dict import FileDict +from foundry.v1.datasets.models._list_branches_response import ListBranchesResponse +from foundry.v1.datasets.models._list_branches_response_dict import ListBranchesResponseDict # NOQA +from foundry.v1.datasets.models._list_files_response import ListFilesResponse +from foundry.v1.datasets.models._list_files_response_dict import ListFilesResponseDict +from foundry.v1.datasets.models._table_export_format import TableExportFormat +from foundry.v1.datasets.models._transaction import Transaction +from foundry.v1.datasets.models._transaction_dict import TransactionDict +from foundry.v1.datasets.models._transaction_rid import TransactionRid +from foundry.v1.datasets.models._transaction_status import TransactionStatus +from foundry.v1.datasets.models._transaction_type import TransactionType + +__all__ = [ + "Branch", + "BranchDict", + "BranchId", + "Dataset", + "DatasetDict", + "DatasetName", + "DatasetRid", + "File", + "FileDict", + "ListBranchesResponse", + "ListBranchesResponseDict", + "ListFilesResponse", + "ListFilesResponseDict", + "TableExportFormat", + "Transaction", + "TransactionDict", + "TransactionRid", + "TransactionStatus", + "TransactionType", +] diff --git a/foundry/v1/datasets/models/_branch.py b/foundry/v1/datasets/models/_branch.py new file mode 100644 index 00000000..3f5b01a6 --- /dev/null +++ b/foundry/v1/datasets/models/_branch.py @@ -0,0 +1,40 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.datasets.models._branch_dict import BranchDict +from foundry.v1.datasets.models._branch_id import BranchId +from foundry.v1.datasets.models._transaction_rid import TransactionRid + + +class Branch(BaseModel): + """A Branch of a Dataset.""" + + branch_id: BranchId = Field(alias="branchId") + + transaction_rid: Optional[TransactionRid] = Field(alias="transactionRid", default=None) + + model_config = {"extra": "allow"} + + def to_dict(self) -> BranchDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(BranchDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/datasets/models/_branch_dict.py b/foundry/v1/datasets/models/_branch_dict.py new file mode 100644 index 00000000..92c72485 --- /dev/null +++ b/foundry/v1/datasets/models/_branch_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.datasets.models._branch_id import BranchId +from foundry.v1.datasets.models._transaction_rid import TransactionRid + + +class BranchDict(TypedDict): + """A Branch of a Dataset.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + branchId: BranchId + + transactionRid: NotRequired[TransactionRid] diff --git a/foundry/v1/models/_branch_id.py b/foundry/v1/datasets/models/_branch_id.py similarity index 100% rename from foundry/v1/models/_branch_id.py rename to foundry/v1/datasets/models/_branch_id.py diff --git a/foundry/v1/datasets/models/_dataset.py b/foundry/v1/datasets/models/_dataset.py new file mode 100644 index 00000000..07861624 --- /dev/null +++ b/foundry/v1/datasets/models/_dataset.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.core.models._folder_rid import FolderRid +from foundry.v1.datasets.models._dataset_dict import DatasetDict +from foundry.v1.datasets.models._dataset_name import DatasetName +from foundry.v1.datasets.models._dataset_rid import DatasetRid + + +class Dataset(BaseModel): + """Dataset""" + + rid: DatasetRid + + name: DatasetName + + parent_folder_rid: FolderRid = Field(alias="parentFolderRid") + + model_config = {"extra": "allow"} + + def to_dict(self) -> DatasetDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(DatasetDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/datasets/models/_dataset_dict.py b/foundry/v1/datasets/models/_dataset_dict.py new file mode 100644 index 00000000..71f7a58d --- /dev/null +++ b/foundry/v1/datasets/models/_dataset_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import TypedDict + +from foundry.v1.core.models._folder_rid import FolderRid +from foundry.v1.datasets.models._dataset_name import DatasetName +from foundry.v1.datasets.models._dataset_rid import DatasetRid + + +class DatasetDict(TypedDict): + """Dataset""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + rid: DatasetRid + + name: DatasetName + + parentFolderRid: FolderRid diff --git a/foundry/v1/models/_dataset_name.py b/foundry/v1/datasets/models/_dataset_name.py similarity index 100% rename from foundry/v1/models/_dataset_name.py rename to foundry/v1/datasets/models/_dataset_name.py diff --git a/foundry/v1/models/_dataset_rid.py b/foundry/v1/datasets/models/_dataset_rid.py similarity index 100% rename from foundry/v1/models/_dataset_rid.py rename to foundry/v1/datasets/models/_dataset_rid.py diff --git a/foundry/v1/datasets/models/_file.py b/foundry/v1/datasets/models/_file.py new file mode 100644 index 00000000..1cd83792 --- /dev/null +++ b/foundry/v1/datasets/models/_file.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from datetime import datetime +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v1.core.models._file_path import FilePath +from foundry.v1.datasets.models._file_dict import FileDict +from foundry.v1.datasets.models._transaction_rid import TransactionRid + + +class File(BaseModel): + """File""" + + path: FilePath + + transaction_rid: TransactionRid = Field(alias="transactionRid") + + size_bytes: Optional[StrictStr] = Field(alias="sizeBytes", default=None) + + updated_time: datetime = Field(alias="updatedTime") + + model_config = {"extra": "allow"} + + def to_dict(self) -> FileDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(FileDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/datasets/models/_file_dict.py b/foundry/v1/datasets/models/_file_dict.py new file mode 100644 index 00000000..b21badcb --- /dev/null +++ b/foundry/v1/datasets/models/_file_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from datetime import datetime + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._file_path import FilePath +from foundry.v1.datasets.models._transaction_rid import TransactionRid + + +class FileDict(TypedDict): + """File""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + path: FilePath + + transactionRid: TransactionRid + + sizeBytes: NotRequired[StrictStr] + + updatedTime: datetime diff --git a/foundry/v1/datasets/models/_list_branches_response.py b/foundry/v1/datasets/models/_list_branches_response.py new file mode 100644 index 00000000..d9168991 --- /dev/null +++ b/foundry/v1/datasets/models/_list_branches_response.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.datasets.models._branch import Branch +from foundry.v1.datasets.models._list_branches_response_dict import ListBranchesResponseDict # NOQA + + +class ListBranchesResponse(BaseModel): + """ListBranchesResponse""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[Branch] + """The list of branches in the current page.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListBranchesResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ListBranchesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/datasets/models/_list_branches_response_dict.py b/foundry/v1/datasets/models/_list_branches_response_dict.py new file mode 100644 index 00000000..403882af --- /dev/null +++ b/foundry/v1/datasets/models/_list_branches_response_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.datasets.models._branch_dict import BranchDict + + +class ListBranchesResponseDict(TypedDict): + """ListBranchesResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nextPageToken: NotRequired[PageToken] + + data: List[BranchDict] + """The list of branches in the current page.""" diff --git a/foundry/v1/datasets/models/_list_files_response.py b/foundry/v1/datasets/models/_list_files_response.py new file mode 100644 index 00000000..dd0ca3d5 --- /dev/null +++ b/foundry/v1/datasets/models/_list_files_response.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.datasets.models._file import File +from foundry.v1.datasets.models._list_files_response_dict import ListFilesResponseDict + + +class ListFilesResponse(BaseModel): + """A page of Files and an optional page token that can be used to retrieve the next page.""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[File] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListFilesResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ListFilesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/datasets/models/_list_files_response_dict.py b/foundry/v1/datasets/models/_list_files_response_dict.py new file mode 100644 index 00000000..c10f2b43 --- /dev/null +++ b/foundry/v1/datasets/models/_list_files_response_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.datasets.models._file_dict import FileDict + + +class ListFilesResponseDict(TypedDict): + """A page of Files and an optional page token that can be used to retrieve the next page.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nextPageToken: NotRequired[PageToken] + + data: List[FileDict] diff --git a/foundry/v1/models/_table_export_format.py b/foundry/v1/datasets/models/_table_export_format.py similarity index 100% rename from foundry/v1/models/_table_export_format.py rename to foundry/v1/datasets/models/_table_export_format.py diff --git a/foundry/v1/datasets/models/_transaction.py b/foundry/v1/datasets/models/_transaction.py new file mode 100644 index 00000000..c1bc0d07 --- /dev/null +++ b/foundry/v1/datasets/models/_transaction.py @@ -0,0 +1,50 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from datetime import datetime +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.datasets.models._transaction_dict import TransactionDict +from foundry.v1.datasets.models._transaction_rid import TransactionRid +from foundry.v1.datasets.models._transaction_status import TransactionStatus +from foundry.v1.datasets.models._transaction_type import TransactionType + + +class Transaction(BaseModel): + """An operation that modifies the files within a dataset.""" + + rid: TransactionRid + + transaction_type: TransactionType = Field(alias="transactionType") + + status: TransactionStatus + + created_time: datetime = Field(alias="createdTime") + """The timestamp when the transaction was created, in ISO 8601 timestamp format.""" + + closed_time: Optional[datetime] = Field(alias="closedTime", default=None) + """The timestamp when the transaction was closed, in ISO 8601 timestamp format.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> TransactionDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(TransactionDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/datasets/models/_transaction_dict.py b/foundry/v1/datasets/models/_transaction_dict.py new file mode 100644 index 00000000..3fbd91aa --- /dev/null +++ b/foundry/v1/datasets/models/_transaction_dict.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from datetime import datetime + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.datasets.models._transaction_rid import TransactionRid +from foundry.v1.datasets.models._transaction_status import TransactionStatus +from foundry.v1.datasets.models._transaction_type import TransactionType + + +class TransactionDict(TypedDict): + """An operation that modifies the files within a dataset.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + rid: TransactionRid + + transactionType: TransactionType + + status: TransactionStatus + + createdTime: datetime + """The timestamp when the transaction was created, in ISO 8601 timestamp format.""" + + closedTime: NotRequired[datetime] + """The timestamp when the transaction was closed, in ISO 8601 timestamp format.""" diff --git a/foundry/v1/models/_transaction_rid.py b/foundry/v1/datasets/models/_transaction_rid.py similarity index 100% rename from foundry/v1/models/_transaction_rid.py rename to foundry/v1/datasets/models/_transaction_rid.py diff --git a/foundry/v1/models/_transaction_status.py b/foundry/v1/datasets/models/_transaction_status.py similarity index 100% rename from foundry/v1/models/_transaction_status.py rename to foundry/v1/datasets/models/_transaction_status.py diff --git a/foundry/v1/models/_transaction_type.py b/foundry/v1/datasets/models/_transaction_type.py similarity index 100% rename from foundry/v1/models/_transaction_type.py rename to foundry/v1/datasets/models/_transaction_type.py diff --git a/foundry/v1/datasets/transaction.py b/foundry/v1/datasets/transaction.py new file mode 100644 index 00000000..dde39e7a --- /dev/null +++ b/foundry/v1/datasets/transaction.py @@ -0,0 +1,227 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v1.datasets.models._branch_id import BranchId +from foundry.v1.datasets.models._dataset_rid import DatasetRid +from foundry.v1.datasets.models._transaction import Transaction +from foundry.v1.datasets.models._transaction_rid import TransactionRid +from foundry.v1.datasets.models._transaction_type import TransactionType + + +class TransactionClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def abort( + self, + dataset_rid: DatasetRid, + transaction_rid: TransactionRid, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Transaction: + """ + Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is + not updated. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param transaction_rid: transactionRid + :type transaction_rid: TransactionRid + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Transaction + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v1/datasets/{datasetRid}/transactions/{transactionRid}/abort", + query_params={}, + path_params={ + "datasetRid": dataset_rid, + "transactionRid": transaction_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Transaction, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def commit( + self, + dataset_rid: DatasetRid, + transaction_rid: TransactionRid, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Transaction: + """ + Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is + updated to point to the Transaction. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param transaction_rid: transactionRid + :type transaction_rid: TransactionRid + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Transaction + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v1/datasets/{datasetRid}/transactions/{transactionRid}/commit", + query_params={}, + path_params={ + "datasetRid": dataset_rid, + "transactionRid": transaction_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Transaction, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def create( + self, + dataset_rid: DatasetRid, + *, + branch_id: Optional[BranchId] = None, + transaction_type: Optional[TransactionType] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Transaction: + """ + Creates a Transaction on a Branch of a Dataset. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param branch_id: branchId + :type branch_id: Optional[BranchId] + :param transaction_type: + :type transaction_type: Optional[TransactionType] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Transaction + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v1/datasets/{datasetRid}/transactions", + query_params={ + "branchId": branch_id, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "transactionType": transaction_type, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "transactionType": Optional[TransactionType], + }, + ), + response_type=Transaction, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + dataset_rid: DatasetRid, + transaction_rid: TransactionRid, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Transaction: + """ + Gets a Transaction of a Dataset. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param transaction_rid: transactionRid + :type transaction_rid: TransactionRid + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Transaction + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/datasets/{datasetRid}/transactions/{transactionRid}", + query_params={}, + path_params={ + "datasetRid": dataset_rid, + "transactionRid": transaction_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Transaction, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v1/foundry_client.py b/foundry/v1/foundry_client.py deleted file mode 100644 index 5c5b278a..00000000 --- a/foundry/v1/foundry_client.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from foundry._core.auth_utils import Auth -from foundry._errors.environment_not_configured import EnvironmentNotConfigured -from foundry.api_client import ApiClient - - -class FoundryV1Client: - """ - The Foundry V1 API client. - - :param auth: Your auth configuration. - :param hostname: Your Foundry hostname (for example, "myfoundry.palantirfoundry.com"). - """ - - def __init__(self, auth: Auth, hostname: str): - from foundry.v1._namespaces.namespaces import Datasets - from foundry.v1._namespaces.namespaces import Ontologies - - api_client = ApiClient(auth=auth, hostname=hostname) - self.datasets = Datasets(api_client=api_client) - self.ontologies = Ontologies(api_client=api_client) diff --git a/foundry/v1/geo/models/__init__.py b/foundry/v1/geo/models/__init__.py new file mode 100644 index 00000000..6dd5770f --- /dev/null +++ b/foundry/v1/geo/models/__init__.py @@ -0,0 +1,16 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +__all__ = [] diff --git a/foundry/v1/models/__init__.py b/foundry/v1/models/__init__.py deleted file mode 100644 index 516868e4..00000000 --- a/foundry/v1/models/__init__.py +++ /dev/null @@ -1,1616 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from foundry.v1.models._absolute_time_range import AbsoluteTimeRange -from foundry.v1.models._absolute_time_range_dict import AbsoluteTimeRangeDict -from foundry.v1.models._action_mode import ActionMode -from foundry.v1.models._action_parameter_type import ActionParameterArrayType -from foundry.v1.models._action_parameter_type import ActionParameterType -from foundry.v1.models._action_parameter_type_dict import ActionParameterArrayTypeDict -from foundry.v1.models._action_parameter_type_dict import ActionParameterTypeDict -from foundry.v1.models._action_parameter_v2 import ActionParameterV2 -from foundry.v1.models._action_parameter_v2_dict import ActionParameterV2Dict -from foundry.v1.models._action_results import ActionResults -from foundry.v1.models._action_results_dict import ActionResultsDict -from foundry.v1.models._action_rid import ActionRid -from foundry.v1.models._action_type import ActionType -from foundry.v1.models._action_type_api_name import ActionTypeApiName -from foundry.v1.models._action_type_dict import ActionTypeDict -from foundry.v1.models._action_type_rid import ActionTypeRid -from foundry.v1.models._action_type_v2 import ActionTypeV2 -from foundry.v1.models._action_type_v2_dict import ActionTypeV2Dict -from foundry.v1.models._add_link import AddLink -from foundry.v1.models._add_link_dict import AddLinkDict -from foundry.v1.models._add_object import AddObject -from foundry.v1.models._add_object_dict import AddObjectDict -from foundry.v1.models._aggregate_object_set_request_v2 import AggregateObjectSetRequestV2 # NOQA -from foundry.v1.models._aggregate_object_set_request_v2_dict import ( - AggregateObjectSetRequestV2Dict, -) # NOQA -from foundry.v1.models._aggregate_objects_request import AggregateObjectsRequest -from foundry.v1.models._aggregate_objects_request_dict import AggregateObjectsRequestDict # NOQA -from foundry.v1.models._aggregate_objects_request_v2 import AggregateObjectsRequestV2 -from foundry.v1.models._aggregate_objects_request_v2_dict import ( - AggregateObjectsRequestV2Dict, -) # NOQA -from foundry.v1.models._aggregate_objects_response import AggregateObjectsResponse -from foundry.v1.models._aggregate_objects_response_dict import AggregateObjectsResponseDict # NOQA -from foundry.v1.models._aggregate_objects_response_item import AggregateObjectsResponseItem # NOQA -from foundry.v1.models._aggregate_objects_response_item_dict import ( - AggregateObjectsResponseItemDict, -) # NOQA -from foundry.v1.models._aggregate_objects_response_item_v2 import ( - AggregateObjectsResponseItemV2, -) # NOQA -from foundry.v1.models._aggregate_objects_response_item_v2_dict import ( - AggregateObjectsResponseItemV2Dict, -) # NOQA -from foundry.v1.models._aggregate_objects_response_v2 import AggregateObjectsResponseV2 -from foundry.v1.models._aggregate_objects_response_v2_dict import ( - AggregateObjectsResponseV2Dict, -) # NOQA -from foundry.v1.models._aggregation import Aggregation -from foundry.v1.models._aggregation_accuracy import AggregationAccuracy -from foundry.v1.models._aggregation_accuracy_request import AggregationAccuracyRequest -from foundry.v1.models._aggregation_dict import AggregationDict -from foundry.v1.models._aggregation_duration_grouping import AggregationDurationGrouping -from foundry.v1.models._aggregation_duration_grouping_dict import ( - AggregationDurationGroupingDict, -) # NOQA -from foundry.v1.models._aggregation_duration_grouping_v2 import ( - AggregationDurationGroupingV2, -) # NOQA -from foundry.v1.models._aggregation_duration_grouping_v2_dict import ( - AggregationDurationGroupingV2Dict, -) # NOQA -from foundry.v1.models._aggregation_exact_grouping import AggregationExactGrouping -from foundry.v1.models._aggregation_exact_grouping_dict import AggregationExactGroupingDict # NOQA -from foundry.v1.models._aggregation_exact_grouping_v2 import AggregationExactGroupingV2 -from foundry.v1.models._aggregation_exact_grouping_v2_dict import ( - AggregationExactGroupingV2Dict, -) # NOQA -from foundry.v1.models._aggregation_fixed_width_grouping import ( - AggregationFixedWidthGrouping, -) # NOQA -from foundry.v1.models._aggregation_fixed_width_grouping_dict import ( - AggregationFixedWidthGroupingDict, -) # NOQA -from foundry.v1.models._aggregation_fixed_width_grouping_v2 import ( - AggregationFixedWidthGroupingV2, -) # NOQA -from foundry.v1.models._aggregation_fixed_width_grouping_v2_dict import ( - AggregationFixedWidthGroupingV2Dict, -) # NOQA -from foundry.v1.models._aggregation_group_by import AggregationGroupBy -from foundry.v1.models._aggregation_group_by_dict import AggregationGroupByDict -from foundry.v1.models._aggregation_group_by_v2 import AggregationGroupByV2 -from foundry.v1.models._aggregation_group_by_v2_dict import AggregationGroupByV2Dict -from foundry.v1.models._aggregation_group_key import AggregationGroupKey -from foundry.v1.models._aggregation_group_key_v2 import AggregationGroupKeyV2 -from foundry.v1.models._aggregation_group_value import AggregationGroupValue -from foundry.v1.models._aggregation_group_value_v2 import AggregationGroupValueV2 -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._aggregation_metric_result import AggregationMetricResult -from foundry.v1.models._aggregation_metric_result_dict import AggregationMetricResultDict # NOQA -from foundry.v1.models._aggregation_metric_result_v2 import AggregationMetricResultV2 -from foundry.v1.models._aggregation_metric_result_v2_dict import ( - AggregationMetricResultV2Dict, -) # NOQA -from foundry.v1.models._aggregation_object_type_grouping import ( - AggregationObjectTypeGrouping, -) # NOQA -from foundry.v1.models._aggregation_object_type_grouping_dict import ( - AggregationObjectTypeGroupingDict, -) # NOQA -from foundry.v1.models._aggregation_order_by import AggregationOrderBy -from foundry.v1.models._aggregation_order_by_dict import AggregationOrderByDict -from foundry.v1.models._aggregation_range import AggregationRange -from foundry.v1.models._aggregation_range_dict import AggregationRangeDict -from foundry.v1.models._aggregation_range_v2 import AggregationRangeV2 -from foundry.v1.models._aggregation_range_v2_dict import AggregationRangeV2Dict -from foundry.v1.models._aggregation_ranges_grouping import AggregationRangesGrouping -from foundry.v1.models._aggregation_ranges_grouping_dict import ( - AggregationRangesGroupingDict, -) # NOQA -from foundry.v1.models._aggregation_ranges_grouping_v2 import AggregationRangesGroupingV2 # NOQA -from foundry.v1.models._aggregation_ranges_grouping_v2_dict import ( - AggregationRangesGroupingV2Dict, -) # NOQA -from foundry.v1.models._aggregation_v2 import AggregationV2 -from foundry.v1.models._aggregation_v2_dict import AggregationV2Dict -from foundry.v1.models._all_terms_query import AllTermsQuery -from foundry.v1.models._all_terms_query_dict import AllTermsQueryDict -from foundry.v1.models._any_term_query import AnyTermQuery -from foundry.v1.models._any_term_query_dict import AnyTermQueryDict -from foundry.v1.models._any_type import AnyType -from foundry.v1.models._any_type_dict import AnyTypeDict -from foundry.v1.models._apply_action_mode import ApplyActionMode -from foundry.v1.models._apply_action_request import ApplyActionRequest -from foundry.v1.models._apply_action_request_dict import ApplyActionRequestDict -from foundry.v1.models._apply_action_request_options import ApplyActionRequestOptions -from foundry.v1.models._apply_action_request_options_dict import ( - ApplyActionRequestOptionsDict, -) # NOQA -from foundry.v1.models._apply_action_request_v2 import ApplyActionRequestV2 -from foundry.v1.models._apply_action_request_v2_dict import ApplyActionRequestV2Dict -from foundry.v1.models._apply_action_response import ApplyActionResponse -from foundry.v1.models._apply_action_response_dict import ApplyActionResponseDict -from foundry.v1.models._approximate_distinct_aggregation import ( - ApproximateDistinctAggregation, -) # NOQA -from foundry.v1.models._approximate_distinct_aggregation_dict import ( - ApproximateDistinctAggregationDict, -) # NOQA -from foundry.v1.models._approximate_distinct_aggregation_v2 import ( - ApproximateDistinctAggregationV2, -) # NOQA -from foundry.v1.models._approximate_distinct_aggregation_v2_dict import ( - ApproximateDistinctAggregationV2Dict, -) # NOQA -from foundry.v1.models._approximate_percentile_aggregation_v2 import ( - ApproximatePercentileAggregationV2, -) # NOQA -from foundry.v1.models._approximate_percentile_aggregation_v2_dict import ( - ApproximatePercentileAggregationV2Dict, -) # NOQA -from foundry.v1.models._archive_file_format import ArchiveFileFormat -from foundry.v1.models._arg import Arg -from foundry.v1.models._arg_dict import ArgDict -from foundry.v1.models._array_size_constraint import ArraySizeConstraint -from foundry.v1.models._array_size_constraint_dict import ArraySizeConstraintDict -from foundry.v1.models._artifact_repository_rid import ArtifactRepositoryRid -from foundry.v1.models._async_action_status import AsyncActionStatus -from foundry.v1.models._async_apply_action_operation_response_v2 import ( - AsyncApplyActionOperationResponseV2, -) # NOQA -from foundry.v1.models._async_apply_action_operation_response_v2_dict import ( - AsyncApplyActionOperationResponseV2Dict, -) # NOQA -from foundry.v1.models._async_apply_action_request import AsyncApplyActionRequest -from foundry.v1.models._async_apply_action_request_dict import AsyncApplyActionRequestDict # NOQA -from foundry.v1.models._async_apply_action_request_v2 import AsyncApplyActionRequestV2 -from foundry.v1.models._async_apply_action_request_v2_dict import ( - AsyncApplyActionRequestV2Dict, -) # NOQA -from foundry.v1.models._async_apply_action_response import AsyncApplyActionResponse -from foundry.v1.models._async_apply_action_response_dict import AsyncApplyActionResponseDict # NOQA -from foundry.v1.models._async_apply_action_response_v2 import AsyncApplyActionResponseV2 -from foundry.v1.models._async_apply_action_response_v2_dict import ( - AsyncApplyActionResponseV2Dict, -) # NOQA -from foundry.v1.models._attachment import Attachment -from foundry.v1.models._attachment_dict import AttachmentDict -from foundry.v1.models._attachment_metadata_response import AttachmentMetadataResponse -from foundry.v1.models._attachment_metadata_response_dict import ( - AttachmentMetadataResponseDict, -) # NOQA -from foundry.v1.models._attachment_property import AttachmentProperty -from foundry.v1.models._attachment_property_dict import AttachmentPropertyDict -from foundry.v1.models._attachment_rid import AttachmentRid -from foundry.v1.models._attachment_type import AttachmentType -from foundry.v1.models._attachment_type_dict import AttachmentTypeDict -from foundry.v1.models._attachment_v2 import AttachmentV2 -from foundry.v1.models._attachment_v2_dict import AttachmentV2Dict -from foundry.v1.models._avg_aggregation import AvgAggregation -from foundry.v1.models._avg_aggregation_dict import AvgAggregationDict -from foundry.v1.models._avg_aggregation_v2 import AvgAggregationV2 -from foundry.v1.models._avg_aggregation_v2_dict import AvgAggregationV2Dict -from foundry.v1.models._b_box import BBox -from foundry.v1.models._batch_apply_action_request import BatchApplyActionRequest -from foundry.v1.models._batch_apply_action_request_dict import BatchApplyActionRequestDict # NOQA -from foundry.v1.models._batch_apply_action_request_item import BatchApplyActionRequestItem # NOQA -from foundry.v1.models._batch_apply_action_request_item_dict import ( - BatchApplyActionRequestItemDict, -) # NOQA -from foundry.v1.models._batch_apply_action_request_options import ( - BatchApplyActionRequestOptions, -) # NOQA -from foundry.v1.models._batch_apply_action_request_options_dict import ( - BatchApplyActionRequestOptionsDict, -) # NOQA -from foundry.v1.models._batch_apply_action_request_v2 import BatchApplyActionRequestV2 -from foundry.v1.models._batch_apply_action_request_v2_dict import ( - BatchApplyActionRequestV2Dict, -) # NOQA -from foundry.v1.models._batch_apply_action_response import BatchApplyActionResponse -from foundry.v1.models._batch_apply_action_response_dict import BatchApplyActionResponseDict # NOQA -from foundry.v1.models._batch_apply_action_response_v2 import BatchApplyActionResponseV2 -from foundry.v1.models._batch_apply_action_response_v2_dict import ( - BatchApplyActionResponseV2Dict, -) # NOQA -from foundry.v1.models._binary_type import BinaryType -from foundry.v1.models._binary_type_dict import BinaryTypeDict -from foundry.v1.models._blueprint_icon import BlueprintIcon -from foundry.v1.models._blueprint_icon_dict import BlueprintIconDict -from foundry.v1.models._boolean_type import BooleanType -from foundry.v1.models._boolean_type_dict import BooleanTypeDict -from foundry.v1.models._bounding_box_value import BoundingBoxValue -from foundry.v1.models._bounding_box_value_dict import BoundingBoxValueDict -from foundry.v1.models._branch import Branch -from foundry.v1.models._branch_dict import BranchDict -from foundry.v1.models._branch_id import BranchId -from foundry.v1.models._byte_type import ByteType -from foundry.v1.models._byte_type_dict import ByteTypeDict -from foundry.v1.models._center_point import CenterPoint -from foundry.v1.models._center_point_dict import CenterPointDict -from foundry.v1.models._center_point_types import CenterPointTypes -from foundry.v1.models._center_point_types_dict import CenterPointTypesDict -from foundry.v1.models._contains_all_terms_in_order_prefix_last_term import ( - ContainsAllTermsInOrderPrefixLastTerm, -) # NOQA -from foundry.v1.models._contains_all_terms_in_order_prefix_last_term_dict import ( - ContainsAllTermsInOrderPrefixLastTermDict, -) # NOQA -from foundry.v1.models._contains_all_terms_in_order_query import ( - ContainsAllTermsInOrderQuery, -) # NOQA -from foundry.v1.models._contains_all_terms_in_order_query_dict import ( - ContainsAllTermsInOrderQueryDict, -) # NOQA -from foundry.v1.models._contains_all_terms_query import ContainsAllTermsQuery -from foundry.v1.models._contains_all_terms_query_dict import ContainsAllTermsQueryDict -from foundry.v1.models._contains_any_term_query import ContainsAnyTermQuery -from foundry.v1.models._contains_any_term_query_dict import ContainsAnyTermQueryDict -from foundry.v1.models._contains_query import ContainsQuery -from foundry.v1.models._contains_query_dict import ContainsQueryDict -from foundry.v1.models._contains_query_v2 import ContainsQueryV2 -from foundry.v1.models._contains_query_v2_dict import ContainsQueryV2Dict -from foundry.v1.models._content_length import ContentLength -from foundry.v1.models._content_type import ContentType -from foundry.v1.models._coordinate import Coordinate -from foundry.v1.models._count_aggregation import CountAggregation -from foundry.v1.models._count_aggregation_dict import CountAggregationDict -from foundry.v1.models._count_aggregation_v2 import CountAggregationV2 -from foundry.v1.models._count_aggregation_v2_dict import CountAggregationV2Dict -from foundry.v1.models._count_objects_response_v2 import CountObjectsResponseV2 -from foundry.v1.models._count_objects_response_v2_dict import CountObjectsResponseV2Dict -from foundry.v1.models._create_branch_request import CreateBranchRequest -from foundry.v1.models._create_branch_request_dict import CreateBranchRequestDict -from foundry.v1.models._create_dataset_request import CreateDatasetRequest -from foundry.v1.models._create_dataset_request_dict import CreateDatasetRequestDict -from foundry.v1.models._create_link_rule import CreateLinkRule -from foundry.v1.models._create_link_rule_dict import CreateLinkRuleDict -from foundry.v1.models._create_object_rule import CreateObjectRule -from foundry.v1.models._create_object_rule_dict import CreateObjectRuleDict -from foundry.v1.models._create_temporary_object_set_request_v2 import ( - CreateTemporaryObjectSetRequestV2, -) # NOQA -from foundry.v1.models._create_temporary_object_set_request_v2_dict import ( - CreateTemporaryObjectSetRequestV2Dict, -) # NOQA -from foundry.v1.models._create_temporary_object_set_response_v2 import ( - CreateTemporaryObjectSetResponseV2, -) # NOQA -from foundry.v1.models._create_temporary_object_set_response_v2_dict import ( - CreateTemporaryObjectSetResponseV2Dict, -) # NOQA -from foundry.v1.models._create_transaction_request import CreateTransactionRequest -from foundry.v1.models._create_transaction_request_dict import CreateTransactionRequestDict # NOQA -from foundry.v1.models._created_time import CreatedTime -from foundry.v1.models._custom_type_id import CustomTypeId -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._dataset import Dataset -from foundry.v1.models._dataset_dict import DatasetDict -from foundry.v1.models._dataset_name import DatasetName -from foundry.v1.models._dataset_rid import DatasetRid -from foundry.v1.models._date_type import DateType -from foundry.v1.models._date_type_dict import DateTypeDict -from foundry.v1.models._decimal_type import DecimalType -from foundry.v1.models._decimal_type_dict import DecimalTypeDict -from foundry.v1.models._delete_link_rule import DeleteLinkRule -from foundry.v1.models._delete_link_rule_dict import DeleteLinkRuleDict -from foundry.v1.models._delete_object_rule import DeleteObjectRule -from foundry.v1.models._delete_object_rule_dict import DeleteObjectRuleDict -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._distance import Distance -from foundry.v1.models._distance_dict import DistanceDict -from foundry.v1.models._distance_unit import DistanceUnit -from foundry.v1.models._does_not_intersect_bounding_box_query import ( - DoesNotIntersectBoundingBoxQuery, -) # NOQA -from foundry.v1.models._does_not_intersect_bounding_box_query_dict import ( - DoesNotIntersectBoundingBoxQueryDict, -) # NOQA -from foundry.v1.models._does_not_intersect_polygon_query import DoesNotIntersectPolygonQuery # NOQA -from foundry.v1.models._does_not_intersect_polygon_query_dict import ( - DoesNotIntersectPolygonQueryDict, -) # NOQA -from foundry.v1.models._double_type import DoubleType -from foundry.v1.models._double_type_dict import DoubleTypeDict -from foundry.v1.models._duration import Duration -from foundry.v1.models._equals_query import EqualsQuery -from foundry.v1.models._equals_query_dict import EqualsQueryDict -from foundry.v1.models._equals_query_v2 import EqualsQueryV2 -from foundry.v1.models._equals_query_v2_dict import EqualsQueryV2Dict -from foundry.v1.models._error import Error -from foundry.v1.models._error_dict import ErrorDict -from foundry.v1.models._error_name import ErrorName -from foundry.v1.models._exact_distinct_aggregation_v2 import ExactDistinctAggregationV2 -from foundry.v1.models._exact_distinct_aggregation_v2_dict import ( - ExactDistinctAggregationV2Dict, -) # NOQA -from foundry.v1.models._execute_query_request import ExecuteQueryRequest -from foundry.v1.models._execute_query_request_dict import ExecuteQueryRequestDict -from foundry.v1.models._execute_query_response import ExecuteQueryResponse -from foundry.v1.models._execute_query_response_dict import ExecuteQueryResponseDict -from foundry.v1.models._feature import Feature -from foundry.v1.models._feature_collection import FeatureCollection -from foundry.v1.models._feature_collection_dict import FeatureCollectionDict -from foundry.v1.models._feature_collection_types import FeatureCollectionTypes -from foundry.v1.models._feature_collection_types_dict import FeatureCollectionTypesDict -from foundry.v1.models._feature_dict import FeatureDict -from foundry.v1.models._feature_property_key import FeaturePropertyKey -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._file import File -from foundry.v1.models._file_dict import FileDict -from foundry.v1.models._file_path import FilePath -from foundry.v1.models._filename import Filename -from foundry.v1.models._filesystem_resource import FilesystemResource -from foundry.v1.models._filesystem_resource_dict import FilesystemResourceDict -from foundry.v1.models._filter_value import FilterValue -from foundry.v1.models._float_type import FloatType -from foundry.v1.models._float_type_dict import FloatTypeDict -from foundry.v1.models._folder_rid import FolderRid -from foundry.v1.models._function_rid import FunctionRid -from foundry.v1.models._function_version import FunctionVersion -from foundry.v1.models._fuzzy import Fuzzy -from foundry.v1.models._fuzzy_v2 import FuzzyV2 -from foundry.v1.models._geo_json_object import GeoJsonObject -from foundry.v1.models._geo_json_object_dict import GeoJsonObjectDict -from foundry.v1.models._geo_point import GeoPoint -from foundry.v1.models._geo_point_dict import GeoPointDict -from foundry.v1.models._geo_point_type import GeoPointType -from foundry.v1.models._geo_point_type_dict import GeoPointTypeDict -from foundry.v1.models._geo_shape_type import GeoShapeType -from foundry.v1.models._geo_shape_type_dict import GeoShapeTypeDict -from foundry.v1.models._geometry import Geometry -from foundry.v1.models._geometry import GeometryCollection -from foundry.v1.models._geometry_dict import GeometryCollectionDict -from foundry.v1.models._geometry_dict import GeometryDict -from foundry.v1.models._geotime_series_value import GeotimeSeriesValue -from foundry.v1.models._geotime_series_value_dict import GeotimeSeriesValueDict -from foundry.v1.models._group_member_constraint import GroupMemberConstraint -from foundry.v1.models._group_member_constraint_dict import GroupMemberConstraintDict -from foundry.v1.models._gt_query import GtQuery -from foundry.v1.models._gt_query_dict import GtQueryDict -from foundry.v1.models._gt_query_v2 import GtQueryV2 -from foundry.v1.models._gt_query_v2_dict import GtQueryV2Dict -from foundry.v1.models._gte_query import GteQuery -from foundry.v1.models._gte_query_dict import GteQueryDict -from foundry.v1.models._gte_query_v2 import GteQueryV2 -from foundry.v1.models._gte_query_v2_dict import GteQueryV2Dict -from foundry.v1.models._icon import Icon -from foundry.v1.models._icon_dict import IconDict -from foundry.v1.models._integer_type import IntegerType -from foundry.v1.models._integer_type_dict import IntegerTypeDict -from foundry.v1.models._interface_link_type import InterfaceLinkType -from foundry.v1.models._interface_link_type_api_name import InterfaceLinkTypeApiName -from foundry.v1.models._interface_link_type_cardinality import InterfaceLinkTypeCardinality # NOQA -from foundry.v1.models._interface_link_type_dict import InterfaceLinkTypeDict -from foundry.v1.models._interface_link_type_linked_entity_api_name import ( - InterfaceLinkTypeLinkedEntityApiName, -) # NOQA -from foundry.v1.models._interface_link_type_linked_entity_api_name_dict import ( - InterfaceLinkTypeLinkedEntityApiNameDict, -) # NOQA -from foundry.v1.models._interface_link_type_rid import InterfaceLinkTypeRid -from foundry.v1.models._interface_type import InterfaceType -from foundry.v1.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v1.models._interface_type_dict import InterfaceTypeDict -from foundry.v1.models._interface_type_rid import InterfaceTypeRid -from foundry.v1.models._intersects_bounding_box_query import IntersectsBoundingBoxQuery -from foundry.v1.models._intersects_bounding_box_query_dict import ( - IntersectsBoundingBoxQueryDict, -) # NOQA -from foundry.v1.models._intersects_polygon_query import IntersectsPolygonQuery -from foundry.v1.models._intersects_polygon_query_dict import IntersectsPolygonQueryDict -from foundry.v1.models._is_null_query import IsNullQuery -from foundry.v1.models._is_null_query_dict import IsNullQueryDict -from foundry.v1.models._is_null_query_v2 import IsNullQueryV2 -from foundry.v1.models._is_null_query_v2_dict import IsNullQueryV2Dict -from foundry.v1.models._line_string import LineString -from foundry.v1.models._line_string_coordinates import LineStringCoordinates -from foundry.v1.models._line_string_dict import LineStringDict -from foundry.v1.models._linear_ring import LinearRing -from foundry.v1.models._link_side_object import LinkSideObject -from foundry.v1.models._link_side_object_dict import LinkSideObjectDict -from foundry.v1.models._link_type_api_name import LinkTypeApiName -from foundry.v1.models._link_type_rid import LinkTypeRid -from foundry.v1.models._link_type_side import LinkTypeSide -from foundry.v1.models._link_type_side_cardinality import LinkTypeSideCardinality -from foundry.v1.models._link_type_side_dict import LinkTypeSideDict -from foundry.v1.models._link_type_side_v2 import LinkTypeSideV2 -from foundry.v1.models._link_type_side_v2_dict import LinkTypeSideV2Dict -from foundry.v1.models._linked_interface_type_api_name import LinkedInterfaceTypeApiName -from foundry.v1.models._linked_interface_type_api_name_dict import ( - LinkedInterfaceTypeApiNameDict, -) # NOQA -from foundry.v1.models._linked_object_type_api_name import LinkedObjectTypeApiName -from foundry.v1.models._linked_object_type_api_name_dict import LinkedObjectTypeApiNameDict # NOQA -from foundry.v1.models._list_action_types_response import ListActionTypesResponse -from foundry.v1.models._list_action_types_response_dict import ListActionTypesResponseDict # NOQA -from foundry.v1.models._list_action_types_response_v2 import ListActionTypesResponseV2 -from foundry.v1.models._list_action_types_response_v2_dict import ( - ListActionTypesResponseV2Dict, -) # NOQA -from foundry.v1.models._list_attachments_response_v2 import ListAttachmentsResponseV2 -from foundry.v1.models._list_attachments_response_v2_dict import ( - ListAttachmentsResponseV2Dict, -) # NOQA -from foundry.v1.models._list_branches_response import ListBranchesResponse -from foundry.v1.models._list_branches_response_dict import ListBranchesResponseDict -from foundry.v1.models._list_files_response import ListFilesResponse -from foundry.v1.models._list_files_response_dict import ListFilesResponseDict -from foundry.v1.models._list_interface_types_response import ListInterfaceTypesResponse -from foundry.v1.models._list_interface_types_response_dict import ( - ListInterfaceTypesResponseDict, -) # NOQA -from foundry.v1.models._list_linked_objects_response import ListLinkedObjectsResponse -from foundry.v1.models._list_linked_objects_response_dict import ( - ListLinkedObjectsResponseDict, -) # NOQA -from foundry.v1.models._list_linked_objects_response_v2 import ListLinkedObjectsResponseV2 # NOQA -from foundry.v1.models._list_linked_objects_response_v2_dict import ( - ListLinkedObjectsResponseV2Dict, -) # NOQA -from foundry.v1.models._list_object_types_response import ListObjectTypesResponse -from foundry.v1.models._list_object_types_response_dict import ListObjectTypesResponseDict # NOQA -from foundry.v1.models._list_object_types_v2_response import ListObjectTypesV2Response -from foundry.v1.models._list_object_types_v2_response_dict import ( - ListObjectTypesV2ResponseDict, -) # NOQA -from foundry.v1.models._list_objects_response import ListObjectsResponse -from foundry.v1.models._list_objects_response_dict import ListObjectsResponseDict -from foundry.v1.models._list_objects_response_v2 import ListObjectsResponseV2 -from foundry.v1.models._list_objects_response_v2_dict import ListObjectsResponseV2Dict -from foundry.v1.models._list_ontologies_response import ListOntologiesResponse -from foundry.v1.models._list_ontologies_response_dict import ListOntologiesResponseDict -from foundry.v1.models._list_ontologies_v2_response import ListOntologiesV2Response -from foundry.v1.models._list_ontologies_v2_response_dict import ListOntologiesV2ResponseDict # NOQA -from foundry.v1.models._list_outgoing_link_types_response import ( - ListOutgoingLinkTypesResponse, -) # NOQA -from foundry.v1.models._list_outgoing_link_types_response_dict import ( - ListOutgoingLinkTypesResponseDict, -) # NOQA -from foundry.v1.models._list_outgoing_link_types_response_v2 import ( - ListOutgoingLinkTypesResponseV2, -) # NOQA -from foundry.v1.models._list_outgoing_link_types_response_v2_dict import ( - ListOutgoingLinkTypesResponseV2Dict, -) # NOQA -from foundry.v1.models._list_query_types_response import ListQueryTypesResponse -from foundry.v1.models._list_query_types_response_dict import ListQueryTypesResponseDict -from foundry.v1.models._list_query_types_response_v2 import ListQueryTypesResponseV2 -from foundry.v1.models._list_query_types_response_v2_dict import ( - ListQueryTypesResponseV2Dict, -) # NOQA -from foundry.v1.models._load_object_set_request_v2 import LoadObjectSetRequestV2 -from foundry.v1.models._load_object_set_request_v2_dict import LoadObjectSetRequestV2Dict # NOQA -from foundry.v1.models._load_object_set_response_v2 import LoadObjectSetResponseV2 -from foundry.v1.models._load_object_set_response_v2_dict import LoadObjectSetResponseV2Dict # NOQA -from foundry.v1.models._local_file_path import LocalFilePath -from foundry.v1.models._local_file_path_dict import LocalFilePathDict -from foundry.v1.models._logic_rule import LogicRule -from foundry.v1.models._logic_rule_dict import LogicRuleDict -from foundry.v1.models._long_type import LongType -from foundry.v1.models._long_type_dict import LongTypeDict -from foundry.v1.models._lt_query import LtQuery -from foundry.v1.models._lt_query_dict import LtQueryDict -from foundry.v1.models._lt_query_v2 import LtQueryV2 -from foundry.v1.models._lt_query_v2_dict import LtQueryV2Dict -from foundry.v1.models._lte_query import LteQuery -from foundry.v1.models._lte_query_dict import LteQueryDict -from foundry.v1.models._lte_query_v2 import LteQueryV2 -from foundry.v1.models._lte_query_v2_dict import LteQueryV2Dict -from foundry.v1.models._marking_type import MarkingType -from foundry.v1.models._marking_type_dict import MarkingTypeDict -from foundry.v1.models._max_aggregation import MaxAggregation -from foundry.v1.models._max_aggregation_dict import MaxAggregationDict -from foundry.v1.models._max_aggregation_v2 import MaxAggregationV2 -from foundry.v1.models._max_aggregation_v2_dict import MaxAggregationV2Dict -from foundry.v1.models._media_type import MediaType -from foundry.v1.models._min_aggregation import MinAggregation -from foundry.v1.models._min_aggregation_dict import MinAggregationDict -from foundry.v1.models._min_aggregation_v2 import MinAggregationV2 -from foundry.v1.models._min_aggregation_v2_dict import MinAggregationV2Dict -from foundry.v1.models._modify_object import ModifyObject -from foundry.v1.models._modify_object_dict import ModifyObjectDict -from foundry.v1.models._modify_object_rule import ModifyObjectRule -from foundry.v1.models._modify_object_rule_dict import ModifyObjectRuleDict -from foundry.v1.models._multi_line_string import MultiLineString -from foundry.v1.models._multi_line_string_dict import MultiLineStringDict -from foundry.v1.models._multi_point import MultiPoint -from foundry.v1.models._multi_point_dict import MultiPointDict -from foundry.v1.models._multi_polygon import MultiPolygon -from foundry.v1.models._multi_polygon_dict import MultiPolygonDict -from foundry.v1.models._nested_query_aggregation import NestedQueryAggregation -from foundry.v1.models._nested_query_aggregation_dict import NestedQueryAggregationDict -from foundry.v1.models._null_type import NullType -from foundry.v1.models._null_type_dict import NullTypeDict -from foundry.v1.models._object_edit import ObjectEdit -from foundry.v1.models._object_edit_dict import ObjectEditDict -from foundry.v1.models._object_edits import ObjectEdits -from foundry.v1.models._object_edits_dict import ObjectEditsDict -from foundry.v1.models._object_primary_key import ObjectPrimaryKey -from foundry.v1.models._object_property_type import ObjectPropertyType -from foundry.v1.models._object_property_type import OntologyObjectArrayType -from foundry.v1.models._object_property_type_dict import ObjectPropertyTypeDict -from foundry.v1.models._object_property_type_dict import OntologyObjectArrayTypeDict -from foundry.v1.models._object_property_value_constraint import ( - ObjectPropertyValueConstraint, -) # NOQA -from foundry.v1.models._object_property_value_constraint_dict import ( - ObjectPropertyValueConstraintDict, -) # NOQA -from foundry.v1.models._object_query_result_constraint import ObjectQueryResultConstraint # NOQA -from foundry.v1.models._object_query_result_constraint_dict import ( - ObjectQueryResultConstraintDict, -) # NOQA -from foundry.v1.models._object_rid import ObjectRid -from foundry.v1.models._object_set import ObjectSet -from foundry.v1.models._object_set import ObjectSetFilterType -from foundry.v1.models._object_set import ObjectSetIntersectionType -from foundry.v1.models._object_set import ObjectSetSearchAroundType -from foundry.v1.models._object_set import ObjectSetSubtractType -from foundry.v1.models._object_set import ObjectSetUnionType -from foundry.v1.models._object_set_base_type import ObjectSetBaseType -from foundry.v1.models._object_set_base_type_dict import ObjectSetBaseTypeDict -from foundry.v1.models._object_set_dict import ObjectSetDict -from foundry.v1.models._object_set_dict import ObjectSetFilterTypeDict -from foundry.v1.models._object_set_dict import ObjectSetIntersectionTypeDict -from foundry.v1.models._object_set_dict import ObjectSetSearchAroundTypeDict -from foundry.v1.models._object_set_dict import ObjectSetSubtractTypeDict -from foundry.v1.models._object_set_dict import ObjectSetUnionTypeDict -from foundry.v1.models._object_set_reference_type import ObjectSetReferenceType -from foundry.v1.models._object_set_reference_type_dict import ObjectSetReferenceTypeDict -from foundry.v1.models._object_set_rid import ObjectSetRid -from foundry.v1.models._object_set_static_type import ObjectSetStaticType -from foundry.v1.models._object_set_static_type_dict import ObjectSetStaticTypeDict -from foundry.v1.models._object_set_stream_subscribe_request import ( - ObjectSetStreamSubscribeRequest, -) # NOQA -from foundry.v1.models._object_set_stream_subscribe_request_dict import ( - ObjectSetStreamSubscribeRequestDict, -) # NOQA -from foundry.v1.models._object_set_stream_subscribe_requests import ( - ObjectSetStreamSubscribeRequests, -) # NOQA -from foundry.v1.models._object_set_stream_subscribe_requests_dict import ( - ObjectSetStreamSubscribeRequestsDict, -) # NOQA -from foundry.v1.models._object_set_subscribe_response import ObjectSetSubscribeResponse -from foundry.v1.models._object_set_subscribe_response_dict import ( - ObjectSetSubscribeResponseDict, -) # NOQA -from foundry.v1.models._object_set_subscribe_responses import ObjectSetSubscribeResponses # NOQA -from foundry.v1.models._object_set_subscribe_responses_dict import ( - ObjectSetSubscribeResponsesDict, -) # NOQA -from foundry.v1.models._object_set_update import ObjectSetUpdate -from foundry.v1.models._object_set_update_dict import ObjectSetUpdateDict -from foundry.v1.models._object_set_updates import ObjectSetUpdates -from foundry.v1.models._object_set_updates_dict import ObjectSetUpdatesDict -from foundry.v1.models._object_state import ObjectState -from foundry.v1.models._object_type import ObjectType -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._object_type_dict import ObjectTypeDict -from foundry.v1.models._object_type_edits import ObjectTypeEdits -from foundry.v1.models._object_type_edits_dict import ObjectTypeEditsDict -from foundry.v1.models._object_type_full_metadata import ObjectTypeFullMetadata -from foundry.v1.models._object_type_full_metadata_dict import ObjectTypeFullMetadataDict -from foundry.v1.models._object_type_interface_implementation import ( - ObjectTypeInterfaceImplementation, -) # NOQA -from foundry.v1.models._object_type_interface_implementation_dict import ( - ObjectTypeInterfaceImplementationDict, -) # NOQA -from foundry.v1.models._object_type_rid import ObjectTypeRid -from foundry.v1.models._object_type_v2 import ObjectTypeV2 -from foundry.v1.models._object_type_v2_dict import ObjectTypeV2Dict -from foundry.v1.models._object_type_visibility import ObjectTypeVisibility -from foundry.v1.models._object_update import ObjectUpdate -from foundry.v1.models._object_update_dict import ObjectUpdateDict -from foundry.v1.models._one_of_constraint import OneOfConstraint -from foundry.v1.models._one_of_constraint_dict import OneOfConstraintDict -from foundry.v1.models._ontology import Ontology -from foundry.v1.models._ontology_api_name import OntologyApiName -from foundry.v1.models._ontology_data_type import OntologyArrayType -from foundry.v1.models._ontology_data_type import OntologyDataType -from foundry.v1.models._ontology_data_type import OntologyMapType -from foundry.v1.models._ontology_data_type import OntologySetType -from foundry.v1.models._ontology_data_type import OntologyStructField -from foundry.v1.models._ontology_data_type import OntologyStructType -from foundry.v1.models._ontology_data_type_dict import OntologyArrayTypeDict -from foundry.v1.models._ontology_data_type_dict import OntologyDataTypeDict -from foundry.v1.models._ontology_data_type_dict import OntologyMapTypeDict -from foundry.v1.models._ontology_data_type_dict import OntologySetTypeDict -from foundry.v1.models._ontology_data_type_dict import OntologyStructFieldDict -from foundry.v1.models._ontology_data_type_dict import OntologyStructTypeDict -from foundry.v1.models._ontology_dict import OntologyDict -from foundry.v1.models._ontology_full_metadata import OntologyFullMetadata -from foundry.v1.models._ontology_full_metadata_dict import OntologyFullMetadataDict -from foundry.v1.models._ontology_identifier import OntologyIdentifier -from foundry.v1.models._ontology_object import OntologyObject -from foundry.v1.models._ontology_object_dict import OntologyObjectDict -from foundry.v1.models._ontology_object_set_type import OntologyObjectSetType -from foundry.v1.models._ontology_object_set_type_dict import OntologyObjectSetTypeDict -from foundry.v1.models._ontology_object_type import OntologyObjectType -from foundry.v1.models._ontology_object_type_dict import OntologyObjectTypeDict -from foundry.v1.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v1.models._ontology_rid import OntologyRid -from foundry.v1.models._ontology_v2 import OntologyV2 -from foundry.v1.models._ontology_v2_dict import OntologyV2Dict -from foundry.v1.models._order_by import OrderBy -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._parameter import Parameter -from foundry.v1.models._parameter_dict import ParameterDict -from foundry.v1.models._parameter_evaluated_constraint import ParameterEvaluatedConstraint # NOQA -from foundry.v1.models._parameter_evaluated_constraint_dict import ( - ParameterEvaluatedConstraintDict, -) # NOQA -from foundry.v1.models._parameter_evaluation_result import ParameterEvaluationResult -from foundry.v1.models._parameter_evaluation_result_dict import ( - ParameterEvaluationResultDict, -) # NOQA -from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._parameter_option import ParameterOption -from foundry.v1.models._parameter_option_dict import ParameterOptionDict -from foundry.v1.models._phrase_query import PhraseQuery -from foundry.v1.models._phrase_query_dict import PhraseQueryDict -from foundry.v1.models._polygon import Polygon -from foundry.v1.models._polygon_dict import PolygonDict -from foundry.v1.models._polygon_value import PolygonValue -from foundry.v1.models._polygon_value_dict import PolygonValueDict -from foundry.v1.models._position import Position -from foundry.v1.models._prefix_query import PrefixQuery -from foundry.v1.models._prefix_query_dict import PrefixQueryDict -from foundry.v1.models._preview_mode import PreviewMode -from foundry.v1.models._primary_key_value import PrimaryKeyValue -from foundry.v1.models._property import Property -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_dict import PropertyDict -from foundry.v1.models._property_filter import PropertyFilter -from foundry.v1.models._property_id import PropertyId -from foundry.v1.models._property_v2 import PropertyV2 -from foundry.v1.models._property_v2_dict import PropertyV2Dict -from foundry.v1.models._property_value import PropertyValue -from foundry.v1.models._property_value_escaped_string import PropertyValueEscapedString -from foundry.v1.models._qos_error import QosError -from foundry.v1.models._qos_error_dict import QosErrorDict -from foundry.v1.models._query_aggregation import QueryAggregation -from foundry.v1.models._query_aggregation_dict import QueryAggregationDict -from foundry.v1.models._query_aggregation_key_type import QueryAggregationKeyType -from foundry.v1.models._query_aggregation_key_type_dict import QueryAggregationKeyTypeDict # NOQA -from foundry.v1.models._query_aggregation_range import QueryAggregationRange -from foundry.v1.models._query_aggregation_range_dict import QueryAggregationRangeDict -from foundry.v1.models._query_aggregation_range_sub_type import QueryAggregationRangeSubType # NOQA -from foundry.v1.models._query_aggregation_range_sub_type_dict import ( - QueryAggregationRangeSubTypeDict, -) # NOQA -from foundry.v1.models._query_aggregation_range_type import QueryAggregationRangeType -from foundry.v1.models._query_aggregation_range_type_dict import ( - QueryAggregationRangeTypeDict, -) # NOQA -from foundry.v1.models._query_aggregation_value_type import QueryAggregationValueType -from foundry.v1.models._query_aggregation_value_type_dict import ( - QueryAggregationValueTypeDict, -) # NOQA -from foundry.v1.models._query_api_name import QueryApiName -from foundry.v1.models._query_data_type import QueryArrayType -from foundry.v1.models._query_data_type import QueryDataType -from foundry.v1.models._query_data_type import QuerySetType -from foundry.v1.models._query_data_type import QueryStructField -from foundry.v1.models._query_data_type import QueryStructType -from foundry.v1.models._query_data_type import QueryUnionType -from foundry.v1.models._query_data_type_dict import QueryArrayTypeDict -from foundry.v1.models._query_data_type_dict import QueryDataTypeDict -from foundry.v1.models._query_data_type_dict import QuerySetTypeDict -from foundry.v1.models._query_data_type_dict import QueryStructFieldDict -from foundry.v1.models._query_data_type_dict import QueryStructTypeDict -from foundry.v1.models._query_data_type_dict import QueryUnionTypeDict -from foundry.v1.models._query_output_v2 import QueryOutputV2 -from foundry.v1.models._query_output_v2_dict import QueryOutputV2Dict -from foundry.v1.models._query_parameter_v2 import QueryParameterV2 -from foundry.v1.models._query_parameter_v2_dict import QueryParameterV2Dict -from foundry.v1.models._query_runtime_error_parameter import QueryRuntimeErrorParameter -from foundry.v1.models._query_three_dimensional_aggregation import ( - QueryThreeDimensionalAggregation, -) # NOQA -from foundry.v1.models._query_three_dimensional_aggregation_dict import ( - QueryThreeDimensionalAggregationDict, -) # NOQA -from foundry.v1.models._query_two_dimensional_aggregation import ( - QueryTwoDimensionalAggregation, -) # NOQA -from foundry.v1.models._query_two_dimensional_aggregation_dict import ( - QueryTwoDimensionalAggregationDict, -) # NOQA -from foundry.v1.models._query_type import QueryType -from foundry.v1.models._query_type_dict import QueryTypeDict -from foundry.v1.models._query_type_v2 import QueryTypeV2 -from foundry.v1.models._query_type_v2_dict import QueryTypeV2Dict -from foundry.v1.models._range_constraint import RangeConstraint -from foundry.v1.models._range_constraint_dict import RangeConstraintDict -from foundry.v1.models._reason import Reason -from foundry.v1.models._reason_dict import ReasonDict -from foundry.v1.models._reason_type import ReasonType -from foundry.v1.models._reference_update import ReferenceUpdate -from foundry.v1.models._reference_update_dict import ReferenceUpdateDict -from foundry.v1.models._reference_value import ReferenceValue -from foundry.v1.models._reference_value_dict import ReferenceValueDict -from foundry.v1.models._refresh_object_set import RefreshObjectSet -from foundry.v1.models._refresh_object_set_dict import RefreshObjectSetDict -from foundry.v1.models._relative_time import RelativeTime -from foundry.v1.models._relative_time_dict import RelativeTimeDict -from foundry.v1.models._relative_time_range import RelativeTimeRange -from foundry.v1.models._relative_time_range_dict import RelativeTimeRangeDict -from foundry.v1.models._relative_time_relation import RelativeTimeRelation -from foundry.v1.models._relative_time_series_time_unit import RelativeTimeSeriesTimeUnit -from foundry.v1.models._release_status import ReleaseStatus -from foundry.v1.models._request_id import RequestId -from foundry.v1.models._resource_path import ResourcePath -from foundry.v1.models._return_edits_mode import ReturnEditsMode -from foundry.v1.models._sdk_package_name import SdkPackageName -from foundry.v1.models._search_json_query import AndQuery -from foundry.v1.models._search_json_query import NotQuery -from foundry.v1.models._search_json_query import OrQuery -from foundry.v1.models._search_json_query import SearchJsonQuery -from foundry.v1.models._search_json_query_dict import AndQueryDict -from foundry.v1.models._search_json_query_dict import NotQueryDict -from foundry.v1.models._search_json_query_dict import OrQueryDict -from foundry.v1.models._search_json_query_dict import SearchJsonQueryDict -from foundry.v1.models._search_json_query_v2 import AndQueryV2 -from foundry.v1.models._search_json_query_v2 import NotQueryV2 -from foundry.v1.models._search_json_query_v2 import OrQueryV2 -from foundry.v1.models._search_json_query_v2 import SearchJsonQueryV2 -from foundry.v1.models._search_json_query_v2_dict import AndQueryV2Dict -from foundry.v1.models._search_json_query_v2_dict import NotQueryV2Dict -from foundry.v1.models._search_json_query_v2_dict import OrQueryV2Dict -from foundry.v1.models._search_json_query_v2_dict import SearchJsonQueryV2Dict -from foundry.v1.models._search_objects_for_interface_request import ( - SearchObjectsForInterfaceRequest, -) # NOQA -from foundry.v1.models._search_objects_for_interface_request_dict import ( - SearchObjectsForInterfaceRequestDict, -) # NOQA -from foundry.v1.models._search_objects_request import SearchObjectsRequest -from foundry.v1.models._search_objects_request_dict import SearchObjectsRequestDict -from foundry.v1.models._search_objects_request_v2 import SearchObjectsRequestV2 -from foundry.v1.models._search_objects_request_v2_dict import SearchObjectsRequestV2Dict -from foundry.v1.models._search_objects_response import SearchObjectsResponse -from foundry.v1.models._search_objects_response_dict import SearchObjectsResponseDict -from foundry.v1.models._search_objects_response_v2 import SearchObjectsResponseV2 -from foundry.v1.models._search_objects_response_v2_dict import SearchObjectsResponseV2Dict # NOQA -from foundry.v1.models._search_order_by import SearchOrderBy -from foundry.v1.models._search_order_by_dict import SearchOrderByDict -from foundry.v1.models._search_order_by_v2 import SearchOrderByV2 -from foundry.v1.models._search_order_by_v2_dict import SearchOrderByV2Dict -from foundry.v1.models._search_ordering import SearchOrdering -from foundry.v1.models._search_ordering_dict import SearchOrderingDict -from foundry.v1.models._search_ordering_v2 import SearchOrderingV2 -from foundry.v1.models._search_ordering_v2_dict import SearchOrderingV2Dict -from foundry.v1.models._selected_property_api_name import SelectedPropertyApiName -from foundry.v1.models._shared_property_type import SharedPropertyType -from foundry.v1.models._shared_property_type_api_name import SharedPropertyTypeApiName -from foundry.v1.models._shared_property_type_dict import SharedPropertyTypeDict -from foundry.v1.models._shared_property_type_rid import SharedPropertyTypeRid -from foundry.v1.models._short_type import ShortType -from foundry.v1.models._short_type_dict import ShortTypeDict -from foundry.v1.models._size_bytes import SizeBytes -from foundry.v1.models._starts_with_query import StartsWithQuery -from foundry.v1.models._starts_with_query_dict import StartsWithQueryDict -from foundry.v1.models._stream_message import StreamMessage -from foundry.v1.models._stream_message_dict import StreamMessageDict -from foundry.v1.models._stream_time_series_points_request import ( - StreamTimeSeriesPointsRequest, -) # NOQA -from foundry.v1.models._stream_time_series_points_request_dict import ( - StreamTimeSeriesPointsRequestDict, -) # NOQA -from foundry.v1.models._stream_time_series_points_response import ( - StreamTimeSeriesPointsResponse, -) # NOQA -from foundry.v1.models._stream_time_series_points_response_dict import ( - StreamTimeSeriesPointsResponseDict, -) # NOQA -from foundry.v1.models._string_length_constraint import StringLengthConstraint -from foundry.v1.models._string_length_constraint_dict import StringLengthConstraintDict -from foundry.v1.models._string_regex_match_constraint import StringRegexMatchConstraint -from foundry.v1.models._string_regex_match_constraint_dict import ( - StringRegexMatchConstraintDict, -) # NOQA -from foundry.v1.models._string_type import StringType -from foundry.v1.models._string_type_dict import StringTypeDict -from foundry.v1.models._struct_field_name import StructFieldName -from foundry.v1.models._submission_criteria_evaluation import SubmissionCriteriaEvaluation # NOQA -from foundry.v1.models._submission_criteria_evaluation_dict import ( - SubmissionCriteriaEvaluationDict, -) # NOQA -from foundry.v1.models._subscription_closed import SubscriptionClosed -from foundry.v1.models._subscription_closed_dict import SubscriptionClosedDict -from foundry.v1.models._subscription_closure_cause import SubscriptionClosureCause -from foundry.v1.models._subscription_closure_cause_dict import SubscriptionClosureCauseDict # NOQA -from foundry.v1.models._subscription_error import SubscriptionError -from foundry.v1.models._subscription_error_dict import SubscriptionErrorDict -from foundry.v1.models._subscription_id import SubscriptionId -from foundry.v1.models._subscription_success import SubscriptionSuccess -from foundry.v1.models._subscription_success_dict import SubscriptionSuccessDict -from foundry.v1.models._sum_aggregation import SumAggregation -from foundry.v1.models._sum_aggregation_dict import SumAggregationDict -from foundry.v1.models._sum_aggregation_v2 import SumAggregationV2 -from foundry.v1.models._sum_aggregation_v2_dict import SumAggregationV2Dict -from foundry.v1.models._sync_apply_action_response_v2 import SyncApplyActionResponseV2 -from foundry.v1.models._sync_apply_action_response_v2_dict import ( - SyncApplyActionResponseV2Dict, -) # NOQA -from foundry.v1.models._table_export_format import TableExportFormat -from foundry.v1.models._three_dimensional_aggregation import ThreeDimensionalAggregation -from foundry.v1.models._three_dimensional_aggregation_dict import ( - ThreeDimensionalAggregationDict, -) # NOQA -from foundry.v1.models._time_range import TimeRange -from foundry.v1.models._time_range_dict import TimeRangeDict -from foundry.v1.models._time_series_item_type import TimeSeriesItemType -from foundry.v1.models._time_series_item_type_dict import TimeSeriesItemTypeDict -from foundry.v1.models._time_series_point import TimeSeriesPoint -from foundry.v1.models._time_series_point_dict import TimeSeriesPointDict -from foundry.v1.models._time_unit import TimeUnit -from foundry.v1.models._timeseries_type import TimeseriesType -from foundry.v1.models._timeseries_type_dict import TimeseriesTypeDict -from foundry.v1.models._timestamp_type import TimestampType -from foundry.v1.models._timestamp_type_dict import TimestampTypeDict -from foundry.v1.models._total_count import TotalCount -from foundry.v1.models._transaction import Transaction -from foundry.v1.models._transaction_dict import TransactionDict -from foundry.v1.models._transaction_rid import TransactionRid -from foundry.v1.models._transaction_status import TransactionStatus -from foundry.v1.models._transaction_type import TransactionType -from foundry.v1.models._two_dimensional_aggregation import TwoDimensionalAggregation -from foundry.v1.models._two_dimensional_aggregation_dict import ( - TwoDimensionalAggregationDict, -) # NOQA -from foundry.v1.models._unevaluable_constraint import UnevaluableConstraint -from foundry.v1.models._unevaluable_constraint_dict import UnevaluableConstraintDict -from foundry.v1.models._unsupported_type import UnsupportedType -from foundry.v1.models._unsupported_type_dict import UnsupportedTypeDict -from foundry.v1.models._updated_time import UpdatedTime -from foundry.v1.models._user_id import UserId -from foundry.v1.models._validate_action_request import ValidateActionRequest -from foundry.v1.models._validate_action_request_dict import ValidateActionRequestDict -from foundry.v1.models._validate_action_response import ValidateActionResponse -from foundry.v1.models._validate_action_response_dict import ValidateActionResponseDict -from foundry.v1.models._validate_action_response_v2 import ValidateActionResponseV2 -from foundry.v1.models._validate_action_response_v2_dict import ValidateActionResponseV2Dict # NOQA -from foundry.v1.models._validation_result import ValidationResult -from foundry.v1.models._value_type import ValueType -from foundry.v1.models._within_bounding_box_point import WithinBoundingBoxPoint -from foundry.v1.models._within_bounding_box_point_dict import WithinBoundingBoxPointDict -from foundry.v1.models._within_bounding_box_query import WithinBoundingBoxQuery -from foundry.v1.models._within_bounding_box_query_dict import WithinBoundingBoxQueryDict -from foundry.v1.models._within_distance_of_query import WithinDistanceOfQuery -from foundry.v1.models._within_distance_of_query_dict import WithinDistanceOfQueryDict -from foundry.v1.models._within_polygon_query import WithinPolygonQuery -from foundry.v1.models._within_polygon_query_dict import WithinPolygonQueryDict - -__all__ = [ - "AbsoluteTimeRange", - "AbsoluteTimeRangeDict", - "ActionMode", - "ActionParameterArrayType", - "ActionParameterArrayTypeDict", - "ActionParameterType", - "ActionParameterTypeDict", - "ActionParameterV2", - "ActionParameterV2Dict", - "ActionResults", - "ActionResultsDict", - "ActionRid", - "ActionType", - "ActionTypeApiName", - "ActionTypeDict", - "ActionTypeRid", - "ActionTypeV2", - "ActionTypeV2Dict", - "AddLink", - "AddLinkDict", - "AddObject", - "AddObjectDict", - "AggregateObjectSetRequestV2", - "AggregateObjectSetRequestV2Dict", - "AggregateObjectsRequest", - "AggregateObjectsRequestDict", - "AggregateObjectsRequestV2", - "AggregateObjectsRequestV2Dict", - "AggregateObjectsResponse", - "AggregateObjectsResponseDict", - "AggregateObjectsResponseItem", - "AggregateObjectsResponseItemDict", - "AggregateObjectsResponseItemV2", - "AggregateObjectsResponseItemV2Dict", - "AggregateObjectsResponseV2", - "AggregateObjectsResponseV2Dict", - "Aggregation", - "AggregationAccuracy", - "AggregationAccuracyRequest", - "AggregationDict", - "AggregationDurationGrouping", - "AggregationDurationGroupingDict", - "AggregationDurationGroupingV2", - "AggregationDurationGroupingV2Dict", - "AggregationExactGrouping", - "AggregationExactGroupingDict", - "AggregationExactGroupingV2", - "AggregationExactGroupingV2Dict", - "AggregationFixedWidthGrouping", - "AggregationFixedWidthGroupingDict", - "AggregationFixedWidthGroupingV2", - "AggregationFixedWidthGroupingV2Dict", - "AggregationGroupBy", - "AggregationGroupByDict", - "AggregationGroupByV2", - "AggregationGroupByV2Dict", - "AggregationGroupKey", - "AggregationGroupKeyV2", - "AggregationGroupValue", - "AggregationGroupValueV2", - "AggregationMetricName", - "AggregationMetricResult", - "AggregationMetricResultDict", - "AggregationMetricResultV2", - "AggregationMetricResultV2Dict", - "AggregationObjectTypeGrouping", - "AggregationObjectTypeGroupingDict", - "AggregationOrderBy", - "AggregationOrderByDict", - "AggregationRange", - "AggregationRangeDict", - "AggregationRangesGrouping", - "AggregationRangesGroupingDict", - "AggregationRangesGroupingV2", - "AggregationRangesGroupingV2Dict", - "AggregationRangeV2", - "AggregationRangeV2Dict", - "AggregationV2", - "AggregationV2Dict", - "AllTermsQuery", - "AllTermsQueryDict", - "AndQuery", - "AndQueryDict", - "AndQueryV2", - "AndQueryV2Dict", - "AnyTermQuery", - "AnyTermQueryDict", - "AnyType", - "AnyTypeDict", - "ApplyActionMode", - "ApplyActionRequest", - "ApplyActionRequestDict", - "ApplyActionRequestOptions", - "ApplyActionRequestOptionsDict", - "ApplyActionRequestV2", - "ApplyActionRequestV2Dict", - "ApplyActionResponse", - "ApplyActionResponseDict", - "ApproximateDistinctAggregation", - "ApproximateDistinctAggregationDict", - "ApproximateDistinctAggregationV2", - "ApproximateDistinctAggregationV2Dict", - "ApproximatePercentileAggregationV2", - "ApproximatePercentileAggregationV2Dict", - "ArchiveFileFormat", - "Arg", - "ArgDict", - "ArraySizeConstraint", - "ArraySizeConstraintDict", - "ArtifactRepositoryRid", - "AsyncActionStatus", - "AsyncApplyActionOperationResponseV2", - "AsyncApplyActionOperationResponseV2Dict", - "AsyncApplyActionRequest", - "AsyncApplyActionRequestDict", - "AsyncApplyActionRequestV2", - "AsyncApplyActionRequestV2Dict", - "AsyncApplyActionResponse", - "AsyncApplyActionResponseDict", - "AsyncApplyActionResponseV2", - "AsyncApplyActionResponseV2Dict", - "Attachment", - "AttachmentDict", - "AttachmentMetadataResponse", - "AttachmentMetadataResponseDict", - "AttachmentProperty", - "AttachmentPropertyDict", - "AttachmentRid", - "AttachmentType", - "AttachmentTypeDict", - "AttachmentV2", - "AttachmentV2Dict", - "AvgAggregation", - "AvgAggregationDict", - "AvgAggregationV2", - "AvgAggregationV2Dict", - "BatchApplyActionRequest", - "BatchApplyActionRequestDict", - "BatchApplyActionRequestItem", - "BatchApplyActionRequestItemDict", - "BatchApplyActionRequestOptions", - "BatchApplyActionRequestOptionsDict", - "BatchApplyActionRequestV2", - "BatchApplyActionRequestV2Dict", - "BatchApplyActionResponse", - "BatchApplyActionResponseDict", - "BatchApplyActionResponseV2", - "BatchApplyActionResponseV2Dict", - "BBox", - "BinaryType", - "BinaryTypeDict", - "BlueprintIcon", - "BlueprintIconDict", - "BooleanType", - "BooleanTypeDict", - "BoundingBoxValue", - "BoundingBoxValueDict", - "Branch", - "BranchDict", - "BranchId", - "ByteType", - "ByteTypeDict", - "CenterPoint", - "CenterPointDict", - "CenterPointTypes", - "CenterPointTypesDict", - "ContainsAllTermsInOrderPrefixLastTerm", - "ContainsAllTermsInOrderPrefixLastTermDict", - "ContainsAllTermsInOrderQuery", - "ContainsAllTermsInOrderQueryDict", - "ContainsAllTermsQuery", - "ContainsAllTermsQueryDict", - "ContainsAnyTermQuery", - "ContainsAnyTermQueryDict", - "ContainsQuery", - "ContainsQueryDict", - "ContainsQueryV2", - "ContainsQueryV2Dict", - "ContentLength", - "ContentType", - "Coordinate", - "CountAggregation", - "CountAggregationDict", - "CountAggregationV2", - "CountAggregationV2Dict", - "CountObjectsResponseV2", - "CountObjectsResponseV2Dict", - "CreateBranchRequest", - "CreateBranchRequestDict", - "CreateDatasetRequest", - "CreateDatasetRequestDict", - "CreatedTime", - "CreateLinkRule", - "CreateLinkRuleDict", - "CreateObjectRule", - "CreateObjectRuleDict", - "CreateTemporaryObjectSetRequestV2", - "CreateTemporaryObjectSetRequestV2Dict", - "CreateTemporaryObjectSetResponseV2", - "CreateTemporaryObjectSetResponseV2Dict", - "CreateTransactionRequest", - "CreateTransactionRequestDict", - "CustomTypeId", - "Dataset", - "DatasetDict", - "DatasetName", - "DatasetRid", - "DataValue", - "DateType", - "DateTypeDict", - "DecimalType", - "DecimalTypeDict", - "DeleteLinkRule", - "DeleteLinkRuleDict", - "DeleteObjectRule", - "DeleteObjectRuleDict", - "DisplayName", - "Distance", - "DistanceDict", - "DistanceUnit", - "DoesNotIntersectBoundingBoxQuery", - "DoesNotIntersectBoundingBoxQueryDict", - "DoesNotIntersectPolygonQuery", - "DoesNotIntersectPolygonQueryDict", - "DoubleType", - "DoubleTypeDict", - "Duration", - "EqualsQuery", - "EqualsQueryDict", - "EqualsQueryV2", - "EqualsQueryV2Dict", - "Error", - "ErrorDict", - "ErrorName", - "ExactDistinctAggregationV2", - "ExactDistinctAggregationV2Dict", - "ExecuteQueryRequest", - "ExecuteQueryRequestDict", - "ExecuteQueryResponse", - "ExecuteQueryResponseDict", - "Feature", - "FeatureCollection", - "FeatureCollectionDict", - "FeatureCollectionTypes", - "FeatureCollectionTypesDict", - "FeatureDict", - "FeaturePropertyKey", - "FieldNameV1", - "File", - "FileDict", - "Filename", - "FilePath", - "FilesystemResource", - "FilesystemResourceDict", - "FilterValue", - "FloatType", - "FloatTypeDict", - "FolderRid", - "FunctionRid", - "FunctionVersion", - "Fuzzy", - "FuzzyV2", - "GeoJsonObject", - "GeoJsonObjectDict", - "Geometry", - "GeometryCollection", - "GeometryCollectionDict", - "GeometryDict", - "GeoPoint", - "GeoPointDict", - "GeoPointType", - "GeoPointTypeDict", - "GeoShapeType", - "GeoShapeTypeDict", - "GeotimeSeriesValue", - "GeotimeSeriesValueDict", - "GroupMemberConstraint", - "GroupMemberConstraintDict", - "GteQuery", - "GteQueryDict", - "GteQueryV2", - "GteQueryV2Dict", - "GtQuery", - "GtQueryDict", - "GtQueryV2", - "GtQueryV2Dict", - "Icon", - "IconDict", - "IntegerType", - "IntegerTypeDict", - "InterfaceLinkType", - "InterfaceLinkTypeApiName", - "InterfaceLinkTypeCardinality", - "InterfaceLinkTypeDict", - "InterfaceLinkTypeLinkedEntityApiName", - "InterfaceLinkTypeLinkedEntityApiNameDict", - "InterfaceLinkTypeRid", - "InterfaceType", - "InterfaceTypeApiName", - "InterfaceTypeDict", - "InterfaceTypeRid", - "IntersectsBoundingBoxQuery", - "IntersectsBoundingBoxQueryDict", - "IntersectsPolygonQuery", - "IntersectsPolygonQueryDict", - "IsNullQuery", - "IsNullQueryDict", - "IsNullQueryV2", - "IsNullQueryV2Dict", - "LinearRing", - "LineString", - "LineStringCoordinates", - "LineStringDict", - "LinkedInterfaceTypeApiName", - "LinkedInterfaceTypeApiNameDict", - "LinkedObjectTypeApiName", - "LinkedObjectTypeApiNameDict", - "LinkSideObject", - "LinkSideObjectDict", - "LinkTypeApiName", - "LinkTypeRid", - "LinkTypeSide", - "LinkTypeSideCardinality", - "LinkTypeSideDict", - "LinkTypeSideV2", - "LinkTypeSideV2Dict", - "ListActionTypesResponse", - "ListActionTypesResponseDict", - "ListActionTypesResponseV2", - "ListActionTypesResponseV2Dict", - "ListAttachmentsResponseV2", - "ListAttachmentsResponseV2Dict", - "ListBranchesResponse", - "ListBranchesResponseDict", - "ListFilesResponse", - "ListFilesResponseDict", - "ListInterfaceTypesResponse", - "ListInterfaceTypesResponseDict", - "ListLinkedObjectsResponse", - "ListLinkedObjectsResponseDict", - "ListLinkedObjectsResponseV2", - "ListLinkedObjectsResponseV2Dict", - "ListObjectsResponse", - "ListObjectsResponseDict", - "ListObjectsResponseV2", - "ListObjectsResponseV2Dict", - "ListObjectTypesResponse", - "ListObjectTypesResponseDict", - "ListObjectTypesV2Response", - "ListObjectTypesV2ResponseDict", - "ListOntologiesResponse", - "ListOntologiesResponseDict", - "ListOntologiesV2Response", - "ListOntologiesV2ResponseDict", - "ListOutgoingLinkTypesResponse", - "ListOutgoingLinkTypesResponseDict", - "ListOutgoingLinkTypesResponseV2", - "ListOutgoingLinkTypesResponseV2Dict", - "ListQueryTypesResponse", - "ListQueryTypesResponseDict", - "ListQueryTypesResponseV2", - "ListQueryTypesResponseV2Dict", - "LoadObjectSetRequestV2", - "LoadObjectSetRequestV2Dict", - "LoadObjectSetResponseV2", - "LoadObjectSetResponseV2Dict", - "LocalFilePath", - "LocalFilePathDict", - "LogicRule", - "LogicRuleDict", - "LongType", - "LongTypeDict", - "LteQuery", - "LteQueryDict", - "LteQueryV2", - "LteQueryV2Dict", - "LtQuery", - "LtQueryDict", - "LtQueryV2", - "LtQueryV2Dict", - "MarkingType", - "MarkingTypeDict", - "MaxAggregation", - "MaxAggregationDict", - "MaxAggregationV2", - "MaxAggregationV2Dict", - "MediaType", - "MinAggregation", - "MinAggregationDict", - "MinAggregationV2", - "MinAggregationV2Dict", - "ModifyObject", - "ModifyObjectDict", - "ModifyObjectRule", - "ModifyObjectRuleDict", - "MultiLineString", - "MultiLineStringDict", - "MultiPoint", - "MultiPointDict", - "MultiPolygon", - "MultiPolygonDict", - "NestedQueryAggregation", - "NestedQueryAggregationDict", - "NotQuery", - "NotQueryDict", - "NotQueryV2", - "NotQueryV2Dict", - "NullType", - "NullTypeDict", - "ObjectEdit", - "ObjectEditDict", - "ObjectEdits", - "ObjectEditsDict", - "ObjectPrimaryKey", - "ObjectPropertyType", - "ObjectPropertyTypeDict", - "ObjectPropertyValueConstraint", - "ObjectPropertyValueConstraintDict", - "ObjectQueryResultConstraint", - "ObjectQueryResultConstraintDict", - "ObjectRid", - "ObjectSet", - "ObjectSetBaseType", - "ObjectSetBaseTypeDict", - "ObjectSetDict", - "ObjectSetFilterType", - "ObjectSetFilterTypeDict", - "ObjectSetIntersectionType", - "ObjectSetIntersectionTypeDict", - "ObjectSetReferenceType", - "ObjectSetReferenceTypeDict", - "ObjectSetRid", - "ObjectSetSearchAroundType", - "ObjectSetSearchAroundTypeDict", - "ObjectSetStaticType", - "ObjectSetStaticTypeDict", - "ObjectSetStreamSubscribeRequest", - "ObjectSetStreamSubscribeRequestDict", - "ObjectSetStreamSubscribeRequests", - "ObjectSetStreamSubscribeRequestsDict", - "ObjectSetSubscribeResponse", - "ObjectSetSubscribeResponseDict", - "ObjectSetSubscribeResponses", - "ObjectSetSubscribeResponsesDict", - "ObjectSetSubtractType", - "ObjectSetSubtractTypeDict", - "ObjectSetUnionType", - "ObjectSetUnionTypeDict", - "ObjectSetUpdate", - "ObjectSetUpdateDict", - "ObjectSetUpdates", - "ObjectSetUpdatesDict", - "ObjectState", - "ObjectType", - "ObjectTypeApiName", - "ObjectTypeDict", - "ObjectTypeEdits", - "ObjectTypeEditsDict", - "ObjectTypeFullMetadata", - "ObjectTypeFullMetadataDict", - "ObjectTypeInterfaceImplementation", - "ObjectTypeInterfaceImplementationDict", - "ObjectTypeRid", - "ObjectTypeV2", - "ObjectTypeV2Dict", - "ObjectTypeVisibility", - "ObjectUpdate", - "ObjectUpdateDict", - "OneOfConstraint", - "OneOfConstraintDict", - "Ontology", - "OntologyApiName", - "OntologyArrayType", - "OntologyArrayTypeDict", - "OntologyDataType", - "OntologyDataTypeDict", - "OntologyDict", - "OntologyFullMetadata", - "OntologyFullMetadataDict", - "OntologyIdentifier", - "OntologyMapType", - "OntologyMapTypeDict", - "OntologyObject", - "OntologyObjectArrayType", - "OntologyObjectArrayTypeDict", - "OntologyObjectDict", - "OntologyObjectSetType", - "OntologyObjectSetTypeDict", - "OntologyObjectType", - "OntologyObjectTypeDict", - "OntologyObjectV2", - "OntologyRid", - "OntologySetType", - "OntologySetTypeDict", - "OntologyStructField", - "OntologyStructFieldDict", - "OntologyStructType", - "OntologyStructTypeDict", - "OntologyV2", - "OntologyV2Dict", - "OrderBy", - "OrderByDirection", - "OrQuery", - "OrQueryDict", - "OrQueryV2", - "OrQueryV2Dict", - "PageSize", - "PageToken", - "Parameter", - "ParameterDict", - "ParameterEvaluatedConstraint", - "ParameterEvaluatedConstraintDict", - "ParameterEvaluationResult", - "ParameterEvaluationResultDict", - "ParameterId", - "ParameterOption", - "ParameterOptionDict", - "PhraseQuery", - "PhraseQueryDict", - "Polygon", - "PolygonDict", - "PolygonValue", - "PolygonValueDict", - "Position", - "PrefixQuery", - "PrefixQueryDict", - "PreviewMode", - "PrimaryKeyValue", - "Property", - "PropertyApiName", - "PropertyDict", - "PropertyFilter", - "PropertyId", - "PropertyV2", - "PropertyV2Dict", - "PropertyValue", - "PropertyValueEscapedString", - "QosError", - "QosErrorDict", - "QueryAggregation", - "QueryAggregationDict", - "QueryAggregationKeyType", - "QueryAggregationKeyTypeDict", - "QueryAggregationRange", - "QueryAggregationRangeDict", - "QueryAggregationRangeSubType", - "QueryAggregationRangeSubTypeDict", - "QueryAggregationRangeType", - "QueryAggregationRangeTypeDict", - "QueryAggregationValueType", - "QueryAggregationValueTypeDict", - "QueryApiName", - "QueryArrayType", - "QueryArrayTypeDict", - "QueryDataType", - "QueryDataTypeDict", - "QueryOutputV2", - "QueryOutputV2Dict", - "QueryParameterV2", - "QueryParameterV2Dict", - "QueryRuntimeErrorParameter", - "QuerySetType", - "QuerySetTypeDict", - "QueryStructField", - "QueryStructFieldDict", - "QueryStructType", - "QueryStructTypeDict", - "QueryThreeDimensionalAggregation", - "QueryThreeDimensionalAggregationDict", - "QueryTwoDimensionalAggregation", - "QueryTwoDimensionalAggregationDict", - "QueryType", - "QueryTypeDict", - "QueryTypeV2", - "QueryTypeV2Dict", - "QueryUnionType", - "QueryUnionTypeDict", - "RangeConstraint", - "RangeConstraintDict", - "Reason", - "ReasonDict", - "ReasonType", - "ReferenceUpdate", - "ReferenceUpdateDict", - "ReferenceValue", - "ReferenceValueDict", - "RefreshObjectSet", - "RefreshObjectSetDict", - "RelativeTime", - "RelativeTimeDict", - "RelativeTimeRange", - "RelativeTimeRangeDict", - "RelativeTimeRelation", - "RelativeTimeSeriesTimeUnit", - "ReleaseStatus", - "RequestId", - "ResourcePath", - "ReturnEditsMode", - "SdkPackageName", - "SearchJsonQuery", - "SearchJsonQueryDict", - "SearchJsonQueryV2", - "SearchJsonQueryV2Dict", - "SearchObjectsForInterfaceRequest", - "SearchObjectsForInterfaceRequestDict", - "SearchObjectsRequest", - "SearchObjectsRequestDict", - "SearchObjectsRequestV2", - "SearchObjectsRequestV2Dict", - "SearchObjectsResponse", - "SearchObjectsResponseDict", - "SearchObjectsResponseV2", - "SearchObjectsResponseV2Dict", - "SearchOrderBy", - "SearchOrderByDict", - "SearchOrderByV2", - "SearchOrderByV2Dict", - "SearchOrdering", - "SearchOrderingDict", - "SearchOrderingV2", - "SearchOrderingV2Dict", - "SelectedPropertyApiName", - "SharedPropertyType", - "SharedPropertyTypeApiName", - "SharedPropertyTypeDict", - "SharedPropertyTypeRid", - "ShortType", - "ShortTypeDict", - "SizeBytes", - "StartsWithQuery", - "StartsWithQueryDict", - "StreamMessage", - "StreamMessageDict", - "StreamTimeSeriesPointsRequest", - "StreamTimeSeriesPointsRequestDict", - "StreamTimeSeriesPointsResponse", - "StreamTimeSeriesPointsResponseDict", - "StringLengthConstraint", - "StringLengthConstraintDict", - "StringRegexMatchConstraint", - "StringRegexMatchConstraintDict", - "StringType", - "StringTypeDict", - "StructFieldName", - "SubmissionCriteriaEvaluation", - "SubmissionCriteriaEvaluationDict", - "SubscriptionClosed", - "SubscriptionClosedDict", - "SubscriptionClosureCause", - "SubscriptionClosureCauseDict", - "SubscriptionError", - "SubscriptionErrorDict", - "SubscriptionId", - "SubscriptionSuccess", - "SubscriptionSuccessDict", - "SumAggregation", - "SumAggregationDict", - "SumAggregationV2", - "SumAggregationV2Dict", - "SyncApplyActionResponseV2", - "SyncApplyActionResponseV2Dict", - "TableExportFormat", - "ThreeDimensionalAggregation", - "ThreeDimensionalAggregationDict", - "TimeRange", - "TimeRangeDict", - "TimeSeriesItemType", - "TimeSeriesItemTypeDict", - "TimeSeriesPoint", - "TimeSeriesPointDict", - "TimeseriesType", - "TimeseriesTypeDict", - "TimestampType", - "TimestampTypeDict", - "TimeUnit", - "TotalCount", - "Transaction", - "TransactionDict", - "TransactionRid", - "TransactionStatus", - "TransactionType", - "TwoDimensionalAggregation", - "TwoDimensionalAggregationDict", - "UnevaluableConstraint", - "UnevaluableConstraintDict", - "UnsupportedType", - "UnsupportedTypeDict", - "UpdatedTime", - "UserId", - "ValidateActionRequest", - "ValidateActionRequestDict", - "ValidateActionResponse", - "ValidateActionResponseDict", - "ValidateActionResponseV2", - "ValidateActionResponseV2Dict", - "ValidationResult", - "ValueType", - "WithinBoundingBoxPoint", - "WithinBoundingBoxPointDict", - "WithinBoundingBoxQuery", - "WithinBoundingBoxQueryDict", - "WithinDistanceOfQuery", - "WithinDistanceOfQueryDict", - "WithinPolygonQuery", - "WithinPolygonQueryDict", -] diff --git a/foundry/v1/models/_absolute_time_range.py b/foundry/v1/models/_absolute_time_range.py deleted file mode 100644 index 05cfaec1..00000000 --- a/foundry/v1/models/_absolute_time_range.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._absolute_time_range_dict import AbsoluteTimeRangeDict - - -class AbsoluteTimeRange(BaseModel): - """ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.""" - - start_time: Optional[datetime] = Field(alias="startTime", default=None) - - end_time: Optional[datetime] = Field(alias="endTime", default=None) - - type: Literal["absolute"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AbsoluteTimeRangeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AbsoluteTimeRangeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_action_mode.py b/foundry/v1/models/_action_mode.py deleted file mode 100644 index 1c1c159a..00000000 --- a/foundry/v1/models/_action_mode.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -ActionMode = Literal["ASYNC", "RUN", "VALIDATE"] -"""ActionMode""" diff --git a/foundry/v1/models/_action_parameter_type.py b/foundry/v1/models/_action_parameter_type.py deleted file mode 100644 index ee7cb6fc..00000000 --- a/foundry/v1/models/_action_parameter_type.py +++ /dev/null @@ -1,73 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._action_parameter_type_dict import ActionParameterArrayTypeDict -from foundry.v1.models._attachment_type import AttachmentType -from foundry.v1.models._boolean_type import BooleanType -from foundry.v1.models._date_type import DateType -from foundry.v1.models._double_type import DoubleType -from foundry.v1.models._integer_type import IntegerType -from foundry.v1.models._long_type import LongType -from foundry.v1.models._marking_type import MarkingType -from foundry.v1.models._ontology_object_set_type import OntologyObjectSetType -from foundry.v1.models._ontology_object_type import OntologyObjectType -from foundry.v1.models._string_type import StringType -from foundry.v1.models._timestamp_type import TimestampType - - -class ActionParameterArrayType(BaseModel): - """ActionParameterArrayType""" - - sub_type: ActionParameterType = Field(alias="subType") - - type: Literal["array"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ActionParameterArrayTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ActionParameterArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True) - ) - - -ActionParameterType = Annotated[ - Union[ - ActionParameterArrayType, - AttachmentType, - BooleanType, - DateType, - DoubleType, - IntegerType, - LongType, - MarkingType, - OntologyObjectSetType, - OntologyObjectType, - StringType, - TimestampType, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Action parameters.""" diff --git a/foundry/v1/models/_action_parameter_type_dict.py b/foundry/v1/models/_action_parameter_type_dict.py deleted file mode 100644 index 3a885f26..00000000 --- a/foundry/v1/models/_action_parameter_type_dict.py +++ /dev/null @@ -1,65 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import TypedDict - -from foundry.v1.models._attachment_type_dict import AttachmentTypeDict -from foundry.v1.models._boolean_type_dict import BooleanTypeDict -from foundry.v1.models._date_type_dict import DateTypeDict -from foundry.v1.models._double_type_dict import DoubleTypeDict -from foundry.v1.models._integer_type_dict import IntegerTypeDict -from foundry.v1.models._long_type_dict import LongTypeDict -from foundry.v1.models._marking_type_dict import MarkingTypeDict -from foundry.v1.models._ontology_object_set_type_dict import OntologyObjectSetTypeDict -from foundry.v1.models._ontology_object_type_dict import OntologyObjectTypeDict -from foundry.v1.models._string_type_dict import StringTypeDict -from foundry.v1.models._timestamp_type_dict import TimestampTypeDict - - -class ActionParameterArrayTypeDict(TypedDict): - """ActionParameterArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: ActionParameterTypeDict - - type: Literal["array"] - - -ActionParameterTypeDict = Annotated[ - Union[ - ActionParameterArrayTypeDict, - AttachmentTypeDict, - BooleanTypeDict, - DateTypeDict, - DoubleTypeDict, - IntegerTypeDict, - LongTypeDict, - MarkingTypeDict, - OntologyObjectSetTypeDict, - OntologyObjectTypeDict, - StringTypeDict, - TimestampTypeDict, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Action parameters.""" diff --git a/foundry/v1/models/_action_parameter_v2.py b/foundry/v1/models/_action_parameter_v2.py deleted file mode 100644 index ebf5e9c5..00000000 --- a/foundry/v1/models/_action_parameter_v2.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool -from pydantic import StrictStr - -from foundry.v1.models._action_parameter_type import ActionParameterType -from foundry.v1.models._action_parameter_v2_dict import ActionParameterV2Dict - - -class ActionParameterV2(BaseModel): - """Details about a parameter of an action.""" - - description: Optional[StrictStr] = None - - data_type: ActionParameterType = Field(alias="dataType") - - required: StrictBool - - model_config = {"extra": "allow"} - - def to_dict(self) -> ActionParameterV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ActionParameterV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_action_parameter_v2_dict.py b/foundry/v1/models/_action_parameter_v2_dict.py deleted file mode 100644 index 778386b6..00000000 --- a/foundry/v1/models/_action_parameter_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictBool -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._action_parameter_type_dict import ActionParameterTypeDict - - -class ActionParameterV2Dict(TypedDict): - """Details about a parameter of an action.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: NotRequired[StrictStr] - - dataType: ActionParameterTypeDict - - required: StrictBool diff --git a/foundry/v1/models/_action_results.py b/foundry/v1/models/_action_results.py deleted file mode 100644 index de1c1dc2..00000000 --- a/foundry/v1/models/_action_results.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._object_edits import ObjectEdits -from foundry.v1.models._object_type_edits import ObjectTypeEdits - -ActionResults = Annotated[Union[ObjectEdits, ObjectTypeEdits], Field(discriminator="type")] -"""ActionResults""" diff --git a/foundry/v1/models/_action_results_dict.py b/foundry/v1/models/_action_results_dict.py deleted file mode 100644 index ff5bd9a4..00000000 --- a/foundry/v1/models/_action_results_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._object_edits_dict import ObjectEditsDict -from foundry.v1.models._object_type_edits_dict import ObjectTypeEditsDict - -ActionResultsDict = Annotated[ - Union[ObjectEditsDict, ObjectTypeEditsDict], Field(discriminator="type") -] -"""ActionResults""" diff --git a/foundry/v1/models/_action_rid.py b/foundry/v1/models/_action_rid.py deleted file mode 100644 index ab25db69..00000000 --- a/foundry/v1/models/_action_rid.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import RID - -ActionRid = RID -"""The unique resource identifier for an action.""" diff --git a/foundry/v1/models/_action_type.py b/foundry/v1/models/_action_type.py deleted file mode 100644 index f265cfa5..00000000 --- a/foundry/v1/models/_action_type.py +++ /dev/null @@ -1,58 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._action_type_api_name import ActionTypeApiName -from foundry.v1.models._action_type_dict import ActionTypeDict -from foundry.v1.models._action_type_rid import ActionTypeRid -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._logic_rule import LogicRule -from foundry.v1.models._parameter import Parameter -from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._release_status import ReleaseStatus - - -class ActionType(BaseModel): - """Represents an action type in the Ontology.""" - - api_name: ActionTypeApiName = Field(alias="apiName") - - description: Optional[StrictStr] = None - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - status: ReleaseStatus - - parameters: Dict[ParameterId, Parameter] - - rid: ActionTypeRid - - operations: List[LogicRule] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ActionTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ActionTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_action_type_dict.py b/foundry/v1/models/_action_type_dict.py deleted file mode 100644 index 5eab1357..00000000 --- a/foundry/v1/models/_action_type_dict.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._action_type_api_name import ActionTypeApiName -from foundry.v1.models._action_type_rid import ActionTypeRid -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._logic_rule_dict import LogicRuleDict -from foundry.v1.models._parameter_dict import ParameterDict -from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._release_status import ReleaseStatus - - -class ActionTypeDict(TypedDict): - """Represents an action type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ActionTypeApiName - - description: NotRequired[StrictStr] - - displayName: NotRequired[DisplayName] - - status: ReleaseStatus - - parameters: Dict[ParameterId, ParameterDict] - - rid: ActionTypeRid - - operations: List[LogicRuleDict] diff --git a/foundry/v1/models/_action_type_v2.py b/foundry/v1/models/_action_type_v2.py deleted file mode 100644 index 7b5efec7..00000000 --- a/foundry/v1/models/_action_type_v2.py +++ /dev/null @@ -1,58 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._action_parameter_v2 import ActionParameterV2 -from foundry.v1.models._action_type_api_name import ActionTypeApiName -from foundry.v1.models._action_type_rid import ActionTypeRid -from foundry.v1.models._action_type_v2_dict import ActionTypeV2Dict -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._logic_rule import LogicRule -from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._release_status import ReleaseStatus - - -class ActionTypeV2(BaseModel): - """Represents an action type in the Ontology.""" - - api_name: ActionTypeApiName = Field(alias="apiName") - - description: Optional[StrictStr] = None - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - status: ReleaseStatus - - parameters: Dict[ParameterId, ActionParameterV2] - - rid: ActionTypeRid - - operations: List[LogicRule] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ActionTypeV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ActionTypeV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_action_type_v2_dict.py b/foundry/v1/models/_action_type_v2_dict.py deleted file mode 100644 index e7173c72..00000000 --- a/foundry/v1/models/_action_type_v2_dict.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._action_parameter_v2_dict import ActionParameterV2Dict -from foundry.v1.models._action_type_api_name import ActionTypeApiName -from foundry.v1.models._action_type_rid import ActionTypeRid -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._logic_rule_dict import LogicRuleDict -from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._release_status import ReleaseStatus - - -class ActionTypeV2Dict(TypedDict): - """Represents an action type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ActionTypeApiName - - description: NotRequired[StrictStr] - - displayName: NotRequired[DisplayName] - - status: ReleaseStatus - - parameters: Dict[ParameterId, ActionParameterV2Dict] - - rid: ActionTypeRid - - operations: List[LogicRuleDict] diff --git a/foundry/v1/models/_add_link.py b/foundry/v1/models/_add_link.py deleted file mode 100644 index a7e4c62f..00000000 --- a/foundry/v1/models/_add_link.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._add_link_dict import AddLinkDict -from foundry.v1.models._link_side_object import LinkSideObject -from foundry.v1.models._link_type_api_name import LinkTypeApiName - - -class AddLink(BaseModel): - """AddLink""" - - link_type_api_name_ato_b: LinkTypeApiName = Field(alias="linkTypeApiNameAtoB") - - link_type_api_name_bto_a: LinkTypeApiName = Field(alias="linkTypeApiNameBtoA") - - a_side_object: LinkSideObject = Field(alias="aSideObject") - - b_side_object: LinkSideObject = Field(alias="bSideObject") - - type: Literal["addLink"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AddLinkDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AddLinkDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_add_link_dict.py b/foundry/v1/models/_add_link_dict.py deleted file mode 100644 index 3917ce16..00000000 --- a/foundry/v1/models/_add_link_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._link_side_object_dict import LinkSideObjectDict -from foundry.v1.models._link_type_api_name import LinkTypeApiName - - -class AddLinkDict(TypedDict): - """AddLink""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - linkTypeApiNameAtoB: LinkTypeApiName - - linkTypeApiNameBtoA: LinkTypeApiName - - aSideObject: LinkSideObjectDict - - bSideObject: LinkSideObjectDict - - type: Literal["addLink"] diff --git a/foundry/v1/models/_add_object.py b/foundry/v1/models/_add_object.py deleted file mode 100644 index 7e178d1e..00000000 --- a/foundry/v1/models/_add_object.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._add_object_dict import AddObjectDict -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._property_value import PropertyValue - - -class AddObject(BaseModel): - """AddObject""" - - primary_key: PropertyValue = Field(alias="primaryKey") - - object_type: ObjectTypeApiName = Field(alias="objectType") - - type: Literal["addObject"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AddObjectDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AddObjectDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_add_object_dict.py b/foundry/v1/models/_add_object_dict.py deleted file mode 100644 index 5d083025..00000000 --- a/foundry/v1/models/_add_object_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._property_value import PropertyValue - - -class AddObjectDict(TypedDict): - """AddObject""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - primaryKey: PropertyValue - - objectType: ObjectTypeApiName - - type: Literal["addObject"] diff --git a/foundry/v1/models/_aggregate_object_set_request_v2.py b/foundry/v1/models/_aggregate_object_set_request_v2.py deleted file mode 100644 index 68ca3c2a..00000000 --- a/foundry/v1/models/_aggregate_object_set_request_v2.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._aggregate_object_set_request_v2_dict import ( - AggregateObjectSetRequestV2Dict, -) # NOQA -from foundry.v1.models._aggregation_accuracy_request import AggregationAccuracyRequest -from foundry.v1.models._aggregation_group_by_v2 import AggregationGroupByV2 -from foundry.v1.models._aggregation_v2 import AggregationV2 -from foundry.v1.models._object_set import ObjectSet - - -class AggregateObjectSetRequestV2(BaseModel): - """AggregateObjectSetRequestV2""" - - aggregation: List[AggregationV2] - - object_set: ObjectSet = Field(alias="objectSet") - - group_by: List[AggregationGroupByV2] = Field(alias="groupBy") - - accuracy: Optional[AggregationAccuracyRequest] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregateObjectSetRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregateObjectSetRequestV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregate_object_set_request_v2_dict.py b/foundry/v1/models/_aggregate_object_set_request_v2_dict.py deleted file mode 100644 index ce122b88..00000000 --- a/foundry/v1/models/_aggregate_object_set_request_v2_dict.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_accuracy_request import AggregationAccuracyRequest -from foundry.v1.models._aggregation_group_by_v2_dict import AggregationGroupByV2Dict -from foundry.v1.models._aggregation_v2_dict import AggregationV2Dict -from foundry.v1.models._object_set_dict import ObjectSetDict - - -class AggregateObjectSetRequestV2Dict(TypedDict): - """AggregateObjectSetRequestV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - aggregation: List[AggregationV2Dict] - - objectSet: ObjectSetDict - - groupBy: List[AggregationGroupByV2Dict] - - accuracy: NotRequired[AggregationAccuracyRequest] diff --git a/foundry/v1/models/_aggregate_objects_request.py b/foundry/v1/models/_aggregate_objects_request.py deleted file mode 100644 index 8bb720c5..00000000 --- a/foundry/v1/models/_aggregate_objects_request.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._aggregate_objects_request_dict import AggregateObjectsRequestDict # NOQA -from foundry.v1.models._aggregation import Aggregation -from foundry.v1.models._aggregation_group_by import AggregationGroupBy -from foundry.v1.models._search_json_query import SearchJsonQuery - - -class AggregateObjectsRequest(BaseModel): - """AggregateObjectsRequest""" - - aggregation: List[Aggregation] - - query: Optional[SearchJsonQuery] = None - - group_by: List[AggregationGroupBy] = Field(alias="groupBy") - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregateObjectsRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AggregateObjectsRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_aggregate_objects_request_dict.py b/foundry/v1/models/_aggregate_objects_request_dict.py deleted file mode 100644 index fab7dc38..00000000 --- a/foundry/v1/models/_aggregate_objects_request_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_dict import AggregationDict -from foundry.v1.models._aggregation_group_by_dict import AggregationGroupByDict -from foundry.v1.models._search_json_query_dict import SearchJsonQueryDict - - -class AggregateObjectsRequestDict(TypedDict): - """AggregateObjectsRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - aggregation: List[AggregationDict] - - query: NotRequired[SearchJsonQueryDict] - - groupBy: List[AggregationGroupByDict] diff --git a/foundry/v1/models/_aggregate_objects_request_v2.py b/foundry/v1/models/_aggregate_objects_request_v2.py deleted file mode 100644 index cb3bf73e..00000000 --- a/foundry/v1/models/_aggregate_objects_request_v2.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._aggregate_objects_request_v2_dict import ( - AggregateObjectsRequestV2Dict, -) # NOQA -from foundry.v1.models._aggregation_accuracy_request import AggregationAccuracyRequest -from foundry.v1.models._aggregation_group_by_v2 import AggregationGroupByV2 -from foundry.v1.models._aggregation_v2 import AggregationV2 -from foundry.v1.models._search_json_query_v2 import SearchJsonQueryV2 - - -class AggregateObjectsRequestV2(BaseModel): - """AggregateObjectsRequestV2""" - - aggregation: List[AggregationV2] - - where: Optional[SearchJsonQueryV2] = None - - group_by: List[AggregationGroupByV2] = Field(alias="groupBy") - - accuracy: Optional[AggregationAccuracyRequest] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregateObjectsRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregateObjectsRequestV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregate_objects_request_v2_dict.py b/foundry/v1/models/_aggregate_objects_request_v2_dict.py deleted file mode 100644 index e83d71f8..00000000 --- a/foundry/v1/models/_aggregate_objects_request_v2_dict.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_accuracy_request import AggregationAccuracyRequest -from foundry.v1.models._aggregation_group_by_v2_dict import AggregationGroupByV2Dict -from foundry.v1.models._aggregation_v2_dict import AggregationV2Dict -from foundry.v1.models._search_json_query_v2_dict import SearchJsonQueryV2Dict - - -class AggregateObjectsRequestV2Dict(TypedDict): - """AggregateObjectsRequestV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - aggregation: List[AggregationV2Dict] - - where: NotRequired[SearchJsonQueryV2Dict] - - groupBy: List[AggregationGroupByV2Dict] - - accuracy: NotRequired[AggregationAccuracyRequest] diff --git a/foundry/v1/models/_aggregate_objects_response.py b/foundry/v1/models/_aggregate_objects_response.py deleted file mode 100644 index 3c86a514..00000000 --- a/foundry/v1/models/_aggregate_objects_response.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictInt - -from foundry.v1.models._aggregate_objects_response_dict import AggregateObjectsResponseDict # NOQA -from foundry.v1.models._aggregate_objects_response_item import AggregateObjectsResponseItem # NOQA -from foundry.v1.models._page_token import PageToken - - -class AggregateObjectsResponse(BaseModel): - """AggregateObjectsResponse""" - - excluded_items: Optional[StrictInt] = Field(alias="excludedItems", default=None) - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[AggregateObjectsResponseItem] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregateObjectsResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregateObjectsResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregate_objects_response_dict.py b/foundry/v1/models/_aggregate_objects_response_dict.py deleted file mode 100644 index 44f49fae..00000000 --- a/foundry/v1/models/_aggregate_objects_response_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from pydantic import StrictInt -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregate_objects_response_item_dict import ( - AggregateObjectsResponseItemDict, -) # NOQA -from foundry.v1.models._page_token import PageToken - - -class AggregateObjectsResponseDict(TypedDict): - """AggregateObjectsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - excludedItems: NotRequired[StrictInt] - - nextPageToken: NotRequired[PageToken] - - data: List[AggregateObjectsResponseItemDict] diff --git a/foundry/v1/models/_aggregate_objects_response_item.py b/foundry/v1/models/_aggregate_objects_response_item.py deleted file mode 100644 index 1b2a96ad..00000000 --- a/foundry/v1/models/_aggregate_objects_response_item.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregate_objects_response_item_dict import ( - AggregateObjectsResponseItemDict, -) # NOQA -from foundry.v1.models._aggregation_group_key import AggregationGroupKey -from foundry.v1.models._aggregation_group_value import AggregationGroupValue -from foundry.v1.models._aggregation_metric_result import AggregationMetricResult - - -class AggregateObjectsResponseItem(BaseModel): - """AggregateObjectsResponseItem""" - - group: Dict[AggregationGroupKey, AggregationGroupValue] - - metrics: List[AggregationMetricResult] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregateObjectsResponseItemDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregateObjectsResponseItemDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregate_objects_response_item_dict.py b/foundry/v1/models/_aggregate_objects_response_item_dict.py deleted file mode 100644 index 6b098328..00000000 --- a/foundry/v1/models/_aggregate_objects_response_item_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_group_key import AggregationGroupKey -from foundry.v1.models._aggregation_group_value import AggregationGroupValue -from foundry.v1.models._aggregation_metric_result_dict import AggregationMetricResultDict # NOQA - - -class AggregateObjectsResponseItemDict(TypedDict): - """AggregateObjectsResponseItem""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - group: Dict[AggregationGroupKey, AggregationGroupValue] - - metrics: List[AggregationMetricResultDict] diff --git a/foundry/v1/models/_aggregate_objects_response_item_v2.py b/foundry/v1/models/_aggregate_objects_response_item_v2.py deleted file mode 100644 index 2b6f160a..00000000 --- a/foundry/v1/models/_aggregate_objects_response_item_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregate_objects_response_item_v2_dict import ( - AggregateObjectsResponseItemV2Dict, -) # NOQA -from foundry.v1.models._aggregation_group_key_v2 import AggregationGroupKeyV2 -from foundry.v1.models._aggregation_group_value_v2 import AggregationGroupValueV2 -from foundry.v1.models._aggregation_metric_result_v2 import AggregationMetricResultV2 - - -class AggregateObjectsResponseItemV2(BaseModel): - """AggregateObjectsResponseItemV2""" - - group: Dict[AggregationGroupKeyV2, AggregationGroupValueV2] - - metrics: List[AggregationMetricResultV2] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregateObjectsResponseItemV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregateObjectsResponseItemV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregate_objects_response_item_v2_dict.py b/foundry/v1/models/_aggregate_objects_response_item_v2_dict.py deleted file mode 100644 index 2e309882..00000000 --- a/foundry/v1/models/_aggregate_objects_response_item_v2_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_group_key_v2 import AggregationGroupKeyV2 -from foundry.v1.models._aggregation_group_value_v2 import AggregationGroupValueV2 -from foundry.v1.models._aggregation_metric_result_v2_dict import ( - AggregationMetricResultV2Dict, -) # NOQA - - -class AggregateObjectsResponseItemV2Dict(TypedDict): - """AggregateObjectsResponseItemV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - group: Dict[AggregationGroupKeyV2, AggregationGroupValueV2] - - metrics: List[AggregationMetricResultV2Dict] diff --git a/foundry/v1/models/_aggregate_objects_response_v2.py b/foundry/v1/models/_aggregate_objects_response_v2.py deleted file mode 100644 index 1fc92a82..00000000 --- a/foundry/v1/models/_aggregate_objects_response_v2.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictInt - -from foundry.v1.models._aggregate_objects_response_item_v2 import ( - AggregateObjectsResponseItemV2, -) # NOQA -from foundry.v1.models._aggregate_objects_response_v2_dict import ( - AggregateObjectsResponseV2Dict, -) # NOQA -from foundry.v1.models._aggregation_accuracy import AggregationAccuracy - - -class AggregateObjectsResponseV2(BaseModel): - """AggregateObjectsResponseV2""" - - excluded_items: Optional[StrictInt] = Field(alias="excludedItems", default=None) - - accuracy: AggregationAccuracy - - data: List[AggregateObjectsResponseItemV2] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregateObjectsResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregateObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregate_objects_response_v2_dict.py b/foundry/v1/models/_aggregate_objects_response_v2_dict.py deleted file mode 100644 index de5ec71a..00000000 --- a/foundry/v1/models/_aggregate_objects_response_v2_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from pydantic import StrictInt -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregate_objects_response_item_v2_dict import ( - AggregateObjectsResponseItemV2Dict, -) # NOQA -from foundry.v1.models._aggregation_accuracy import AggregationAccuracy - - -class AggregateObjectsResponseV2Dict(TypedDict): - """AggregateObjectsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - excludedItems: NotRequired[StrictInt] - - accuracy: AggregationAccuracy - - data: List[AggregateObjectsResponseItemV2Dict] diff --git a/foundry/v1/models/_aggregation.py b/foundry/v1/models/_aggregation.py deleted file mode 100644 index 3f74bd4b..00000000 --- a/foundry/v1/models/_aggregation.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._approximate_distinct_aggregation import ( - ApproximateDistinctAggregation, -) # NOQA -from foundry.v1.models._avg_aggregation import AvgAggregation -from foundry.v1.models._count_aggregation import CountAggregation -from foundry.v1.models._max_aggregation import MaxAggregation -from foundry.v1.models._min_aggregation import MinAggregation -from foundry.v1.models._sum_aggregation import SumAggregation - -Aggregation = Annotated[ - Union[ - MaxAggregation, - MinAggregation, - AvgAggregation, - SumAggregation, - CountAggregation, - ApproximateDistinctAggregation, - ], - Field(discriminator="type"), -] -"""Specifies an aggregation function.""" diff --git a/foundry/v1/models/_aggregation_dict.py b/foundry/v1/models/_aggregation_dict.py deleted file mode 100644 index 1730f5be..00000000 --- a/foundry/v1/models/_aggregation_dict.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._approximate_distinct_aggregation_dict import ( - ApproximateDistinctAggregationDict, -) # NOQA -from foundry.v1.models._avg_aggregation_dict import AvgAggregationDict -from foundry.v1.models._count_aggregation_dict import CountAggregationDict -from foundry.v1.models._max_aggregation_dict import MaxAggregationDict -from foundry.v1.models._min_aggregation_dict import MinAggregationDict -from foundry.v1.models._sum_aggregation_dict import SumAggregationDict - -AggregationDict = Annotated[ - Union[ - MaxAggregationDict, - MinAggregationDict, - AvgAggregationDict, - SumAggregationDict, - CountAggregationDict, - ApproximateDistinctAggregationDict, - ], - Field(discriminator="type"), -] -"""Specifies an aggregation function.""" diff --git a/foundry/v1/models/_aggregation_duration_grouping.py b/foundry/v1/models/_aggregation_duration_grouping.py deleted file mode 100644 index 533367f6..00000000 --- a/foundry/v1/models/_aggregation_duration_grouping.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_duration_grouping_dict import ( - AggregationDurationGroupingDict, -) # NOQA -from foundry.v1.models._duration import Duration -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class AggregationDurationGrouping(BaseModel): - """ - Divides objects into groups according to an interval. Note that this grouping applies only on date types. - The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. - """ - - field: FieldNameV1 - - duration: Duration - - type: Literal["duration"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationDurationGroupingDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationDurationGroupingDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregation_duration_grouping_dict.py b/foundry/v1/models/_aggregation_duration_grouping_dict.py deleted file mode 100644 index 7ecf85b4..00000000 --- a/foundry/v1/models/_aggregation_duration_grouping_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._duration import Duration -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class AggregationDurationGroupingDict(TypedDict): - """ - Divides objects into groups according to an interval. Note that this grouping applies only on date types. - The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - duration: Duration - - type: Literal["duration"] diff --git a/foundry/v1/models/_aggregation_duration_grouping_v2.py b/foundry/v1/models/_aggregation_duration_grouping_v2.py deleted file mode 100644 index 1108bd8b..00000000 --- a/foundry/v1/models/_aggregation_duration_grouping_v2.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictInt - -from foundry.v1.models._aggregation_duration_grouping_v2_dict import ( - AggregationDurationGroupingV2Dict, -) # NOQA -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._time_unit import TimeUnit - - -class AggregationDurationGroupingV2(BaseModel): - """ - Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. - When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. - """ - - field: PropertyApiName - - value: StrictInt - - unit: TimeUnit - - type: Literal["duration"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationDurationGroupingV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationDurationGroupingV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregation_duration_grouping_v2_dict.py b/foundry/v1/models/_aggregation_duration_grouping_v2_dict.py deleted file mode 100644 index 07d6cdec..00000000 --- a/foundry/v1/models/_aggregation_duration_grouping_v2_dict.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictInt -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._time_unit import TimeUnit - - -class AggregationDurationGroupingV2Dict(TypedDict): - """ - Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. - When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: StrictInt - - unit: TimeUnit - - type: Literal["duration"] diff --git a/foundry/v1/models/_aggregation_exact_grouping.py b/foundry/v1/models/_aggregation_exact_grouping.py deleted file mode 100644 index c7c39568..00000000 --- a/foundry/v1/models/_aggregation_exact_grouping.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictInt - -from foundry.v1.models._aggregation_exact_grouping_dict import AggregationExactGroupingDict # NOQA -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class AggregationExactGrouping(BaseModel): - """Divides objects into groups according to an exact value.""" - - field: FieldNameV1 - - max_group_count: Optional[StrictInt] = Field(alias="maxGroupCount", default=None) - - type: Literal["exact"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationExactGroupingDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationExactGroupingDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregation_exact_grouping_dict.py b/foundry/v1/models/_aggregation_exact_grouping_dict.py deleted file mode 100644 index 057b85a8..00000000 --- a/foundry/v1/models/_aggregation_exact_grouping_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictInt -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class AggregationExactGroupingDict(TypedDict): - """Divides objects into groups according to an exact value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - maxGroupCount: NotRequired[StrictInt] - - type: Literal["exact"] diff --git a/foundry/v1/models/_aggregation_exact_grouping_v2.py b/foundry/v1/models/_aggregation_exact_grouping_v2.py deleted file mode 100644 index 93946821..00000000 --- a/foundry/v1/models/_aggregation_exact_grouping_v2.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictInt - -from foundry.v1.models._aggregation_exact_grouping_v2_dict import ( - AggregationExactGroupingV2Dict, -) # NOQA -from foundry.v1.models._property_api_name import PropertyApiName - - -class AggregationExactGroupingV2(BaseModel): - """Divides objects into groups according to an exact value.""" - - field: PropertyApiName - - max_group_count: Optional[StrictInt] = Field(alias="maxGroupCount", default=None) - - type: Literal["exact"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationExactGroupingV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationExactGroupingV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregation_exact_grouping_v2_dict.py b/foundry/v1/models/_aggregation_exact_grouping_v2_dict.py deleted file mode 100644 index 86f4d1e6..00000000 --- a/foundry/v1/models/_aggregation_exact_grouping_v2_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictInt -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName - - -class AggregationExactGroupingV2Dict(TypedDict): - """Divides objects into groups according to an exact value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - maxGroupCount: NotRequired[StrictInt] - - type: Literal["exact"] diff --git a/foundry/v1/models/_aggregation_fixed_width_grouping.py b/foundry/v1/models/_aggregation_fixed_width_grouping.py deleted file mode 100644 index c09eee86..00000000 --- a/foundry/v1/models/_aggregation_fixed_width_grouping.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictInt - -from foundry.v1.models._aggregation_fixed_width_grouping_dict import ( - AggregationFixedWidthGroupingDict, -) # NOQA -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class AggregationFixedWidthGrouping(BaseModel): - """Divides objects into groups with the specified width.""" - - field: FieldNameV1 - - fixed_width: StrictInt = Field(alias="fixedWidth") - - type: Literal["fixedWidth"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationFixedWidthGroupingDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationFixedWidthGroupingDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregation_fixed_width_grouping_dict.py b/foundry/v1/models/_aggregation_fixed_width_grouping_dict.py deleted file mode 100644 index 4c0c7bde..00000000 --- a/foundry/v1/models/_aggregation_fixed_width_grouping_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictInt -from typing_extensions import TypedDict - -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class AggregationFixedWidthGroupingDict(TypedDict): - """Divides objects into groups with the specified width.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - fixedWidth: StrictInt - - type: Literal["fixedWidth"] diff --git a/foundry/v1/models/_aggregation_fixed_width_grouping_v2.py b/foundry/v1/models/_aggregation_fixed_width_grouping_v2.py deleted file mode 100644 index 23927e6c..00000000 --- a/foundry/v1/models/_aggregation_fixed_width_grouping_v2.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictInt - -from foundry.v1.models._aggregation_fixed_width_grouping_v2_dict import ( - AggregationFixedWidthGroupingV2Dict, -) # NOQA -from foundry.v1.models._property_api_name import PropertyApiName - - -class AggregationFixedWidthGroupingV2(BaseModel): - """Divides objects into groups with the specified width.""" - - field: PropertyApiName - - fixed_width: StrictInt = Field(alias="fixedWidth") - - type: Literal["fixedWidth"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationFixedWidthGroupingV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationFixedWidthGroupingV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregation_fixed_width_grouping_v2_dict.py b/foundry/v1/models/_aggregation_fixed_width_grouping_v2_dict.py deleted file mode 100644 index 4ce98180..00000000 --- a/foundry/v1/models/_aggregation_fixed_width_grouping_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictInt -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName - - -class AggregationFixedWidthGroupingV2Dict(TypedDict): - """Divides objects into groups with the specified width.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - fixedWidth: StrictInt - - type: Literal["fixedWidth"] diff --git a/foundry/v1/models/_aggregation_group_by.py b/foundry/v1/models/_aggregation_group_by.py deleted file mode 100644 index 3815753f..00000000 --- a/foundry/v1/models/_aggregation_group_by.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._aggregation_duration_grouping import AggregationDurationGrouping -from foundry.v1.models._aggregation_exact_grouping import AggregationExactGrouping -from foundry.v1.models._aggregation_fixed_width_grouping import ( - AggregationFixedWidthGrouping, -) # NOQA -from foundry.v1.models._aggregation_ranges_grouping import AggregationRangesGrouping - -AggregationGroupBy = Annotated[ - Union[ - AggregationFixedWidthGrouping, - AggregationRangesGrouping, - AggregationExactGrouping, - AggregationDurationGrouping, - ], - Field(discriminator="type"), -] -"""Specifies a grouping for aggregation results.""" diff --git a/foundry/v1/models/_aggregation_group_by_dict.py b/foundry/v1/models/_aggregation_group_by_dict.py deleted file mode 100644 index e8bc78c0..00000000 --- a/foundry/v1/models/_aggregation_group_by_dict.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._aggregation_duration_grouping_dict import ( - AggregationDurationGroupingDict, -) # NOQA -from foundry.v1.models._aggregation_exact_grouping_dict import AggregationExactGroupingDict # NOQA -from foundry.v1.models._aggregation_fixed_width_grouping_dict import ( - AggregationFixedWidthGroupingDict, -) # NOQA -from foundry.v1.models._aggregation_ranges_grouping_dict import ( - AggregationRangesGroupingDict, -) # NOQA - -AggregationGroupByDict = Annotated[ - Union[ - AggregationFixedWidthGroupingDict, - AggregationRangesGroupingDict, - AggregationExactGroupingDict, - AggregationDurationGroupingDict, - ], - Field(discriminator="type"), -] -"""Specifies a grouping for aggregation results.""" diff --git a/foundry/v1/models/_aggregation_group_by_v2.py b/foundry/v1/models/_aggregation_group_by_v2.py deleted file mode 100644 index 1debd328..00000000 --- a/foundry/v1/models/_aggregation_group_by_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._aggregation_duration_grouping_v2 import ( - AggregationDurationGroupingV2, -) # NOQA -from foundry.v1.models._aggregation_exact_grouping_v2 import AggregationExactGroupingV2 -from foundry.v1.models._aggregation_fixed_width_grouping_v2 import ( - AggregationFixedWidthGroupingV2, -) # NOQA -from foundry.v1.models._aggregation_ranges_grouping_v2 import AggregationRangesGroupingV2 # NOQA - -AggregationGroupByV2 = Annotated[ - Union[ - AggregationFixedWidthGroupingV2, - AggregationRangesGroupingV2, - AggregationExactGroupingV2, - AggregationDurationGroupingV2, - ], - Field(discriminator="type"), -] -"""Specifies a grouping for aggregation results.""" diff --git a/foundry/v1/models/_aggregation_group_by_v2_dict.py b/foundry/v1/models/_aggregation_group_by_v2_dict.py deleted file mode 100644 index 41bbbb1e..00000000 --- a/foundry/v1/models/_aggregation_group_by_v2_dict.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._aggregation_duration_grouping_v2_dict import ( - AggregationDurationGroupingV2Dict, -) # NOQA -from foundry.v1.models._aggregation_exact_grouping_v2_dict import ( - AggregationExactGroupingV2Dict, -) # NOQA -from foundry.v1.models._aggregation_fixed_width_grouping_v2_dict import ( - AggregationFixedWidthGroupingV2Dict, -) # NOQA -from foundry.v1.models._aggregation_ranges_grouping_v2_dict import ( - AggregationRangesGroupingV2Dict, -) # NOQA - -AggregationGroupByV2Dict = Annotated[ - Union[ - AggregationFixedWidthGroupingV2Dict, - AggregationRangesGroupingV2Dict, - AggregationExactGroupingV2Dict, - AggregationDurationGroupingV2Dict, - ], - Field(discriminator="type"), -] -"""Specifies a grouping for aggregation results.""" diff --git a/foundry/v1/models/_aggregation_metric_result.py b/foundry/v1/models/_aggregation_metric_result.py deleted file mode 100644 index e4aef3af..00000000 --- a/foundry/v1/models/_aggregation_metric_result.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictFloat -from pydantic import StrictStr - -from foundry.v1.models._aggregation_metric_result_dict import AggregationMetricResultDict # NOQA - - -class AggregationMetricResult(BaseModel): - """AggregationMetricResult""" - - name: StrictStr - - value: Optional[StrictFloat] = None - """TBD""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationMetricResultDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AggregationMetricResultDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_aggregation_metric_result_v2.py b/foundry/v1/models/_aggregation_metric_result_v2.py deleted file mode 100644 index ce2c6c1b..00000000 --- a/foundry/v1/models/_aggregation_metric_result_v2.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v1.models._aggregation_metric_result_v2_dict import ( - AggregationMetricResultV2Dict, -) # NOQA - - -class AggregationMetricResultV2(BaseModel): - """AggregationMetricResultV2""" - - name: StrictStr - - value: Optional[Any] = None - """ - The value of the metric. This will be a double in the case of - a numeric metric, or a date string in the case of a date metric. - """ - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationMetricResultV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationMetricResultV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregation_object_type_grouping.py b/foundry/v1/models/_aggregation_object_type_grouping.py deleted file mode 100644 index 43734261..00000000 --- a/foundry/v1/models/_aggregation_object_type_grouping.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_object_type_grouping_dict import ( - AggregationObjectTypeGroupingDict, -) # NOQA - - -class AggregationObjectTypeGrouping(BaseModel): - """ - Divides objects into groups based on their object type. This grouping is only useful when aggregating across - multiple object types, such as when aggregating over an interface type. - """ - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationObjectTypeGroupingDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationObjectTypeGroupingDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregation_object_type_grouping_dict.py b/foundry/v1/models/_aggregation_object_type_grouping_dict.py deleted file mode 100644 index d5801329..00000000 --- a/foundry/v1/models/_aggregation_object_type_grouping_dict.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - - -class AggregationObjectTypeGroupingDict(TypedDict): - """ - Divides objects into groups based on their object type. This grouping is only useful when aggregating across - multiple object types, such as when aggregating over an interface type. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v1/models/_aggregation_order_by.py b/foundry/v1/models/_aggregation_order_by.py deleted file mode 100644 index 5816c0da..00000000 --- a/foundry/v1/models/_aggregation_order_by.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._aggregation_order_by_dict import AggregationOrderByDict - - -class AggregationOrderBy(BaseModel): - """AggregationOrderBy""" - - metric_name: StrictStr = Field(alias="metricName") - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationOrderByDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AggregationOrderByDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_aggregation_order_by_dict.py b/foundry/v1/models/_aggregation_order_by_dict.py deleted file mode 100644 index 12825d13..00000000 --- a/foundry/v1/models/_aggregation_order_by_dict.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import TypedDict - - -class AggregationOrderByDict(TypedDict): - """AggregationOrderBy""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - metricName: StrictStr diff --git a/foundry/v1/models/_aggregation_range.py b/foundry/v1/models/_aggregation_range.py deleted file mode 100644 index 2461e3d3..00000000 --- a/foundry/v1/models/_aggregation_range.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_range_dict import AggregationRangeDict - - -class AggregationRange(BaseModel): - """Specifies a date range from an inclusive start date to an exclusive end date.""" - - lt: Optional[Any] = None - """Exclusive end date.""" - - lte: Optional[Any] = None - """Inclusive end date.""" - - gt: Optional[Any] = None - """Exclusive start date.""" - - gte: Optional[Any] = None - """Inclusive start date.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationRangeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AggregationRangeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_aggregation_range_v2.py b/foundry/v1/models/_aggregation_range_v2.py deleted file mode 100644 index 6110f419..00000000 --- a/foundry/v1/models/_aggregation_range_v2.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._aggregation_range_v2_dict import AggregationRangeV2Dict - - -class AggregationRangeV2(BaseModel): - """Specifies a range from an inclusive start value to an exclusive end value.""" - - start_value: Any = Field(alias="startValue") - """Inclusive start.""" - - end_value: Any = Field(alias="endValue") - """Exclusive end.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationRangeV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AggregationRangeV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_aggregation_ranges_grouping.py b/foundry/v1/models/_aggregation_ranges_grouping.py deleted file mode 100644 index 75e64093..00000000 --- a/foundry/v1/models/_aggregation_ranges_grouping.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_range import AggregationRange -from foundry.v1.models._aggregation_ranges_grouping_dict import ( - AggregationRangesGroupingDict, -) # NOQA -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class AggregationRangesGrouping(BaseModel): - """Divides objects into groups according to specified ranges.""" - - field: FieldNameV1 - - ranges: List[AggregationRange] - - type: Literal["ranges"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationRangesGroupingDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationRangesGroupingDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregation_ranges_grouping_dict.py b/foundry/v1/models/_aggregation_ranges_grouping_dict.py deleted file mode 100644 index 4d12ee03..00000000 --- a/foundry/v1/models/_aggregation_ranges_grouping_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_range_dict import AggregationRangeDict -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class AggregationRangesGroupingDict(TypedDict): - """Divides objects into groups according to specified ranges.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - ranges: List[AggregationRangeDict] - - type: Literal["ranges"] diff --git a/foundry/v1/models/_aggregation_ranges_grouping_v2.py b/foundry/v1/models/_aggregation_ranges_grouping_v2.py deleted file mode 100644 index 3757f827..00000000 --- a/foundry/v1/models/_aggregation_ranges_grouping_v2.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_range_v2 import AggregationRangeV2 -from foundry.v1.models._aggregation_ranges_grouping_v2_dict import ( - AggregationRangesGroupingV2Dict, -) # NOQA -from foundry.v1.models._property_api_name import PropertyApiName - - -class AggregationRangesGroupingV2(BaseModel): - """Divides objects into groups according to specified ranges.""" - - field: PropertyApiName - - ranges: List[AggregationRangeV2] - - type: Literal["ranges"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationRangesGroupingV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationRangesGroupingV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_aggregation_ranges_grouping_v2_dict.py b/foundry/v1/models/_aggregation_ranges_grouping_v2_dict.py deleted file mode 100644 index 14d39fc4..00000000 --- a/foundry/v1/models/_aggregation_ranges_grouping_v2_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_range_v2_dict import AggregationRangeV2Dict -from foundry.v1.models._property_api_name import PropertyApiName - - -class AggregationRangesGroupingV2Dict(TypedDict): - """Divides objects into groups according to specified ranges.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - ranges: List[AggregationRangeV2Dict] - - type: Literal["ranges"] diff --git a/foundry/v1/models/_aggregation_v2.py b/foundry/v1/models/_aggregation_v2.py deleted file mode 100644 index 4217f861..00000000 --- a/foundry/v1/models/_aggregation_v2.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._approximate_distinct_aggregation_v2 import ( - ApproximateDistinctAggregationV2, -) # NOQA -from foundry.v1.models._approximate_percentile_aggregation_v2 import ( - ApproximatePercentileAggregationV2, -) # NOQA -from foundry.v1.models._avg_aggregation_v2 import AvgAggregationV2 -from foundry.v1.models._count_aggregation_v2 import CountAggregationV2 -from foundry.v1.models._exact_distinct_aggregation_v2 import ExactDistinctAggregationV2 -from foundry.v1.models._max_aggregation_v2 import MaxAggregationV2 -from foundry.v1.models._min_aggregation_v2 import MinAggregationV2 -from foundry.v1.models._sum_aggregation_v2 import SumAggregationV2 - -AggregationV2 = Annotated[ - Union[ - MaxAggregationV2, - MinAggregationV2, - AvgAggregationV2, - SumAggregationV2, - CountAggregationV2, - ApproximateDistinctAggregationV2, - ApproximatePercentileAggregationV2, - ExactDistinctAggregationV2, - ], - Field(discriminator="type"), -] -"""Specifies an aggregation function.""" diff --git a/foundry/v1/models/_aggregation_v2_dict.py b/foundry/v1/models/_aggregation_v2_dict.py deleted file mode 100644 index b9babd56..00000000 --- a/foundry/v1/models/_aggregation_v2_dict.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._approximate_distinct_aggregation_v2_dict import ( - ApproximateDistinctAggregationV2Dict, -) # NOQA -from foundry.v1.models._approximate_percentile_aggregation_v2_dict import ( - ApproximatePercentileAggregationV2Dict, -) # NOQA -from foundry.v1.models._avg_aggregation_v2_dict import AvgAggregationV2Dict -from foundry.v1.models._count_aggregation_v2_dict import CountAggregationV2Dict -from foundry.v1.models._exact_distinct_aggregation_v2_dict import ( - ExactDistinctAggregationV2Dict, -) # NOQA -from foundry.v1.models._max_aggregation_v2_dict import MaxAggregationV2Dict -from foundry.v1.models._min_aggregation_v2_dict import MinAggregationV2Dict -from foundry.v1.models._sum_aggregation_v2_dict import SumAggregationV2Dict - -AggregationV2Dict = Annotated[ - Union[ - MaxAggregationV2Dict, - MinAggregationV2Dict, - AvgAggregationV2Dict, - SumAggregationV2Dict, - CountAggregationV2Dict, - ApproximateDistinctAggregationV2Dict, - ApproximatePercentileAggregationV2Dict, - ExactDistinctAggregationV2Dict, - ], - Field(discriminator="type"), -] -"""Specifies an aggregation function.""" diff --git a/foundry/v1/models/_all_terms_query.py b/foundry/v1/models/_all_terms_query.py deleted file mode 100644 index bb2380c0..00000000 --- a/foundry/v1/models/_all_terms_query.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v1.models._all_terms_query_dict import AllTermsQueryDict -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._fuzzy import Fuzzy - - -class AllTermsQuery(BaseModel): - """ - Returns objects where the specified field contains all of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - field: FieldNameV1 - - value: StrictStr - - fuzzy: Optional[Fuzzy] = None - - type: Literal["allTerms"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AllTermsQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AllTermsQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_all_terms_query_dict.py b/foundry/v1/models/_all_terms_query_dict.py deleted file mode 100644 index a1229170..00000000 --- a/foundry/v1/models/_all_terms_query_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._fuzzy import Fuzzy - - -class AllTermsQueryDict(TypedDict): - """ - Returns objects where the specified field contains all of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: StrictStr - - fuzzy: NotRequired[Fuzzy] - - type: Literal["allTerms"] diff --git a/foundry/v1/models/_any_term_query.py b/foundry/v1/models/_any_term_query.py deleted file mode 100644 index a0faafc7..00000000 --- a/foundry/v1/models/_any_term_query.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v1.models._any_term_query_dict import AnyTermQueryDict -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._fuzzy import Fuzzy - - -class AnyTermQuery(BaseModel): - """ - Returns objects where the specified field contains any of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - field: FieldNameV1 - - value: StrictStr - - fuzzy: Optional[Fuzzy] = None - - type: Literal["anyTerm"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AnyTermQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AnyTermQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_any_term_query_dict.py b/foundry/v1/models/_any_term_query_dict.py deleted file mode 100644 index a02ad057..00000000 --- a/foundry/v1/models/_any_term_query_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._fuzzy import Fuzzy - - -class AnyTermQueryDict(TypedDict): - """ - Returns objects where the specified field contains any of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: StrictStr - - fuzzy: NotRequired[Fuzzy] - - type: Literal["anyTerm"] diff --git a/foundry/v1/models/_any_type.py b/foundry/v1/models/_any_type.py deleted file mode 100644 index b595225b..00000000 --- a/foundry/v1/models/_any_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._any_type_dict import AnyTypeDict - - -class AnyType(BaseModel): - """AnyType""" - - type: Literal["any"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AnyTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AnyTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_apply_action_request.py b/foundry/v1/models/_apply_action_request.py deleted file mode 100644 index 2971c585..00000000 --- a/foundry/v1/models/_apply_action_request.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._apply_action_request_dict import ApplyActionRequestDict -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._parameter_id import ParameterId - - -class ApplyActionRequest(BaseModel): - """ApplyActionRequest""" - - parameters: Dict[ParameterId, Optional[DataValue]] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApplyActionRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ApplyActionRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_apply_action_request_dict.py b/foundry/v1/models/_apply_action_request_dict.py deleted file mode 100644 index ff1ccb6e..00000000 --- a/foundry/v1/models/_apply_action_request_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import TypedDict - -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._parameter_id import ParameterId - - -class ApplyActionRequestDict(TypedDict): - """ApplyActionRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v1/models/_apply_action_request_options.py b/foundry/v1/models/_apply_action_request_options.py deleted file mode 100644 index 0e7589c1..00000000 --- a/foundry/v1/models/_apply_action_request_options.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._apply_action_mode import ApplyActionMode -from foundry.v1.models._apply_action_request_options_dict import ( - ApplyActionRequestOptionsDict, -) # NOQA -from foundry.v1.models._return_edits_mode import ReturnEditsMode - - -class ApplyActionRequestOptions(BaseModel): - """ApplyActionRequestOptions""" - - mode: Optional[ApplyActionMode] = None - - return_edits: Optional[ReturnEditsMode] = Field(alias="returnEdits", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApplyActionRequestOptionsDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ApplyActionRequestOptionsDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_apply_action_request_options_dict.py b/foundry/v1/models/_apply_action_request_options_dict.py deleted file mode 100644 index 1a414e1a..00000000 --- a/foundry/v1/models/_apply_action_request_options_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._apply_action_mode import ApplyActionMode -from foundry.v1.models._return_edits_mode import ReturnEditsMode - - -class ApplyActionRequestOptionsDict(TypedDict): - """ApplyActionRequestOptions""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - mode: NotRequired[ApplyActionMode] - - returnEdits: NotRequired[ReturnEditsMode] diff --git a/foundry/v1/models/_apply_action_request_v2.py b/foundry/v1/models/_apply_action_request_v2.py deleted file mode 100644 index d9a77ad6..00000000 --- a/foundry/v1/models/_apply_action_request_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._apply_action_request_options import ApplyActionRequestOptions -from foundry.v1.models._apply_action_request_v2_dict import ApplyActionRequestV2Dict -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._parameter_id import ParameterId - - -class ApplyActionRequestV2(BaseModel): - """ApplyActionRequestV2""" - - options: Optional[ApplyActionRequestOptions] = None - - parameters: Dict[ParameterId, Optional[DataValue]] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApplyActionRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ApplyActionRequestV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_apply_action_request_v2_dict.py b/foundry/v1/models/_apply_action_request_v2_dict.py deleted file mode 100644 index 291583ae..00000000 --- a/foundry/v1/models/_apply_action_request_v2_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._apply_action_request_options_dict import ( - ApplyActionRequestOptionsDict, -) # NOQA -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._parameter_id import ParameterId - - -class ApplyActionRequestV2Dict(TypedDict): - """ApplyActionRequestV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - options: NotRequired[ApplyActionRequestOptionsDict] - - parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v1/models/_apply_action_response.py b/foundry/v1/models/_apply_action_response.py deleted file mode 100644 index 730fd4d4..00000000 --- a/foundry/v1/models/_apply_action_response.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._apply_action_response_dict import ApplyActionResponseDict - - -class ApplyActionResponse(BaseModel): - """ApplyActionResponse""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApplyActionResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ApplyActionResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_approximate_distinct_aggregation.py b/foundry/v1/models/_approximate_distinct_aggregation.py deleted file mode 100644 index fb66ee49..00000000 --- a/foundry/v1/models/_approximate_distinct_aggregation.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._approximate_distinct_aggregation_dict import ( - ApproximateDistinctAggregationDict, -) # NOQA -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class ApproximateDistinctAggregation(BaseModel): - """Computes an approximate number of distinct values for the provided field.""" - - field: FieldNameV1 - - name: Optional[AggregationMetricName] = None - - type: Literal["approximateDistinct"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApproximateDistinctAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ApproximateDistinctAggregationDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_approximate_distinct_aggregation_dict.py b/foundry/v1/models/_approximate_distinct_aggregation_dict.py deleted file mode 100644 index 33c30a59..00000000 --- a/foundry/v1/models/_approximate_distinct_aggregation_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class ApproximateDistinctAggregationDict(TypedDict): - """Computes an approximate number of distinct values for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - name: NotRequired[AggregationMetricName] - - type: Literal["approximateDistinct"] diff --git a/foundry/v1/models/_approximate_distinct_aggregation_v2.py b/foundry/v1/models/_approximate_distinct_aggregation_v2.py deleted file mode 100644 index 5f3c7a9d..00000000 --- a/foundry/v1/models/_approximate_distinct_aggregation_v2.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._approximate_distinct_aggregation_v2_dict import ( - ApproximateDistinctAggregationV2Dict, -) # NOQA -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._property_api_name import PropertyApiName - - -class ApproximateDistinctAggregationV2(BaseModel): - """Computes an approximate number of distinct values for the provided field.""" - - field: PropertyApiName - - name: Optional[AggregationMetricName] = None - - direction: Optional[OrderByDirection] = None - - type: Literal["approximateDistinct"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApproximateDistinctAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ApproximateDistinctAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_approximate_distinct_aggregation_v2_dict.py b/foundry/v1/models/_approximate_distinct_aggregation_v2_dict.py deleted file mode 100644 index 71fdc4a9..00000000 --- a/foundry/v1/models/_approximate_distinct_aggregation_v2_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._property_api_name import PropertyApiName - - -class ApproximateDistinctAggregationV2Dict(TypedDict): - """Computes an approximate number of distinct values for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - name: NotRequired[AggregationMetricName] - - direction: NotRequired[OrderByDirection] - - type: Literal["approximateDistinct"] diff --git a/foundry/v1/models/_approximate_percentile_aggregation_v2.py b/foundry/v1/models/_approximate_percentile_aggregation_v2.py deleted file mode 100644 index e331adcf..00000000 --- a/foundry/v1/models/_approximate_percentile_aggregation_v2.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictFloat - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._approximate_percentile_aggregation_v2_dict import ( - ApproximatePercentileAggregationV2Dict, -) # NOQA -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._property_api_name import PropertyApiName - - -class ApproximatePercentileAggregationV2(BaseModel): - """Computes the approximate percentile value for the provided field. Requires Object Storage V2.""" - - field: PropertyApiName - - name: Optional[AggregationMetricName] = None - - approximate_percentile: StrictFloat = Field(alias="approximatePercentile") - - direction: Optional[OrderByDirection] = None - - type: Literal["approximatePercentile"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApproximatePercentileAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ApproximatePercentileAggregationV2Dict, - self.model_dump(by_alias=True, exclude_unset=True), - ) diff --git a/foundry/v1/models/_approximate_percentile_aggregation_v2_dict.py b/foundry/v1/models/_approximate_percentile_aggregation_v2_dict.py deleted file mode 100644 index 8c40aeae..00000000 --- a/foundry/v1/models/_approximate_percentile_aggregation_v2_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictFloat -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._property_api_name import PropertyApiName - - -class ApproximatePercentileAggregationV2Dict(TypedDict): - """Computes the approximate percentile value for the provided field. Requires Object Storage V2.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - name: NotRequired[AggregationMetricName] - - approximatePercentile: StrictFloat - - direction: NotRequired[OrderByDirection] - - type: Literal["approximatePercentile"] diff --git a/foundry/v1/models/_archive_file_format.py b/foundry/v1/models/_archive_file_format.py deleted file mode 100644 index 4bcba7ea..00000000 --- a/foundry/v1/models/_archive_file_format.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -ArchiveFileFormat = Literal["ZIP"] -"""The format of an archive file.""" diff --git a/foundry/v1/models/_arg.py b/foundry/v1/models/_arg.py deleted file mode 100644 index ab2d18f4..00000000 --- a/foundry/v1/models/_arg.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v1.models._arg_dict import ArgDict - - -class Arg(BaseModel): - """Arg""" - - name: StrictStr - - value: StrictStr - - model_config = {"extra": "allow"} - - def to_dict(self) -> ArgDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ArgDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_arg_dict.py b/foundry/v1/models/_arg_dict.py deleted file mode 100644 index 1278721c..00000000 --- a/foundry/v1/models/_arg_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import TypedDict - - -class ArgDict(TypedDict): - """Arg""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: StrictStr - - value: StrictStr diff --git a/foundry/v1/models/_array_size_constraint.py b/foundry/v1/models/_array_size_constraint.py deleted file mode 100644 index 8b6aca80..00000000 --- a/foundry/v1/models/_array_size_constraint.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._array_size_constraint_dict import ArraySizeConstraintDict - - -class ArraySizeConstraint(BaseModel): - """The parameter expects an array of values and the size of the array must fall within the defined range.""" - - lt: Optional[Any] = None - """Less than""" - - lte: Optional[Any] = None - """Less than or equal""" - - gt: Optional[Any] = None - """Greater than""" - - gte: Optional[Any] = None - """Greater than or equal""" - - type: Literal["arraySize"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ArraySizeConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ArraySizeConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_async_action_status.py b/foundry/v1/models/_async_action_status.py deleted file mode 100644 index 5f398c69..00000000 --- a/foundry/v1/models/_async_action_status.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -AsyncActionStatus = Literal[ - "RUNNING_SUBMISSION_CHECKS", - "EXECUTING_WRITE_BACK_WEBHOOK", - "COMPUTING_ONTOLOGY_EDITS", - "COMPUTING_FUNCTION", - "WRITING_ONTOLOGY_EDITS", - "EXECUTING_SIDE_EFFECT_WEBHOOK", - "SENDING_NOTIFICATIONS", -] -"""AsyncActionStatus""" diff --git a/foundry/v1/models/_async_apply_action_operation_response_v2.py b/foundry/v1/models/_async_apply_action_operation_response_v2.py deleted file mode 100644 index 1c4332b0..00000000 --- a/foundry/v1/models/_async_apply_action_operation_response_v2.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._async_apply_action_operation_response_v2_dict import ( - AsyncApplyActionOperationResponseV2Dict, -) # NOQA - - -class AsyncApplyActionOperationResponseV2(BaseModel): - """AsyncApplyActionOperationResponseV2""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> AsyncApplyActionOperationResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AsyncApplyActionOperationResponseV2Dict, - self.model_dump(by_alias=True, exclude_unset=True), - ) diff --git a/foundry/v1/models/_async_apply_action_operation_response_v2_dict.py b/foundry/v1/models/_async_apply_action_operation_response_v2_dict.py deleted file mode 100644 index 03cfc825..00000000 --- a/foundry/v1/models/_async_apply_action_operation_response_v2_dict.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - - -class AsyncApplyActionOperationResponseV2Dict(TypedDict): - """AsyncApplyActionOperationResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v1/models/_async_apply_action_request.py b/foundry/v1/models/_async_apply_action_request.py deleted file mode 100644 index 7ae18a0c..00000000 --- a/foundry/v1/models/_async_apply_action_request.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._async_apply_action_request_dict import AsyncApplyActionRequestDict # NOQA -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._parameter_id import ParameterId - - -class AsyncApplyActionRequest(BaseModel): - """AsyncApplyActionRequest""" - - parameters: Dict[ParameterId, Optional[DataValue]] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AsyncApplyActionRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AsyncApplyActionRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_async_apply_action_request_dict.py b/foundry/v1/models/_async_apply_action_request_dict.py deleted file mode 100644 index 173c4c60..00000000 --- a/foundry/v1/models/_async_apply_action_request_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import TypedDict - -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._parameter_id import ParameterId - - -class AsyncApplyActionRequestDict(TypedDict): - """AsyncApplyActionRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v1/models/_async_apply_action_request_v2.py b/foundry/v1/models/_async_apply_action_request_v2.py deleted file mode 100644 index 10a76617..00000000 --- a/foundry/v1/models/_async_apply_action_request_v2.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._async_apply_action_request_v2_dict import ( - AsyncApplyActionRequestV2Dict, -) # NOQA -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._parameter_id import ParameterId - - -class AsyncApplyActionRequestV2(BaseModel): - """AsyncApplyActionRequestV2""" - - parameters: Dict[ParameterId, Optional[DataValue]] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AsyncApplyActionRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AsyncApplyActionRequestV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_async_apply_action_request_v2_dict.py b/foundry/v1/models/_async_apply_action_request_v2_dict.py deleted file mode 100644 index 4b65f1ff..00000000 --- a/foundry/v1/models/_async_apply_action_request_v2_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import TypedDict - -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._parameter_id import ParameterId - - -class AsyncApplyActionRequestV2Dict(TypedDict): - """AsyncApplyActionRequestV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v1/models/_async_apply_action_response.py b/foundry/v1/models/_async_apply_action_response.py deleted file mode 100644 index 029c03c3..00000000 --- a/foundry/v1/models/_async_apply_action_response.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._async_apply_action_response_dict import AsyncApplyActionResponseDict # NOQA - - -class AsyncApplyActionResponse(BaseModel): - """AsyncApplyActionResponse""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> AsyncApplyActionResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AsyncApplyActionResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_async_apply_action_response_dict.py b/foundry/v1/models/_async_apply_action_response_dict.py deleted file mode 100644 index 39d048fb..00000000 --- a/foundry/v1/models/_async_apply_action_response_dict.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - - -class AsyncApplyActionResponseDict(TypedDict): - """AsyncApplyActionResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v1/models/_async_apply_action_response_v2.py b/foundry/v1/models/_async_apply_action_response_v2.py deleted file mode 100644 index 58c627ca..00000000 --- a/foundry/v1/models/_async_apply_action_response_v2.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry._core.utils import RID -from foundry.v1.models._async_apply_action_response_v2_dict import ( - AsyncApplyActionResponseV2Dict, -) # NOQA - - -class AsyncApplyActionResponseV2(BaseModel): - """AsyncApplyActionResponseV2""" - - operation_id: RID = Field(alias="operationId") - - model_config = {"extra": "allow"} - - def to_dict(self) -> AsyncApplyActionResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AsyncApplyActionResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_async_apply_action_response_v2_dict.py b/foundry/v1/models/_async_apply_action_response_v2_dict.py deleted file mode 100644 index 2748bc32..00000000 --- a/foundry/v1/models/_async_apply_action_response_v2_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry._core.utils import RID - - -class AsyncApplyActionResponseV2Dict(TypedDict): - """AsyncApplyActionResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - operationId: RID diff --git a/foundry/v1/models/_attachment.py b/foundry/v1/models/_attachment.py deleted file mode 100644 index 39495f5b..00000000 --- a/foundry/v1/models/_attachment.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._attachment_dict import AttachmentDict -from foundry.v1.models._attachment_rid import AttachmentRid -from foundry.v1.models._filename import Filename -from foundry.v1.models._media_type import MediaType -from foundry.v1.models._size_bytes import SizeBytes - - -class Attachment(BaseModel): - """The representation of an attachment.""" - - rid: AttachmentRid - - filename: Filename - - size_bytes: SizeBytes = Field(alias="sizeBytes") - - media_type: MediaType = Field(alias="mediaType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> AttachmentDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AttachmentDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_attachment_dict.py b/foundry/v1/models/_attachment_dict.py deleted file mode 100644 index 58617686..00000000 --- a/foundry/v1/models/_attachment_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v1.models._attachment_rid import AttachmentRid -from foundry.v1.models._filename import Filename -from foundry.v1.models._media_type import MediaType -from foundry.v1.models._size_bytes import SizeBytes - - -class AttachmentDict(TypedDict): - """The representation of an attachment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: AttachmentRid - - filename: Filename - - sizeBytes: SizeBytes - - mediaType: MediaType diff --git a/foundry/v1/models/_attachment_metadata_response.py b/foundry/v1/models/_attachment_metadata_response.py deleted file mode 100644 index 0dabe163..00000000 --- a/foundry/v1/models/_attachment_metadata_response.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._attachment_v2 import AttachmentV2 -from foundry.v1.models._list_attachments_response_v2 import ListAttachmentsResponseV2 - -AttachmentMetadataResponse = Annotated[ - Union[AttachmentV2, ListAttachmentsResponseV2], Field(discriminator="type") -] -"""The attachment metadata response""" diff --git a/foundry/v1/models/_attachment_metadata_response_dict.py b/foundry/v1/models/_attachment_metadata_response_dict.py deleted file mode 100644 index c2bd53f5..00000000 --- a/foundry/v1/models/_attachment_metadata_response_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._attachment_v2_dict import AttachmentV2Dict -from foundry.v1.models._list_attachments_response_v2_dict import ( - ListAttachmentsResponseV2Dict, -) # NOQA - -AttachmentMetadataResponseDict = Annotated[ - Union[AttachmentV2Dict, ListAttachmentsResponseV2Dict], Field(discriminator="type") -] -"""The attachment metadata response""" diff --git a/foundry/v1/models/_attachment_property.py b/foundry/v1/models/_attachment_property.py deleted file mode 100644 index 64bd7d4f..00000000 --- a/foundry/v1/models/_attachment_property.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._attachment_property_dict import AttachmentPropertyDict -from foundry.v1.models._attachment_rid import AttachmentRid - - -class AttachmentProperty(BaseModel): - """The representation of an attachment as a data type.""" - - rid: AttachmentRid - - model_config = {"extra": "allow"} - - def to_dict(self) -> AttachmentPropertyDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AttachmentPropertyDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_attachment_property_dict.py b/foundry/v1/models/_attachment_property_dict.py deleted file mode 100644 index 5ec109bb..00000000 --- a/foundry/v1/models/_attachment_property_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v1.models._attachment_rid import AttachmentRid - - -class AttachmentPropertyDict(TypedDict): - """The representation of an attachment as a data type.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: AttachmentRid diff --git a/foundry/v1/models/_attachment_type.py b/foundry/v1/models/_attachment_type.py deleted file mode 100644 index 1064498e..00000000 --- a/foundry/v1/models/_attachment_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._attachment_type_dict import AttachmentTypeDict - - -class AttachmentType(BaseModel): - """AttachmentType""" - - type: Literal["attachment"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AttachmentTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AttachmentTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_attachment_v2.py b/foundry/v1/models/_attachment_v2.py deleted file mode 100644 index 0da58157..00000000 --- a/foundry/v1/models/_attachment_v2.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._attachment_rid import AttachmentRid -from foundry.v1.models._attachment_v2_dict import AttachmentV2Dict -from foundry.v1.models._filename import Filename -from foundry.v1.models._media_type import MediaType -from foundry.v1.models._size_bytes import SizeBytes - - -class AttachmentV2(BaseModel): - """The representation of an attachment.""" - - rid: AttachmentRid - - filename: Filename - - size_bytes: SizeBytes = Field(alias="sizeBytes") - - media_type: MediaType = Field(alias="mediaType") - - type: Literal["single"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AttachmentV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AttachmentV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_attachment_v2_dict.py b/foundry/v1/models/_attachment_v2_dict.py deleted file mode 100644 index a1b7c0a2..00000000 --- a/foundry/v1/models/_attachment_v2_dict.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._attachment_rid import AttachmentRid -from foundry.v1.models._filename import Filename -from foundry.v1.models._media_type import MediaType -from foundry.v1.models._size_bytes import SizeBytes - - -class AttachmentV2Dict(TypedDict): - """The representation of an attachment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: AttachmentRid - - filename: Filename - - sizeBytes: SizeBytes - - mediaType: MediaType - - type: Literal["single"] diff --git a/foundry/v1/models/_avg_aggregation.py b/foundry/v1/models/_avg_aggregation.py deleted file mode 100644 index 00b3acdb..00000000 --- a/foundry/v1/models/_avg_aggregation.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._avg_aggregation_dict import AvgAggregationDict -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class AvgAggregation(BaseModel): - """Computes the average value for the provided field.""" - - field: FieldNameV1 - - name: Optional[AggregationMetricName] = None - - type: Literal["avg"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AvgAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AvgAggregationDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_avg_aggregation_dict.py b/foundry/v1/models/_avg_aggregation_dict.py deleted file mode 100644 index 1b068e52..00000000 --- a/foundry/v1/models/_avg_aggregation_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class AvgAggregationDict(TypedDict): - """Computes the average value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - name: NotRequired[AggregationMetricName] - - type: Literal["avg"] diff --git a/foundry/v1/models/_avg_aggregation_v2.py b/foundry/v1/models/_avg_aggregation_v2.py deleted file mode 100644 index 41620041..00000000 --- a/foundry/v1/models/_avg_aggregation_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._avg_aggregation_v2_dict import AvgAggregationV2Dict -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._property_api_name import PropertyApiName - - -class AvgAggregationV2(BaseModel): - """Computes the average value for the provided field.""" - - field: PropertyApiName - - name: Optional[AggregationMetricName] = None - - direction: Optional[OrderByDirection] = None - - type: Literal["avg"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AvgAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AvgAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_avg_aggregation_v2_dict.py b/foundry/v1/models/_avg_aggregation_v2_dict.py deleted file mode 100644 index f6f88ed6..00000000 --- a/foundry/v1/models/_avg_aggregation_v2_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._property_api_name import PropertyApiName - - -class AvgAggregationV2Dict(TypedDict): - """Computes the average value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - name: NotRequired[AggregationMetricName] - - direction: NotRequired[OrderByDirection] - - type: Literal["avg"] diff --git a/foundry/v1/models/_b_box.py b/foundry/v1/models/_b_box.py deleted file mode 100644 index c516d6d8..00000000 --- a/foundry/v1/models/_b_box.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from foundry.v1.models._coordinate import Coordinate - -BBox = List[Coordinate] -""" -A GeoJSON object MAY have a member named "bbox" to include -information on the coordinate range for its Geometries, Features, or -FeatureCollections. The value of the bbox member MUST be an array of -length 2*n where n is the number of dimensions represented in the -contained geometries, with all axes of the most southwesterly point -followed by all axes of the more northeasterly point. The axes order -of a bbox follows the axes order of geometries. -""" diff --git a/foundry/v1/models/_batch_apply_action_request.py b/foundry/v1/models/_batch_apply_action_request.py deleted file mode 100644 index a5c82e5c..00000000 --- a/foundry/v1/models/_batch_apply_action_request.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._apply_action_request import ApplyActionRequest -from foundry.v1.models._batch_apply_action_request_dict import BatchApplyActionRequestDict # NOQA - - -class BatchApplyActionRequest(BaseModel): - """BatchApplyActionRequest""" - - requests: List[ApplyActionRequest] - - model_config = {"extra": "allow"} - - def to_dict(self) -> BatchApplyActionRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(BatchApplyActionRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_batch_apply_action_request_dict.py b/foundry/v1/models/_batch_apply_action_request_dict.py deleted file mode 100644 index 43a89924..00000000 --- a/foundry/v1/models/_batch_apply_action_request_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._apply_action_request_dict import ApplyActionRequestDict - - -class BatchApplyActionRequestDict(TypedDict): - """BatchApplyActionRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - requests: List[ApplyActionRequestDict] diff --git a/foundry/v1/models/_batch_apply_action_request_item.py b/foundry/v1/models/_batch_apply_action_request_item.py deleted file mode 100644 index 6c45a66d..00000000 --- a/foundry/v1/models/_batch_apply_action_request_item.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._batch_apply_action_request_item_dict import ( - BatchApplyActionRequestItemDict, -) # NOQA -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._parameter_id import ParameterId - - -class BatchApplyActionRequestItem(BaseModel): - """BatchApplyActionRequestItem""" - - parameters: Dict[ParameterId, Optional[DataValue]] - - model_config = {"extra": "allow"} - - def to_dict(self) -> BatchApplyActionRequestItemDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - BatchApplyActionRequestItemDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_batch_apply_action_request_item_dict.py b/foundry/v1/models/_batch_apply_action_request_item_dict.py deleted file mode 100644 index 34e4e760..00000000 --- a/foundry/v1/models/_batch_apply_action_request_item_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import TypedDict - -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._parameter_id import ParameterId - - -class BatchApplyActionRequestItemDict(TypedDict): - """BatchApplyActionRequestItem""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v1/models/_batch_apply_action_request_options.py b/foundry/v1/models/_batch_apply_action_request_options.py deleted file mode 100644 index c2af58d3..00000000 --- a/foundry/v1/models/_batch_apply_action_request_options.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._batch_apply_action_request_options_dict import ( - BatchApplyActionRequestOptionsDict, -) # NOQA -from foundry.v1.models._return_edits_mode import ReturnEditsMode - - -class BatchApplyActionRequestOptions(BaseModel): - """BatchApplyActionRequestOptions""" - - return_edits: Optional[ReturnEditsMode] = Field(alias="returnEdits", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> BatchApplyActionRequestOptionsDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - BatchApplyActionRequestOptionsDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_batch_apply_action_request_options_dict.py b/foundry/v1/models/_batch_apply_action_request_options_dict.py deleted file mode 100644 index 6e7468fa..00000000 --- a/foundry/v1/models/_batch_apply_action_request_options_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._return_edits_mode import ReturnEditsMode - - -class BatchApplyActionRequestOptionsDict(TypedDict): - """BatchApplyActionRequestOptions""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - returnEdits: NotRequired[ReturnEditsMode] diff --git a/foundry/v1/models/_batch_apply_action_request_v2.py b/foundry/v1/models/_batch_apply_action_request_v2.py deleted file mode 100644 index b37890bb..00000000 --- a/foundry/v1/models/_batch_apply_action_request_v2.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._batch_apply_action_request_item import BatchApplyActionRequestItem # NOQA -from foundry.v1.models._batch_apply_action_request_options import ( - BatchApplyActionRequestOptions, -) # NOQA -from foundry.v1.models._batch_apply_action_request_v2_dict import ( - BatchApplyActionRequestV2Dict, -) # NOQA - - -class BatchApplyActionRequestV2(BaseModel): - """BatchApplyActionRequestV2""" - - options: Optional[BatchApplyActionRequestOptions] = None - - requests: List[BatchApplyActionRequestItem] - - model_config = {"extra": "allow"} - - def to_dict(self) -> BatchApplyActionRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - BatchApplyActionRequestV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_batch_apply_action_request_v2_dict.py b/foundry/v1/models/_batch_apply_action_request_v2_dict.py deleted file mode 100644 index 479f1c74..00000000 --- a/foundry/v1/models/_batch_apply_action_request_v2_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._batch_apply_action_request_item_dict import ( - BatchApplyActionRequestItemDict, -) # NOQA -from foundry.v1.models._batch_apply_action_request_options_dict import ( - BatchApplyActionRequestOptionsDict, -) # NOQA - - -class BatchApplyActionRequestV2Dict(TypedDict): - """BatchApplyActionRequestV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - options: NotRequired[BatchApplyActionRequestOptionsDict] - - requests: List[BatchApplyActionRequestItemDict] diff --git a/foundry/v1/models/_batch_apply_action_response.py b/foundry/v1/models/_batch_apply_action_response.py deleted file mode 100644 index a459419f..00000000 --- a/foundry/v1/models/_batch_apply_action_response.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._batch_apply_action_response_dict import BatchApplyActionResponseDict # NOQA - - -class BatchApplyActionResponse(BaseModel): - """BatchApplyActionResponse""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> BatchApplyActionResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - BatchApplyActionResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_batch_apply_action_response_v2.py b/foundry/v1/models/_batch_apply_action_response_v2.py deleted file mode 100644 index e9b72a9a..00000000 --- a/foundry/v1/models/_batch_apply_action_response_v2.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._action_results import ActionResults -from foundry.v1.models._batch_apply_action_response_v2_dict import ( - BatchApplyActionResponseV2Dict, -) # NOQA - - -class BatchApplyActionResponseV2(BaseModel): - """BatchApplyActionResponseV2""" - - edits: Optional[ActionResults] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> BatchApplyActionResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - BatchApplyActionResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_batch_apply_action_response_v2_dict.py b/foundry/v1/models/_batch_apply_action_response_v2_dict.py deleted file mode 100644 index 10642aae..00000000 --- a/foundry/v1/models/_batch_apply_action_response_v2_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._action_results_dict import ActionResultsDict - - -class BatchApplyActionResponseV2Dict(TypedDict): - """BatchApplyActionResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - edits: NotRequired[ActionResultsDict] diff --git a/foundry/v1/models/_binary_type.py b/foundry/v1/models/_binary_type.py deleted file mode 100644 index 1f0c0e06..00000000 --- a/foundry/v1/models/_binary_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._binary_type_dict import BinaryTypeDict - - -class BinaryType(BaseModel): - """BinaryType""" - - type: Literal["binary"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> BinaryTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(BinaryTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_blueprint_icon.py b/foundry/v1/models/_blueprint_icon.py deleted file mode 100644 index ef9bde33..00000000 --- a/foundry/v1/models/_blueprint_icon.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v1.models._blueprint_icon_dict import BlueprintIconDict - - -class BlueprintIcon(BaseModel): - """BlueprintIcon""" - - color: StrictStr - """A hexadecimal color code.""" - - name: StrictStr - """ - The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. - Used to specify the Blueprint icon to represent the object type in a React app. - """ - - type: Literal["blueprint"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> BlueprintIconDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(BlueprintIconDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_boolean_type.py b/foundry/v1/models/_boolean_type.py deleted file mode 100644 index 16325024..00000000 --- a/foundry/v1/models/_boolean_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._boolean_type_dict import BooleanTypeDict - - -class BooleanType(BaseModel): - """BooleanType""" - - type: Literal["boolean"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> BooleanTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(BooleanTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_bounding_box_value.py b/foundry/v1/models/_bounding_box_value.py deleted file mode 100644 index 882452c8..00000000 --- a/foundry/v1/models/_bounding_box_value.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._bounding_box_value_dict import BoundingBoxValueDict -from foundry.v1.models._within_bounding_box_point import WithinBoundingBoxPoint - - -class BoundingBoxValue(BaseModel): - """The top left and bottom right coordinate points that make up the bounding box.""" - - top_left: WithinBoundingBoxPoint = Field(alias="topLeft") - - bottom_right: WithinBoundingBoxPoint = Field(alias="bottomRight") - - model_config = {"extra": "allow"} - - def to_dict(self) -> BoundingBoxValueDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(BoundingBoxValueDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_bounding_box_value_dict.py b/foundry/v1/models/_bounding_box_value_dict.py deleted file mode 100644 index 036f75d1..00000000 --- a/foundry/v1/models/_bounding_box_value_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v1.models._within_bounding_box_point_dict import WithinBoundingBoxPointDict - - -class BoundingBoxValueDict(TypedDict): - """The top left and bottom right coordinate points that make up the bounding box.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - topLeft: WithinBoundingBoxPointDict - - bottomRight: WithinBoundingBoxPointDict diff --git a/foundry/v1/models/_branch.py b/foundry/v1/models/_branch.py deleted file mode 100644 index 7f29f02e..00000000 --- a/foundry/v1/models/_branch.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._branch_dict import BranchDict -from foundry.v1.models._branch_id import BranchId -from foundry.v1.models._transaction_rid import TransactionRid - - -class Branch(BaseModel): - """A Branch of a Dataset.""" - - branch_id: BranchId = Field(alias="branchId") - - transaction_rid: Optional[TransactionRid] = Field(alias="transactionRid", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> BranchDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(BranchDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_branch_dict.py b/foundry/v1/models/_branch_dict.py deleted file mode 100644 index e13affcc..00000000 --- a/foundry/v1/models/_branch_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._branch_id import BranchId -from foundry.v1.models._transaction_rid import TransactionRid - - -class BranchDict(TypedDict): - """A Branch of a Dataset.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - branchId: BranchId - - transactionRid: NotRequired[TransactionRid] diff --git a/foundry/v1/models/_byte_type.py b/foundry/v1/models/_byte_type.py deleted file mode 100644 index ca912fa2..00000000 --- a/foundry/v1/models/_byte_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._byte_type_dict import ByteTypeDict - - -class ByteType(BaseModel): - """ByteType""" - - type: Literal["byte"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ByteTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ByteTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_center_point.py b/foundry/v1/models/_center_point.py deleted file mode 100644 index 9d915fd3..00000000 --- a/foundry/v1/models/_center_point.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._center_point_dict import CenterPointDict -from foundry.v1.models._center_point_types import CenterPointTypes -from foundry.v1.models._distance import Distance - - -class CenterPoint(BaseModel): - """The coordinate point to use as the center of the distance query.""" - - center: CenterPointTypes - - distance: Distance - - model_config = {"extra": "allow"} - - def to_dict(self) -> CenterPointDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CenterPointDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_center_point_dict.py b/foundry/v1/models/_center_point_dict.py deleted file mode 100644 index 25d5159d..00000000 --- a/foundry/v1/models/_center_point_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v1.models._center_point_types_dict import CenterPointTypesDict -from foundry.v1.models._distance_dict import DistanceDict - - -class CenterPointDict(TypedDict): - """The coordinate point to use as the center of the distance query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - center: CenterPointTypesDict - - distance: DistanceDict diff --git a/foundry/v1/models/_center_point_types.py b/foundry/v1/models/_center_point_types.py deleted file mode 100644 index 8baca393..00000000 --- a/foundry/v1/models/_center_point_types.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v1.models._geo_point import GeoPoint - -CenterPointTypes = GeoPoint -"""CenterPointTypes""" diff --git a/foundry/v1/models/_center_point_types_dict.py b/foundry/v1/models/_center_point_types_dict.py deleted file mode 100644 index 46706905..00000000 --- a/foundry/v1/models/_center_point_types_dict.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v1.models._geo_point_dict import GeoPointDict - -CenterPointTypesDict = GeoPointDict -"""CenterPointTypes""" diff --git a/foundry/v1/models/_contains_all_terms_in_order_prefix_last_term.py b/foundry/v1/models/_contains_all_terms_in_order_prefix_last_term.py deleted file mode 100644 index 8695b66e..00000000 --- a/foundry/v1/models/_contains_all_terms_in_order_prefix_last_term.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v1.models._contains_all_terms_in_order_prefix_last_term_dict import ( - ContainsAllTermsInOrderPrefixLastTermDict, -) # NOQA -from foundry.v1.models._property_api_name import PropertyApiName - - -class ContainsAllTermsInOrderPrefixLastTerm(BaseModel): - """ - Returns objects where the specified field contains all of the terms in the order provided, - but they do have to be adjacent to each other. - The last term can be a partial prefix match. - """ - - field: PropertyApiName - - value: StrictStr - - type: Literal["containsAllTermsInOrderPrefixLastTerm"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ContainsAllTermsInOrderPrefixLastTermDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ContainsAllTermsInOrderPrefixLastTermDict, - self.model_dump(by_alias=True, exclude_unset=True), - ) diff --git a/foundry/v1/models/_contains_all_terms_in_order_prefix_last_term_dict.py b/foundry/v1/models/_contains_all_terms_in_order_prefix_last_term_dict.py deleted file mode 100644 index dd742137..00000000 --- a/foundry/v1/models/_contains_all_terms_in_order_prefix_last_term_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName - - -class ContainsAllTermsInOrderPrefixLastTermDict(TypedDict): - """ - Returns objects where the specified field contains all of the terms in the order provided, - but they do have to be adjacent to each other. - The last term can be a partial prefix match. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: StrictStr - - type: Literal["containsAllTermsInOrderPrefixLastTerm"] diff --git a/foundry/v1/models/_contains_all_terms_in_order_query.py b/foundry/v1/models/_contains_all_terms_in_order_query.py deleted file mode 100644 index 27bf15a4..00000000 --- a/foundry/v1/models/_contains_all_terms_in_order_query.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v1.models._contains_all_terms_in_order_query_dict import ( - ContainsAllTermsInOrderQueryDict, -) # NOQA -from foundry.v1.models._property_api_name import PropertyApiName - - -class ContainsAllTermsInOrderQuery(BaseModel): - """ - Returns objects where the specified field contains all of the terms in the order provided, - but they do have to be adjacent to each other. - """ - - field: PropertyApiName - - value: StrictStr - - type: Literal["containsAllTermsInOrder"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ContainsAllTermsInOrderQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ContainsAllTermsInOrderQueryDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_contains_all_terms_in_order_query_dict.py b/foundry/v1/models/_contains_all_terms_in_order_query_dict.py deleted file mode 100644 index c48ab243..00000000 --- a/foundry/v1/models/_contains_all_terms_in_order_query_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName - - -class ContainsAllTermsInOrderQueryDict(TypedDict): - """ - Returns objects where the specified field contains all of the terms in the order provided, - but they do have to be adjacent to each other. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: StrictStr - - type: Literal["containsAllTermsInOrder"] diff --git a/foundry/v1/models/_contains_all_terms_query.py b/foundry/v1/models/_contains_all_terms_query.py deleted file mode 100644 index 148f3c24..00000000 --- a/foundry/v1/models/_contains_all_terms_query.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v1.models._contains_all_terms_query_dict import ContainsAllTermsQueryDict -from foundry.v1.models._fuzzy_v2 import FuzzyV2 -from foundry.v1.models._property_api_name import PropertyApiName - - -class ContainsAllTermsQuery(BaseModel): - """ - Returns objects where the specified field contains all of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - field: PropertyApiName - - value: StrictStr - - fuzzy: Optional[FuzzyV2] = None - - type: Literal["containsAllTerms"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ContainsAllTermsQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ContainsAllTermsQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_contains_all_terms_query_dict.py b/foundry/v1/models/_contains_all_terms_query_dict.py deleted file mode 100644 index 2c96850f..00000000 --- a/foundry/v1/models/_contains_all_terms_query_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._fuzzy_v2 import FuzzyV2 -from foundry.v1.models._property_api_name import PropertyApiName - - -class ContainsAllTermsQueryDict(TypedDict): - """ - Returns objects where the specified field contains all of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: StrictStr - - fuzzy: NotRequired[FuzzyV2] - - type: Literal["containsAllTerms"] diff --git a/foundry/v1/models/_contains_any_term_query.py b/foundry/v1/models/_contains_any_term_query.py deleted file mode 100644 index ef17fd64..00000000 --- a/foundry/v1/models/_contains_any_term_query.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v1.models._contains_any_term_query_dict import ContainsAnyTermQueryDict -from foundry.v1.models._fuzzy_v2 import FuzzyV2 -from foundry.v1.models._property_api_name import PropertyApiName - - -class ContainsAnyTermQuery(BaseModel): - """ - Returns objects where the specified field contains any of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - field: PropertyApiName - - value: StrictStr - - fuzzy: Optional[FuzzyV2] = None - - type: Literal["containsAnyTerm"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ContainsAnyTermQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ContainsAnyTermQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_contains_any_term_query_dict.py b/foundry/v1/models/_contains_any_term_query_dict.py deleted file mode 100644 index cda77742..00000000 --- a/foundry/v1/models/_contains_any_term_query_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._fuzzy_v2 import FuzzyV2 -from foundry.v1.models._property_api_name import PropertyApiName - - -class ContainsAnyTermQueryDict(TypedDict): - """ - Returns objects where the specified field contains any of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: StrictStr - - fuzzy: NotRequired[FuzzyV2] - - type: Literal["containsAnyTerm"] diff --git a/foundry/v1/models/_contains_query.py b/foundry/v1/models/_contains_query.py deleted file mode 100644 index 621dde52..00000000 --- a/foundry/v1/models/_contains_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._contains_query_dict import ContainsQueryDict -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._property_value import PropertyValue - - -class ContainsQuery(BaseModel): - """Returns objects where the specified array contains a value.""" - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["contains"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ContainsQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ContainsQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_contains_query_dict.py b/foundry/v1/models/_contains_query_dict.py deleted file mode 100644 index 0e9ff806..00000000 --- a/foundry/v1/models/_contains_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._property_value import PropertyValue - - -class ContainsQueryDict(TypedDict): - """Returns objects where the specified array contains a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["contains"] diff --git a/foundry/v1/models/_contains_query_v2.py b/foundry/v1/models/_contains_query_v2.py deleted file mode 100644 index 46849d73..00000000 --- a/foundry/v1/models/_contains_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._contains_query_v2_dict import ContainsQueryV2Dict -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - - -class ContainsQueryV2(BaseModel): - """Returns objects where the specified array contains a value.""" - - field: PropertyApiName - - value: PropertyValue - - type: Literal["contains"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ContainsQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ContainsQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_contains_query_v2_dict.py b/foundry/v1/models/_contains_query_v2_dict.py deleted file mode 100644 index 5d273414..00000000 --- a/foundry/v1/models/_contains_query_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - - -class ContainsQueryV2Dict(TypedDict): - """Returns objects where the specified array contains a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PropertyValue - - type: Literal["contains"] diff --git a/foundry/v1/models/_count_aggregation.py b/foundry/v1/models/_count_aggregation.py deleted file mode 100644 index ceffec1c..00000000 --- a/foundry/v1/models/_count_aggregation.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._count_aggregation_dict import CountAggregationDict - - -class CountAggregation(BaseModel): - """Computes the total count of objects.""" - - name: Optional[AggregationMetricName] = None - - type: Literal["count"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> CountAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CountAggregationDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_count_aggregation_dict.py b/foundry/v1/models/_count_aggregation_dict.py deleted file mode 100644 index 37d521bc..00000000 --- a/foundry/v1/models/_count_aggregation_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName - - -class CountAggregationDict(TypedDict): - """Computes the total count of objects.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: NotRequired[AggregationMetricName] - - type: Literal["count"] diff --git a/foundry/v1/models/_count_aggregation_v2.py b/foundry/v1/models/_count_aggregation_v2.py deleted file mode 100644 index 8cf9a046..00000000 --- a/foundry/v1/models/_count_aggregation_v2.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._count_aggregation_v2_dict import CountAggregationV2Dict -from foundry.v1.models._order_by_direction import OrderByDirection - - -class CountAggregationV2(BaseModel): - """Computes the total count of objects.""" - - name: Optional[AggregationMetricName] = None - - direction: Optional[OrderByDirection] = None - - type: Literal["count"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> CountAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CountAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_count_aggregation_v2_dict.py b/foundry/v1/models/_count_aggregation_v2_dict.py deleted file mode 100644 index babecb4b..00000000 --- a/foundry/v1/models/_count_aggregation_v2_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._order_by_direction import OrderByDirection - - -class CountAggregationV2Dict(TypedDict): - """Computes the total count of objects.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: NotRequired[AggregationMetricName] - - direction: NotRequired[OrderByDirection] - - type: Literal["count"] diff --git a/foundry/v1/models/_count_objects_response_v2.py b/foundry/v1/models/_count_objects_response_v2.py deleted file mode 100644 index c039026c..00000000 --- a/foundry/v1/models/_count_objects_response_v2.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictInt - -from foundry.v1.models._count_objects_response_v2_dict import CountObjectsResponseV2Dict - - -class CountObjectsResponseV2(BaseModel): - """CountObjectsResponseV2""" - - count: Optional[StrictInt] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> CountObjectsResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CountObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_create_branch_request.py b/foundry/v1/models/_create_branch_request.py deleted file mode 100644 index 21f3286f..00000000 --- a/foundry/v1/models/_create_branch_request.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._branch_id import BranchId -from foundry.v1.models._create_branch_request_dict import CreateBranchRequestDict -from foundry.v1.models._transaction_rid import TransactionRid - - -class CreateBranchRequest(BaseModel): - """CreateBranchRequest""" - - branch_id: BranchId = Field(alias="branchId") - - transaction_rid: Optional[TransactionRid] = Field(alias="transactionRid", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateBranchRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CreateBranchRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_create_branch_request_dict.py b/foundry/v1/models/_create_branch_request_dict.py deleted file mode 100644 index a5d6791f..00000000 --- a/foundry/v1/models/_create_branch_request_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._branch_id import BranchId -from foundry.v1.models._transaction_rid import TransactionRid - - -class CreateBranchRequestDict(TypedDict): - """CreateBranchRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - branchId: BranchId - - transactionRid: NotRequired[TransactionRid] diff --git a/foundry/v1/models/_create_dataset_request.py b/foundry/v1/models/_create_dataset_request.py deleted file mode 100644 index b8e9d986..00000000 --- a/foundry/v1/models/_create_dataset_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._create_dataset_request_dict import CreateDatasetRequestDict -from foundry.v1.models._dataset_name import DatasetName -from foundry.v1.models._folder_rid import FolderRid - - -class CreateDatasetRequest(BaseModel): - """CreateDatasetRequest""" - - name: DatasetName - - parent_folder_rid: FolderRid = Field(alias="parentFolderRid") - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateDatasetRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CreateDatasetRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_create_dataset_request_dict.py b/foundry/v1/models/_create_dataset_request_dict.py deleted file mode 100644 index 0fd6c61c..00000000 --- a/foundry/v1/models/_create_dataset_request_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v1.models._dataset_name import DatasetName -from foundry.v1.models._folder_rid import FolderRid - - -class CreateDatasetRequestDict(TypedDict): - """CreateDatasetRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: DatasetName - - parentFolderRid: FolderRid diff --git a/foundry/v1/models/_create_link_rule.py b/foundry/v1/models/_create_link_rule.py deleted file mode 100644 index c29caec6..00000000 --- a/foundry/v1/models/_create_link_rule.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._create_link_rule_dict import CreateLinkRuleDict -from foundry.v1.models._link_type_api_name import LinkTypeApiName -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class CreateLinkRule(BaseModel): - """CreateLinkRule""" - - link_type_api_name_ato_b: LinkTypeApiName = Field(alias="linkTypeApiNameAtoB") - - link_type_api_name_bto_a: LinkTypeApiName = Field(alias="linkTypeApiNameBtoA") - - a_side_object_type_api_name: ObjectTypeApiName = Field(alias="aSideObjectTypeApiName") - - b_side_object_type_api_name: ObjectTypeApiName = Field(alias="bSideObjectTypeApiName") - - type: Literal["createLink"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateLinkRuleDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CreateLinkRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_create_link_rule_dict.py b/foundry/v1/models/_create_link_rule_dict.py deleted file mode 100644 index 1f1c1763..00000000 --- a/foundry/v1/models/_create_link_rule_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._link_type_api_name import LinkTypeApiName -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class CreateLinkRuleDict(TypedDict): - """CreateLinkRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - linkTypeApiNameAtoB: LinkTypeApiName - - linkTypeApiNameBtoA: LinkTypeApiName - - aSideObjectTypeApiName: ObjectTypeApiName - - bSideObjectTypeApiName: ObjectTypeApiName - - type: Literal["createLink"] diff --git a/foundry/v1/models/_create_object_rule.py b/foundry/v1/models/_create_object_rule.py deleted file mode 100644 index d531252b..00000000 --- a/foundry/v1/models/_create_object_rule.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._create_object_rule_dict import CreateObjectRuleDict -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class CreateObjectRule(BaseModel): - """CreateObjectRule""" - - object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") - - type: Literal["createObject"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateObjectRuleDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CreateObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_create_object_rule_dict.py b/foundry/v1/models/_create_object_rule_dict.py deleted file mode 100644 index bf4147eb..00000000 --- a/foundry/v1/models/_create_object_rule_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class CreateObjectRuleDict(TypedDict): - """CreateObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectTypeApiName: ObjectTypeApiName - - type: Literal["createObject"] diff --git a/foundry/v1/models/_create_temporary_object_set_request_v2.py b/foundry/v1/models/_create_temporary_object_set_request_v2.py deleted file mode 100644 index 9d56422a..00000000 --- a/foundry/v1/models/_create_temporary_object_set_request_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._create_temporary_object_set_request_v2_dict import ( - CreateTemporaryObjectSetRequestV2Dict, -) # NOQA -from foundry.v1.models._object_set import ObjectSet - - -class CreateTemporaryObjectSetRequestV2(BaseModel): - """CreateTemporaryObjectSetRequestV2""" - - object_set: ObjectSet = Field(alias="objectSet") - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateTemporaryObjectSetRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - CreateTemporaryObjectSetRequestV2Dict, - self.model_dump(by_alias=True, exclude_unset=True), - ) diff --git a/foundry/v1/models/_create_temporary_object_set_request_v2_dict.py b/foundry/v1/models/_create_temporary_object_set_request_v2_dict.py deleted file mode 100644 index 695dd4d7..00000000 --- a/foundry/v1/models/_create_temporary_object_set_request_v2_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v1.models._object_set_dict import ObjectSetDict - - -class CreateTemporaryObjectSetRequestV2Dict(TypedDict): - """CreateTemporaryObjectSetRequestV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict diff --git a/foundry/v1/models/_create_temporary_object_set_response_v2.py b/foundry/v1/models/_create_temporary_object_set_response_v2.py deleted file mode 100644 index 5ab51aea..00000000 --- a/foundry/v1/models/_create_temporary_object_set_response_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._create_temporary_object_set_response_v2_dict import ( - CreateTemporaryObjectSetResponseV2Dict, -) # NOQA -from foundry.v1.models._object_set_rid import ObjectSetRid - - -class CreateTemporaryObjectSetResponseV2(BaseModel): - """CreateTemporaryObjectSetResponseV2""" - - object_set_rid: ObjectSetRid = Field(alias="objectSetRid") - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateTemporaryObjectSetResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - CreateTemporaryObjectSetResponseV2Dict, - self.model_dump(by_alias=True, exclude_unset=True), - ) diff --git a/foundry/v1/models/_create_temporary_object_set_response_v2_dict.py b/foundry/v1/models/_create_temporary_object_set_response_v2_dict.py deleted file mode 100644 index 29c01eee..00000000 --- a/foundry/v1/models/_create_temporary_object_set_response_v2_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v1.models._object_set_rid import ObjectSetRid - - -class CreateTemporaryObjectSetResponseV2Dict(TypedDict): - """CreateTemporaryObjectSetResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSetRid: ObjectSetRid diff --git a/foundry/v1/models/_create_transaction_request.py b/foundry/v1/models/_create_transaction_request.py deleted file mode 100644 index d65fdddf..00000000 --- a/foundry/v1/models/_create_transaction_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._create_transaction_request_dict import CreateTransactionRequestDict # NOQA -from foundry.v1.models._transaction_type import TransactionType - - -class CreateTransactionRequest(BaseModel): - """CreateTransactionRequest""" - - transaction_type: Optional[TransactionType] = Field(alias="transactionType", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateTransactionRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - CreateTransactionRequestDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_create_transaction_request_dict.py b/foundry/v1/models/_create_transaction_request_dict.py deleted file mode 100644 index f92cd1ea..00000000 --- a/foundry/v1/models/_create_transaction_request_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._transaction_type import TransactionType - - -class CreateTransactionRequestDict(TypedDict): - """CreateTransactionRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - transactionType: NotRequired[TransactionType] diff --git a/foundry/v1/models/_created_time.py b/foundry/v1/models/_created_time.py deleted file mode 100644 index 23bcd251..00000000 --- a/foundry/v1/models/_created_time.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -CreatedTime = StrictStr -"""The time at which the resource was created.""" diff --git a/foundry/v1/models/_custom_type_id.py b/foundry/v1/models/_custom_type_id.py deleted file mode 100644 index 35e38b08..00000000 --- a/foundry/v1/models/_custom_type_id.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -CustomTypeId = StrictStr -"""A UUID representing a custom type in a given Function.""" diff --git a/foundry/v1/models/_dataset.py b/foundry/v1/models/_dataset.py deleted file mode 100644 index 32645948..00000000 --- a/foundry/v1/models/_dataset.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._dataset_dict import DatasetDict -from foundry.v1.models._dataset_name import DatasetName -from foundry.v1.models._dataset_rid import DatasetRid -from foundry.v1.models._folder_rid import FolderRid - - -class Dataset(BaseModel): - """Dataset""" - - rid: DatasetRid - - name: DatasetName - - parent_folder_rid: FolderRid = Field(alias="parentFolderRid") - - model_config = {"extra": "allow"} - - def to_dict(self) -> DatasetDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DatasetDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_dataset_dict.py b/foundry/v1/models/_dataset_dict.py deleted file mode 100644 index d144c6dc..00000000 --- a/foundry/v1/models/_dataset_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v1.models._dataset_name import DatasetName -from foundry.v1.models._dataset_rid import DatasetRid -from foundry.v1.models._folder_rid import FolderRid - - -class DatasetDict(TypedDict): - """Dataset""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: DatasetRid - - name: DatasetName - - parentFolderRid: FolderRid diff --git a/foundry/v1/models/_date_type.py b/foundry/v1/models/_date_type.py deleted file mode 100644 index ad9e22fe..00000000 --- a/foundry/v1/models/_date_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._date_type_dict import DateTypeDict - - -class DateType(BaseModel): - """DateType""" - - type: Literal["date"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> DateTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DateTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_decimal_type.py b/foundry/v1/models/_decimal_type.py deleted file mode 100644 index 42d40c0b..00000000 --- a/foundry/v1/models/_decimal_type.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictInt - -from foundry.v1.models._decimal_type_dict import DecimalTypeDict - - -class DecimalType(BaseModel): - """DecimalType""" - - precision: Optional[StrictInt] = None - - scale: Optional[StrictInt] = None - - type: Literal["decimal"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> DecimalTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DecimalTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_delete_link_rule.py b/foundry/v1/models/_delete_link_rule.py deleted file mode 100644 index 0411f122..00000000 --- a/foundry/v1/models/_delete_link_rule.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._delete_link_rule_dict import DeleteLinkRuleDict -from foundry.v1.models._link_type_api_name import LinkTypeApiName -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class DeleteLinkRule(BaseModel): - """DeleteLinkRule""" - - link_type_api_name_ato_b: LinkTypeApiName = Field(alias="linkTypeApiNameAtoB") - - link_type_api_name_bto_a: LinkTypeApiName = Field(alias="linkTypeApiNameBtoA") - - a_side_object_type_api_name: ObjectTypeApiName = Field(alias="aSideObjectTypeApiName") - - b_side_object_type_api_name: ObjectTypeApiName = Field(alias="bSideObjectTypeApiName") - - type: Literal["deleteLink"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> DeleteLinkRuleDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DeleteLinkRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_delete_link_rule_dict.py b/foundry/v1/models/_delete_link_rule_dict.py deleted file mode 100644 index 9a0a35c5..00000000 --- a/foundry/v1/models/_delete_link_rule_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._link_type_api_name import LinkTypeApiName -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class DeleteLinkRuleDict(TypedDict): - """DeleteLinkRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - linkTypeApiNameAtoB: LinkTypeApiName - - linkTypeApiNameBtoA: LinkTypeApiName - - aSideObjectTypeApiName: ObjectTypeApiName - - bSideObjectTypeApiName: ObjectTypeApiName - - type: Literal["deleteLink"] diff --git a/foundry/v1/models/_delete_object_rule.py b/foundry/v1/models/_delete_object_rule.py deleted file mode 100644 index 1ee029a1..00000000 --- a/foundry/v1/models/_delete_object_rule.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._delete_object_rule_dict import DeleteObjectRuleDict -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class DeleteObjectRule(BaseModel): - """DeleteObjectRule""" - - object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") - - type: Literal["deleteObject"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> DeleteObjectRuleDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DeleteObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_delete_object_rule_dict.py b/foundry/v1/models/_delete_object_rule_dict.py deleted file mode 100644 index d7cf8f99..00000000 --- a/foundry/v1/models/_delete_object_rule_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class DeleteObjectRuleDict(TypedDict): - """DeleteObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectTypeApiName: ObjectTypeApiName - - type: Literal["deleteObject"] diff --git a/foundry/v1/models/_distance.py b/foundry/v1/models/_distance.py deleted file mode 100644 index 237f82c2..00000000 --- a/foundry/v1/models/_distance.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictFloat - -from foundry.v1.models._distance_dict import DistanceDict -from foundry.v1.models._distance_unit import DistanceUnit - - -class Distance(BaseModel): - """A measurement of distance.""" - - value: StrictFloat - - unit: DistanceUnit - - model_config = {"extra": "allow"} - - def to_dict(self) -> DistanceDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DistanceDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_distance_dict.py b/foundry/v1/models/_distance_dict.py deleted file mode 100644 index 2ceacbb2..00000000 --- a/foundry/v1/models/_distance_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictFloat -from typing_extensions import TypedDict - -from foundry.v1.models._distance_unit import DistanceUnit - - -class DistanceDict(TypedDict): - """A measurement of distance.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: StrictFloat - - unit: DistanceUnit diff --git a/foundry/v1/models/_does_not_intersect_bounding_box_query.py b/foundry/v1/models/_does_not_intersect_bounding_box_query.py deleted file mode 100644 index 1d37bf67..00000000 --- a/foundry/v1/models/_does_not_intersect_bounding_box_query.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._bounding_box_value import BoundingBoxValue -from foundry.v1.models._does_not_intersect_bounding_box_query_dict import ( - DoesNotIntersectBoundingBoxQueryDict, -) # NOQA -from foundry.v1.models._property_api_name import PropertyApiName - - -class DoesNotIntersectBoundingBoxQuery(BaseModel): - """Returns objects where the specified field does not intersect the bounding box provided.""" - - field: PropertyApiName - - value: BoundingBoxValue - - type: Literal["doesNotIntersectBoundingBox"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> DoesNotIntersectBoundingBoxQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - DoesNotIntersectBoundingBoxQueryDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_does_not_intersect_bounding_box_query_dict.py b/foundry/v1/models/_does_not_intersect_bounding_box_query_dict.py deleted file mode 100644 index 3dc1c00e..00000000 --- a/foundry/v1/models/_does_not_intersect_bounding_box_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._bounding_box_value_dict import BoundingBoxValueDict -from foundry.v1.models._property_api_name import PropertyApiName - - -class DoesNotIntersectBoundingBoxQueryDict(TypedDict): - """Returns objects where the specified field does not intersect the bounding box provided.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: BoundingBoxValueDict - - type: Literal["doesNotIntersectBoundingBox"] diff --git a/foundry/v1/models/_does_not_intersect_polygon_query.py b/foundry/v1/models/_does_not_intersect_polygon_query.py deleted file mode 100644 index c729252a..00000000 --- a/foundry/v1/models/_does_not_intersect_polygon_query.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._does_not_intersect_polygon_query_dict import ( - DoesNotIntersectPolygonQueryDict, -) # NOQA -from foundry.v1.models._polygon_value import PolygonValue -from foundry.v1.models._property_api_name import PropertyApiName - - -class DoesNotIntersectPolygonQuery(BaseModel): - """Returns objects where the specified field does not intersect the polygon provided.""" - - field: PropertyApiName - - value: PolygonValue - - type: Literal["doesNotIntersectPolygon"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> DoesNotIntersectPolygonQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - DoesNotIntersectPolygonQueryDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_does_not_intersect_polygon_query_dict.py b/foundry/v1/models/_does_not_intersect_polygon_query_dict.py deleted file mode 100644 index 3a237a48..00000000 --- a/foundry/v1/models/_does_not_intersect_polygon_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._polygon_value_dict import PolygonValueDict -from foundry.v1.models._property_api_name import PropertyApiName - - -class DoesNotIntersectPolygonQueryDict(TypedDict): - """Returns objects where the specified field does not intersect the polygon provided.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PolygonValueDict - - type: Literal["doesNotIntersectPolygon"] diff --git a/foundry/v1/models/_double_type.py b/foundry/v1/models/_double_type.py deleted file mode 100644 index c9fc6bbc..00000000 --- a/foundry/v1/models/_double_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._double_type_dict import DoubleTypeDict - - -class DoubleType(BaseModel): - """DoubleType""" - - type: Literal["double"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> DoubleTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DoubleTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_equals_query.py b/foundry/v1/models/_equals_query.py deleted file mode 100644 index 9afe2058..00000000 --- a/foundry/v1/models/_equals_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._equals_query_dict import EqualsQueryDict -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._property_value import PropertyValue - - -class EqualsQuery(BaseModel): - """Returns objects where the specified field is equal to a value.""" - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["eq"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> EqualsQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(EqualsQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_equals_query_dict.py b/foundry/v1/models/_equals_query_dict.py deleted file mode 100644 index f47b339f..00000000 --- a/foundry/v1/models/_equals_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._property_value import PropertyValue - - -class EqualsQueryDict(TypedDict): - """Returns objects where the specified field is equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["eq"] diff --git a/foundry/v1/models/_equals_query_v2.py b/foundry/v1/models/_equals_query_v2.py deleted file mode 100644 index c7613e01..00000000 --- a/foundry/v1/models/_equals_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._equals_query_v2_dict import EqualsQueryV2Dict -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - - -class EqualsQueryV2(BaseModel): - """Returns objects where the specified field is equal to a value.""" - - field: PropertyApiName - - value: PropertyValue - - type: Literal["eq"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> EqualsQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(EqualsQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_equals_query_v2_dict.py b/foundry/v1/models/_equals_query_v2_dict.py deleted file mode 100644 index 966ac2ea..00000000 --- a/foundry/v1/models/_equals_query_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - - -class EqualsQueryV2Dict(TypedDict): - """Returns objects where the specified field is equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PropertyValue - - type: Literal["eq"] diff --git a/foundry/v1/models/_error.py b/foundry/v1/models/_error.py deleted file mode 100644 index f01ff4be..00000000 --- a/foundry/v1/models/_error.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._arg import Arg -from foundry.v1.models._error_dict import ErrorDict -from foundry.v1.models._error_name import ErrorName - - -class Error(BaseModel): - """Error""" - - error: ErrorName - - args: List[Arg] - - type: Literal["error"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ErrorDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ErrorDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_error_dict.py b/foundry/v1/models/_error_dict.py deleted file mode 100644 index 13290e51..00000000 --- a/foundry/v1/models/_error_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._arg_dict import ArgDict -from foundry.v1.models._error_name import ErrorName - - -class ErrorDict(TypedDict): - """Error""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - error: ErrorName - - args: List[ArgDict] - - type: Literal["error"] diff --git a/foundry/v1/models/_error_name.py b/foundry/v1/models/_error_name.py deleted file mode 100644 index 4bb8b749..00000000 --- a/foundry/v1/models/_error_name.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -ErrorName = StrictStr -"""ErrorName""" diff --git a/foundry/v1/models/_exact_distinct_aggregation_v2.py b/foundry/v1/models/_exact_distinct_aggregation_v2.py deleted file mode 100644 index 85ec5a79..00000000 --- a/foundry/v1/models/_exact_distinct_aggregation_v2.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._exact_distinct_aggregation_v2_dict import ( - ExactDistinctAggregationV2Dict, -) # NOQA -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._property_api_name import PropertyApiName - - -class ExactDistinctAggregationV2(BaseModel): - """Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.""" - - field: PropertyApiName - - name: Optional[AggregationMetricName] = None - - direction: Optional[OrderByDirection] = None - - type: Literal["exactDistinct"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ExactDistinctAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ExactDistinctAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_exact_distinct_aggregation_v2_dict.py b/foundry/v1/models/_exact_distinct_aggregation_v2_dict.py deleted file mode 100644 index 72be3536..00000000 --- a/foundry/v1/models/_exact_distinct_aggregation_v2_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._property_api_name import PropertyApiName - - -class ExactDistinctAggregationV2Dict(TypedDict): - """Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - name: NotRequired[AggregationMetricName] - - direction: NotRequired[OrderByDirection] - - type: Literal["exactDistinct"] diff --git a/foundry/v1/models/_execute_query_request.py b/foundry/v1/models/_execute_query_request.py deleted file mode 100644 index 5f6bc036..00000000 --- a/foundry/v1/models/_execute_query_request.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._execute_query_request_dict import ExecuteQueryRequestDict -from foundry.v1.models._parameter_id import ParameterId - - -class ExecuteQueryRequest(BaseModel): - """ExecuteQueryRequest""" - - parameters: Dict[ParameterId, Optional[DataValue]] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ExecuteQueryRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ExecuteQueryRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_execute_query_request_dict.py b/foundry/v1/models/_execute_query_request_dict.py deleted file mode 100644 index a5f44713..00000000 --- a/foundry/v1/models/_execute_query_request_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import TypedDict - -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._parameter_id import ParameterId - - -class ExecuteQueryRequestDict(TypedDict): - """ExecuteQueryRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v1/models/_execute_query_response.py b/foundry/v1/models/_execute_query_response.py deleted file mode 100644 index 5fb928a0..00000000 --- a/foundry/v1/models/_execute_query_response.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._execute_query_response_dict import ExecuteQueryResponseDict - - -class ExecuteQueryResponse(BaseModel): - """ExecuteQueryResponse""" - - value: DataValue - - model_config = {"extra": "allow"} - - def to_dict(self) -> ExecuteQueryResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ExecuteQueryResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_execute_query_response_dict.py b/foundry/v1/models/_execute_query_response_dict.py deleted file mode 100644 index b7a3247e..00000000 --- a/foundry/v1/models/_execute_query_response_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v1.models._data_value import DataValue - - -class ExecuteQueryResponseDict(TypedDict): - """ExecuteQueryResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: DataValue diff --git a/foundry/v1/models/_feature.py b/foundry/v1/models/_feature.py deleted file mode 100644 index f36c1196..00000000 --- a/foundry/v1/models/_feature.py +++ /dev/null @@ -1,60 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Dict -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._feature_dict import FeatureDict -from foundry.v1.models._feature_property_key import FeaturePropertyKey -from foundry.v1.models._geometry import Geometry - - -class Feature(BaseModel): - """GeoJSon 'Feature' object""" - - geometry: Optional[Geometry] = None - - properties: Dict[FeaturePropertyKey, Any] - """ - A `Feature` object has a member with the name "properties". The - value of the properties member is an object (any JSON object or a - JSON null value). - """ - - id: Optional[Any] = None - """ - If a `Feature` has a commonly used identifier, that identifier - SHOULD be included as a member of the Feature object with the name - "id", and the value of this member is either a JSON string or - number. - """ - - bbox: Optional[BBox] = None - - type: Literal["Feature"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> FeatureDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(FeatureDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_feature_collection.py b/foundry/v1/models/_feature_collection.py deleted file mode 100644 index 4c2ef9ff..00000000 --- a/foundry/v1/models/_feature_collection.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._feature_collection_dict import FeatureCollectionDict -from foundry.v1.models._feature_collection_types import FeatureCollectionTypes - - -class FeatureCollection(BaseModel): - """GeoJSon 'FeatureCollection' object""" - - features: List[FeatureCollectionTypes] - - bbox: Optional[BBox] = None - - type: Literal["FeatureCollection"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> FeatureCollectionDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(FeatureCollectionDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_feature_collection_dict.py b/foundry/v1/models/_feature_collection_dict.py deleted file mode 100644 index ac5112d1..00000000 --- a/foundry/v1/models/_feature_collection_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._feature_collection_types_dict import FeatureCollectionTypesDict - - -class FeatureCollectionDict(TypedDict): - """GeoJSon 'FeatureCollection' object""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - features: List[FeatureCollectionTypesDict] - - bbox: NotRequired[BBox] - - type: Literal["FeatureCollection"] diff --git a/foundry/v1/models/_feature_collection_types.py b/foundry/v1/models/_feature_collection_types.py deleted file mode 100644 index 32825aa4..00000000 --- a/foundry/v1/models/_feature_collection_types.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v1.models._feature import Feature - -FeatureCollectionTypes = Feature -"""FeatureCollectionTypes""" diff --git a/foundry/v1/models/_feature_collection_types_dict.py b/foundry/v1/models/_feature_collection_types_dict.py deleted file mode 100644 index 0a50240a..00000000 --- a/foundry/v1/models/_feature_collection_types_dict.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v1.models._feature_dict import FeatureDict - -FeatureCollectionTypesDict = FeatureDict -"""FeatureCollectionTypes""" diff --git a/foundry/v1/models/_feature_dict.py b/foundry/v1/models/_feature_dict.py deleted file mode 100644 index 64880bdb..00000000 --- a/foundry/v1/models/_feature_dict.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Dict -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._feature_property_key import FeaturePropertyKey -from foundry.v1.models._geometry_dict import GeometryDict - - -class FeatureDict(TypedDict): - """GeoJSon 'Feature' object""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - geometry: NotRequired[GeometryDict] - - properties: Dict[FeaturePropertyKey, Any] - """ - A `Feature` object has a member with the name "properties". The - value of the properties member is an object (any JSON object or a - JSON null value). - """ - - id: NotRequired[Any] - """ - If a `Feature` has a commonly used identifier, that identifier - SHOULD be included as a member of the Feature object with the name - "id", and the value of this member is either a JSON string or - number. - """ - - bbox: NotRequired[BBox] - - type: Literal["Feature"] diff --git a/foundry/v1/models/_feature_property_key.py b/foundry/v1/models/_feature_property_key.py deleted file mode 100644 index f80d3df3..00000000 --- a/foundry/v1/models/_feature_property_key.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -FeaturePropertyKey = StrictStr -"""FeaturePropertyKey""" diff --git a/foundry/v1/models/_file.py b/foundry/v1/models/_file.py deleted file mode 100644 index d042acba..00000000 --- a/foundry/v1/models/_file.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._file_dict import FileDict -from foundry.v1.models._file_path import FilePath -from foundry.v1.models._transaction_rid import TransactionRid - - -class File(BaseModel): - """File""" - - path: FilePath - - transaction_rid: TransactionRid = Field(alias="transactionRid") - - size_bytes: Optional[StrictStr] = Field(alias="sizeBytes", default=None) - - updated_time: datetime = Field(alias="updatedTime") - - model_config = {"extra": "allow"} - - def to_dict(self) -> FileDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(FileDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_file_dict.py b/foundry/v1/models/_file_dict.py deleted file mode 100644 index 7e93f846..00000000 --- a/foundry/v1/models/_file_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._file_path import FilePath -from foundry.v1.models._transaction_rid import TransactionRid - - -class FileDict(TypedDict): - """File""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - path: FilePath - - transactionRid: TransactionRid - - sizeBytes: NotRequired[StrictStr] - - updatedTime: datetime diff --git a/foundry/v1/models/_filesystem_resource.py b/foundry/v1/models/_filesystem_resource.py deleted file mode 100644 index 9c5871bf..00000000 --- a/foundry/v1/models/_filesystem_resource.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._filesystem_resource_dict import FilesystemResourceDict - - -class FilesystemResource(BaseModel): - """FilesystemResource""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> FilesystemResourceDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(FilesystemResourceDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_filesystem_resource_dict.py b/foundry/v1/models/_filesystem_resource_dict.py deleted file mode 100644 index 44208d20..00000000 --- a/foundry/v1/models/_filesystem_resource_dict.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - - -class FilesystemResourceDict(TypedDict): - """FilesystemResource""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v1/models/_filter_value.py b/foundry/v1/models/_filter_value.py deleted file mode 100644 index 69c6cae4..00000000 --- a/foundry/v1/models/_filter_value.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -FilterValue = StrictStr -""" -Represents the value of a property filter. For instance, false is the FilterValue in -`properties.{propertyApiName}.isNull=false`. -""" diff --git a/foundry/v1/models/_float_type.py b/foundry/v1/models/_float_type.py deleted file mode 100644 index 9cfc55d4..00000000 --- a/foundry/v1/models/_float_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._float_type_dict import FloatTypeDict - - -class FloatType(BaseModel): - """FloatType""" - - type: Literal["float"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> FloatTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(FloatTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_geo_json_object.py b/foundry/v1/models/_geo_json_object.py deleted file mode 100644 index bc1c30e6..00000000 --- a/foundry/v1/models/_geo_json_object.py +++ /dev/null @@ -1,60 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._feature import Feature -from foundry.v1.models._feature_collection import FeatureCollection -from foundry.v1.models._geo_point import GeoPoint -from foundry.v1.models._geometry import GeometryCollection -from foundry.v1.models._line_string import LineString -from foundry.v1.models._multi_line_string import MultiLineString -from foundry.v1.models._multi_point import MultiPoint -from foundry.v1.models._multi_polygon import MultiPolygon -from foundry.v1.models._polygon import Polygon - -GeoJsonObject = Annotated[ - Union[ - Feature, - FeatureCollection, - GeoPoint, - MultiPoint, - LineString, - MultiLineString, - Polygon, - MultiPolygon, - GeometryCollection, - ], - Field(discriminator="type"), -] -""" -GeoJSon object - -The coordinate reference system for all GeoJSON coordinates is a -geographic coordinate reference system, using the World Geodetic System -1984 (WGS 84) datum, with longitude and latitude units of decimal -degrees. -This is equivalent to the coordinate reference system identified by the -Open Geospatial Consortium (OGC) URN -An OPTIONAL third-position element SHALL be the height in meters above -or below the WGS 84 reference ellipsoid. -In the absence of elevation values, applications sensitive to height or -depth SHOULD interpret positions as being at local ground or sea level. -""" diff --git a/foundry/v1/models/_geo_json_object_dict.py b/foundry/v1/models/_geo_json_object_dict.py deleted file mode 100644 index b08b9a64..00000000 --- a/foundry/v1/models/_geo_json_object_dict.py +++ /dev/null @@ -1,60 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._feature_collection_dict import FeatureCollectionDict -from foundry.v1.models._feature_dict import FeatureDict -from foundry.v1.models._geo_point_dict import GeoPointDict -from foundry.v1.models._geometry_dict import GeometryCollectionDict -from foundry.v1.models._line_string_dict import LineStringDict -from foundry.v1.models._multi_line_string_dict import MultiLineStringDict -from foundry.v1.models._multi_point_dict import MultiPointDict -from foundry.v1.models._multi_polygon_dict import MultiPolygonDict -from foundry.v1.models._polygon_dict import PolygonDict - -GeoJsonObjectDict = Annotated[ - Union[ - FeatureDict, - FeatureCollectionDict, - GeoPointDict, - MultiPointDict, - LineStringDict, - MultiLineStringDict, - PolygonDict, - MultiPolygonDict, - GeometryCollectionDict, - ], - Field(discriminator="type"), -] -""" -GeoJSon object - -The coordinate reference system for all GeoJSON coordinates is a -geographic coordinate reference system, using the World Geodetic System -1984 (WGS 84) datum, with longitude and latitude units of decimal -degrees. -This is equivalent to the coordinate reference system identified by the -Open Geospatial Consortium (OGC) URN -An OPTIONAL third-position element SHALL be the height in meters above -or below the WGS 84 reference ellipsoid. -In the absence of elevation values, applications sensitive to height or -depth SHOULD interpret positions as being at local ground or sea level. -""" diff --git a/foundry/v1/models/_geo_point.py b/foundry/v1/models/_geo_point.py deleted file mode 100644 index b5bc3279..00000000 --- a/foundry/v1/models/_geo_point.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._geo_point_dict import GeoPointDict -from foundry.v1.models._position import Position - - -class GeoPoint(BaseModel): - """GeoPoint""" - - coordinates: Position - - bbox: Optional[BBox] = None - - type: Literal["Point"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GeoPointDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GeoPointDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_geo_point_dict.py b/foundry/v1/models/_geo_point_dict.py deleted file mode 100644 index 2992bdcd..00000000 --- a/foundry/v1/models/_geo_point_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._position import Position - - -class GeoPointDict(TypedDict): - """GeoPoint""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: Position - - bbox: NotRequired[BBox] - - type: Literal["Point"] diff --git a/foundry/v1/models/_geo_point_type.py b/foundry/v1/models/_geo_point_type.py deleted file mode 100644 index ad24205b..00000000 --- a/foundry/v1/models/_geo_point_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._geo_point_type_dict import GeoPointTypeDict - - -class GeoPointType(BaseModel): - """GeoPointType""" - - type: Literal["geopoint"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GeoPointTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GeoPointTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_geo_shape_type.py b/foundry/v1/models/_geo_shape_type.py deleted file mode 100644 index 5dd0d70c..00000000 --- a/foundry/v1/models/_geo_shape_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._geo_shape_type_dict import GeoShapeTypeDict - - -class GeoShapeType(BaseModel): - """GeoShapeType""" - - type: Literal["geoshape"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GeoShapeTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GeoShapeTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_geometry.py b/foundry/v1/models/_geometry.py deleted file mode 100644 index 8c6b0718..00000000 --- a/foundry/v1/models/_geometry.py +++ /dev/null @@ -1,67 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Optional -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._geo_point import GeoPoint -from foundry.v1.models._geometry_dict import GeometryCollectionDict -from foundry.v1.models._line_string import LineString -from foundry.v1.models._multi_line_string import MultiLineString -from foundry.v1.models._multi_point import MultiPoint -from foundry.v1.models._multi_polygon import MultiPolygon -from foundry.v1.models._polygon import Polygon - - -class GeometryCollection(BaseModel): - """ - GeoJSon geometry collection - - GeometryCollections composed of a single part or a number of parts of a - single type SHOULD be avoided when that single part or a single object - of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could - be used instead. - """ - - geometries: List[Geometry] - - bbox: Optional[BBox] = None - - type: Literal["GeometryCollection"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GeometryCollectionDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GeometryCollectionDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -Geometry = Annotated[ - Union[ - GeoPoint, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection - ], - Field(discriminator="type"), -] -"""Abstract type for all GeoJSon object except Feature and FeatureCollection""" diff --git a/foundry/v1/models/_geometry_dict.py b/foundry/v1/models/_geometry_dict.py deleted file mode 100644 index c0a4228f..00000000 --- a/foundry/v1/models/_geometry_dict.py +++ /dev/null @@ -1,67 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._geo_point_dict import GeoPointDict -from foundry.v1.models._line_string_dict import LineStringDict -from foundry.v1.models._multi_line_string_dict import MultiLineStringDict -from foundry.v1.models._multi_point_dict import MultiPointDict -from foundry.v1.models._multi_polygon_dict import MultiPolygonDict -from foundry.v1.models._polygon_dict import PolygonDict - - -class GeometryCollectionDict(TypedDict): - """ - GeoJSon geometry collection - - GeometryCollections composed of a single part or a number of parts of a - single type SHOULD be avoided when that single part or a single object - of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could - be used instead. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - geometries: List[GeometryDict] - - bbox: NotRequired[BBox] - - type: Literal["GeometryCollection"] - - -GeometryDict = Annotated[ - Union[ - GeoPointDict, - MultiPointDict, - LineStringDict, - MultiLineStringDict, - PolygonDict, - MultiPolygonDict, - GeometryCollectionDict, - ], - Field(discriminator="type"), -] -"""Abstract type for all GeoJSon object except Feature and FeatureCollection""" diff --git a/foundry/v1/models/_geotime_series_value.py b/foundry/v1/models/_geotime_series_value.py deleted file mode 100644 index 2ff1b5b4..00000000 --- a/foundry/v1/models/_geotime_series_value.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._geotime_series_value_dict import GeotimeSeriesValueDict -from foundry.v1.models._position import Position - - -class GeotimeSeriesValue(BaseModel): - """The underlying data values pointed to by a GeotimeSeriesReference.""" - - position: Position - - timestamp: datetime - - type: Literal["geotimeSeriesValue"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GeotimeSeriesValueDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GeotimeSeriesValueDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_geotime_series_value_dict.py b/foundry/v1/models/_geotime_series_value_dict.py deleted file mode 100644 index 6de58618..00000000 --- a/foundry/v1/models/_geotime_series_value_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._position import Position - - -class GeotimeSeriesValueDict(TypedDict): - """The underlying data values pointed to by a GeotimeSeriesReference.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - position: Position - - timestamp: datetime - - type: Literal["geotimeSeriesValue"] diff --git a/foundry/v1/models/_group_member_constraint.py b/foundry/v1/models/_group_member_constraint.py deleted file mode 100644 index 5a629020..00000000 --- a/foundry/v1/models/_group_member_constraint.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._group_member_constraint_dict import GroupMemberConstraintDict - - -class GroupMemberConstraint(BaseModel): - """The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.""" - - type: Literal["groupMember"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GroupMemberConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GroupMemberConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_gt_query.py b/foundry/v1/models/_gt_query.py deleted file mode 100644 index 27eef0c2..00000000 --- a/foundry/v1/models/_gt_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._gt_query_dict import GtQueryDict -from foundry.v1.models._property_value import PropertyValue - - -class GtQuery(BaseModel): - """Returns objects where the specified field is greater than a value.""" - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["gt"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GtQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GtQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_gt_query_dict.py b/foundry/v1/models/_gt_query_dict.py deleted file mode 100644 index d47bb793..00000000 --- a/foundry/v1/models/_gt_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._property_value import PropertyValue - - -class GtQueryDict(TypedDict): - """Returns objects where the specified field is greater than a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["gt"] diff --git a/foundry/v1/models/_gt_query_v2.py b/foundry/v1/models/_gt_query_v2.py deleted file mode 100644 index 48ee1ac4..00000000 --- a/foundry/v1/models/_gt_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._gt_query_v2_dict import GtQueryV2Dict -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - - -class GtQueryV2(BaseModel): - """Returns objects where the specified field is greater than a value.""" - - field: PropertyApiName - - value: PropertyValue - - type: Literal["gt"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GtQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GtQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_gt_query_v2_dict.py b/foundry/v1/models/_gt_query_v2_dict.py deleted file mode 100644 index 59dae354..00000000 --- a/foundry/v1/models/_gt_query_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - - -class GtQueryV2Dict(TypedDict): - """Returns objects where the specified field is greater than a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PropertyValue - - type: Literal["gt"] diff --git a/foundry/v1/models/_gte_query.py b/foundry/v1/models/_gte_query.py deleted file mode 100644 index 1a9bffa2..00000000 --- a/foundry/v1/models/_gte_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._gte_query_dict import GteQueryDict -from foundry.v1.models._property_value import PropertyValue - - -class GteQuery(BaseModel): - """Returns objects where the specified field is greater than or equal to a value.""" - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["gte"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GteQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GteQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_gte_query_dict.py b/foundry/v1/models/_gte_query_dict.py deleted file mode 100644 index 1dc48cdc..00000000 --- a/foundry/v1/models/_gte_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._property_value import PropertyValue - - -class GteQueryDict(TypedDict): - """Returns objects where the specified field is greater than or equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["gte"] diff --git a/foundry/v1/models/_gte_query_v2.py b/foundry/v1/models/_gte_query_v2.py deleted file mode 100644 index 0b45ad6f..00000000 --- a/foundry/v1/models/_gte_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._gte_query_v2_dict import GteQueryV2Dict -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - - -class GteQueryV2(BaseModel): - """Returns objects where the specified field is greater than or equal to a value.""" - - field: PropertyApiName - - value: PropertyValue - - type: Literal["gte"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GteQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GteQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_gte_query_v2_dict.py b/foundry/v1/models/_gte_query_v2_dict.py deleted file mode 100644 index a4085a49..00000000 --- a/foundry/v1/models/_gte_query_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - - -class GteQueryV2Dict(TypedDict): - """Returns objects where the specified field is greater than or equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PropertyValue - - type: Literal["gte"] diff --git a/foundry/v1/models/_icon.py b/foundry/v1/models/_icon.py deleted file mode 100644 index 4f2c4e6f..00000000 --- a/foundry/v1/models/_icon.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v1.models._blueprint_icon import BlueprintIcon - -Icon = BlueprintIcon -"""A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).""" diff --git a/foundry/v1/models/_icon_dict.py b/foundry/v1/models/_icon_dict.py deleted file mode 100644 index 111128b0..00000000 --- a/foundry/v1/models/_icon_dict.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v1.models._blueprint_icon_dict import BlueprintIconDict - -IconDict = BlueprintIconDict -"""A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).""" diff --git a/foundry/v1/models/_integer_type.py b/foundry/v1/models/_integer_type.py deleted file mode 100644 index a2cf7ff6..00000000 --- a/foundry/v1/models/_integer_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._integer_type_dict import IntegerTypeDict - - -class IntegerType(BaseModel): - """IntegerType""" - - type: Literal["integer"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> IntegerTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(IntegerTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_interface_link_type.py b/foundry/v1/models/_interface_link_type.py deleted file mode 100644 index 2ee92215..00000000 --- a/foundry/v1/models/_interface_link_type.py +++ /dev/null @@ -1,64 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool -from pydantic import StrictStr - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._interface_link_type_api_name import InterfaceLinkTypeApiName -from foundry.v1.models._interface_link_type_cardinality import InterfaceLinkTypeCardinality # NOQA -from foundry.v1.models._interface_link_type_dict import InterfaceLinkTypeDict -from foundry.v1.models._interface_link_type_linked_entity_api_name import ( - InterfaceLinkTypeLinkedEntityApiName, -) # NOQA -from foundry.v1.models._interface_link_type_rid import InterfaceLinkTypeRid - - -class InterfaceLinkType(BaseModel): - """ - A link type constraint defined at the interface level where the implementation of the links is provided - by the implementing object types. - """ - - rid: InterfaceLinkTypeRid - - api_name: InterfaceLinkTypeApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - description: Optional[StrictStr] = None - """The description of the interface link type.""" - - linked_entity_api_name: InterfaceLinkTypeLinkedEntityApiName = Field( - alias="linkedEntityApiName" - ) - - cardinality: InterfaceLinkTypeCardinality - - required: StrictBool - """Whether each implementing object type must declare at least one implementation of this link.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> InterfaceLinkTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(InterfaceLinkTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_interface_link_type_dict.py b/foundry/v1/models/_interface_link_type_dict.py deleted file mode 100644 index f4b51e04..00000000 --- a/foundry/v1/models/_interface_link_type_dict.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictBool -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._interface_link_type_api_name import InterfaceLinkTypeApiName -from foundry.v1.models._interface_link_type_cardinality import InterfaceLinkTypeCardinality # NOQA -from foundry.v1.models._interface_link_type_linked_entity_api_name_dict import ( - InterfaceLinkTypeLinkedEntityApiNameDict, -) # NOQA -from foundry.v1.models._interface_link_type_rid import InterfaceLinkTypeRid - - -class InterfaceLinkTypeDict(TypedDict): - """ - A link type constraint defined at the interface level where the implementation of the links is provided - by the implementing object types. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: InterfaceLinkTypeRid - - apiName: InterfaceLinkTypeApiName - - displayName: DisplayName - - description: NotRequired[StrictStr] - """The description of the interface link type.""" - - linkedEntityApiName: InterfaceLinkTypeLinkedEntityApiNameDict - - cardinality: InterfaceLinkTypeCardinality - - required: StrictBool - """Whether each implementing object type must declare at least one implementation of this link.""" diff --git a/foundry/v1/models/_interface_link_type_linked_entity_api_name.py b/foundry/v1/models/_interface_link_type_linked_entity_api_name.py deleted file mode 100644 index c2ff7b6b..00000000 --- a/foundry/v1/models/_interface_link_type_linked_entity_api_name.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._linked_interface_type_api_name import LinkedInterfaceTypeApiName -from foundry.v1.models._linked_object_type_api_name import LinkedObjectTypeApiName - -InterfaceLinkTypeLinkedEntityApiName = Annotated[ - Union[LinkedInterfaceTypeApiName, LinkedObjectTypeApiName], Field(discriminator="type") -] -"""A reference to the linked entity. This can either be an object or an interface type.""" diff --git a/foundry/v1/models/_interface_link_type_linked_entity_api_name_dict.py b/foundry/v1/models/_interface_link_type_linked_entity_api_name_dict.py deleted file mode 100644 index 38cf2bfa..00000000 --- a/foundry/v1/models/_interface_link_type_linked_entity_api_name_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._linked_interface_type_api_name_dict import ( - LinkedInterfaceTypeApiNameDict, -) # NOQA -from foundry.v1.models._linked_object_type_api_name_dict import LinkedObjectTypeApiNameDict # NOQA - -InterfaceLinkTypeLinkedEntityApiNameDict = Annotated[ - Union[LinkedInterfaceTypeApiNameDict, LinkedObjectTypeApiNameDict], Field(discriminator="type") -] -"""A reference to the linked entity. This can either be an object or an interface type.""" diff --git a/foundry/v1/models/_interface_type.py b/foundry/v1/models/_interface_type.py deleted file mode 100644 index 1bad19be..00000000 --- a/foundry/v1/models/_interface_type.py +++ /dev/null @@ -1,71 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._interface_link_type import InterfaceLinkType -from foundry.v1.models._interface_link_type_api_name import InterfaceLinkTypeApiName -from foundry.v1.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v1.models._interface_type_dict import InterfaceTypeDict -from foundry.v1.models._interface_type_rid import InterfaceTypeRid -from foundry.v1.models._shared_property_type import SharedPropertyType -from foundry.v1.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class InterfaceType(BaseModel): - """Represents an interface type in the Ontology.""" - - rid: InterfaceTypeRid - - api_name: InterfaceTypeApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - description: Optional[StrictStr] = None - """The description of the interface.""" - - properties: Dict[SharedPropertyTypeApiName, SharedPropertyType] - """ - A map from a shared property type API name to the corresponding shared property type. The map describes the - set of properties the interface has. A shared property type must be unique across all of the properties. - """ - - extends_interfaces: List[InterfaceTypeApiName] = Field(alias="extendsInterfaces") - """ - A list of interface API names that this interface extends. An interface can extend other interfaces to - inherit their properties. - """ - - links: Dict[InterfaceLinkTypeApiName, InterfaceLinkType] - """ - A map from an interface link type API name to the corresponding interface link type. The map describes the - set of link types the interface has. - """ - - model_config = {"extra": "allow"} - - def to_dict(self) -> InterfaceTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(InterfaceTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_interface_type_dict.py b/foundry/v1/models/_interface_type_dict.py deleted file mode 100644 index e6cd1945..00000000 --- a/foundry/v1/models/_interface_type_dict.py +++ /dev/null @@ -1,64 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._interface_link_type_api_name import InterfaceLinkTypeApiName -from foundry.v1.models._interface_link_type_dict import InterfaceLinkTypeDict -from foundry.v1.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v1.models._interface_type_rid import InterfaceTypeRid -from foundry.v1.models._shared_property_type_api_name import SharedPropertyTypeApiName -from foundry.v1.models._shared_property_type_dict import SharedPropertyTypeDict - - -class InterfaceTypeDict(TypedDict): - """Represents an interface type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: InterfaceTypeRid - - apiName: InterfaceTypeApiName - - displayName: DisplayName - - description: NotRequired[StrictStr] - """The description of the interface.""" - - properties: Dict[SharedPropertyTypeApiName, SharedPropertyTypeDict] - """ - A map from a shared property type API name to the corresponding shared property type. The map describes the - set of properties the interface has. A shared property type must be unique across all of the properties. - """ - - extendsInterfaces: List[InterfaceTypeApiName] - """ - A list of interface API names that this interface extends. An interface can extend other interfaces to - inherit their properties. - """ - - links: Dict[InterfaceLinkTypeApiName, InterfaceLinkTypeDict] - """ - A map from an interface link type API name to the corresponding interface link type. The map describes the - set of link types the interface has. - """ diff --git a/foundry/v1/models/_intersects_bounding_box_query.py b/foundry/v1/models/_intersects_bounding_box_query.py deleted file mode 100644 index c4b4d4f5..00000000 --- a/foundry/v1/models/_intersects_bounding_box_query.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._bounding_box_value import BoundingBoxValue -from foundry.v1.models._intersects_bounding_box_query_dict import ( - IntersectsBoundingBoxQueryDict, -) # NOQA -from foundry.v1.models._property_api_name import PropertyApiName - - -class IntersectsBoundingBoxQuery(BaseModel): - """Returns objects where the specified field intersects the bounding box provided.""" - - field: PropertyApiName - - value: BoundingBoxValue - - type: Literal["intersectsBoundingBox"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> IntersectsBoundingBoxQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - IntersectsBoundingBoxQueryDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_intersects_bounding_box_query_dict.py b/foundry/v1/models/_intersects_bounding_box_query_dict.py deleted file mode 100644 index 8a737c4d..00000000 --- a/foundry/v1/models/_intersects_bounding_box_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._bounding_box_value_dict import BoundingBoxValueDict -from foundry.v1.models._property_api_name import PropertyApiName - - -class IntersectsBoundingBoxQueryDict(TypedDict): - """Returns objects where the specified field intersects the bounding box provided.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: BoundingBoxValueDict - - type: Literal["intersectsBoundingBox"] diff --git a/foundry/v1/models/_intersects_polygon_query.py b/foundry/v1/models/_intersects_polygon_query.py deleted file mode 100644 index 8e5c2a0b..00000000 --- a/foundry/v1/models/_intersects_polygon_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._intersects_polygon_query_dict import IntersectsPolygonQueryDict -from foundry.v1.models._polygon_value import PolygonValue -from foundry.v1.models._property_api_name import PropertyApiName - - -class IntersectsPolygonQuery(BaseModel): - """Returns objects where the specified field intersects the polygon provided.""" - - field: PropertyApiName - - value: PolygonValue - - type: Literal["intersectsPolygon"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> IntersectsPolygonQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(IntersectsPolygonQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_intersects_polygon_query_dict.py b/foundry/v1/models/_intersects_polygon_query_dict.py deleted file mode 100644 index 3ab0b188..00000000 --- a/foundry/v1/models/_intersects_polygon_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._polygon_value_dict import PolygonValueDict -from foundry.v1.models._property_api_name import PropertyApiName - - -class IntersectsPolygonQueryDict(TypedDict): - """Returns objects where the specified field intersects the polygon provided.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PolygonValueDict - - type: Literal["intersectsPolygon"] diff --git a/foundry/v1/models/_is_null_query.py b/foundry/v1/models/_is_null_query.py deleted file mode 100644 index a9733360..00000000 --- a/foundry/v1/models/_is_null_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictBool - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._is_null_query_dict import IsNullQueryDict - - -class IsNullQuery(BaseModel): - """Returns objects based on the existence of the specified field.""" - - field: FieldNameV1 - - value: StrictBool - - type: Literal["isNull"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> IsNullQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(IsNullQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_is_null_query_dict.py b/foundry/v1/models/_is_null_query_dict.py deleted file mode 100644 index 913b0dc2..00000000 --- a/foundry/v1/models/_is_null_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictBool -from typing_extensions import TypedDict - -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class IsNullQueryDict(TypedDict): - """Returns objects based on the existence of the specified field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: StrictBool - - type: Literal["isNull"] diff --git a/foundry/v1/models/_is_null_query_v2.py b/foundry/v1/models/_is_null_query_v2.py deleted file mode 100644 index 5e08ff0a..00000000 --- a/foundry/v1/models/_is_null_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictBool - -from foundry.v1.models._is_null_query_v2_dict import IsNullQueryV2Dict -from foundry.v1.models._property_api_name import PropertyApiName - - -class IsNullQueryV2(BaseModel): - """Returns objects based on the existence of the specified field.""" - - field: PropertyApiName - - value: StrictBool - - type: Literal["isNull"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> IsNullQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(IsNullQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_is_null_query_v2_dict.py b/foundry/v1/models/_is_null_query_v2_dict.py deleted file mode 100644 index 52f2cedd..00000000 --- a/foundry/v1/models/_is_null_query_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictBool -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName - - -class IsNullQueryV2Dict(TypedDict): - """Returns objects based on the existence of the specified field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: StrictBool - - type: Literal["isNull"] diff --git a/foundry/v1/models/_line_string.py b/foundry/v1/models/_line_string.py deleted file mode 100644 index 8f7596db..00000000 --- a/foundry/v1/models/_line_string.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._line_string_coordinates import LineStringCoordinates -from foundry.v1.models._line_string_dict import LineStringDict - - -class LineString(BaseModel): - """LineString""" - - coordinates: Optional[LineStringCoordinates] = None - - bbox: Optional[BBox] = None - - type: Literal["LineString"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LineStringDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LineStringDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_line_string_coordinates.py b/foundry/v1/models/_line_string_coordinates.py deleted file mode 100644 index 894fa1d6..00000000 --- a/foundry/v1/models/_line_string_coordinates.py +++ /dev/null @@ -1,23 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from foundry.v1.models._position import Position - -LineStringCoordinates = List[Position] -"""GeoJSon fundamental geometry construct, array of two or more positions.""" diff --git a/foundry/v1/models/_line_string_dict.py b/foundry/v1/models/_line_string_dict.py deleted file mode 100644 index 9a41062a..00000000 --- a/foundry/v1/models/_line_string_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._line_string_coordinates import LineStringCoordinates - - -class LineStringDict(TypedDict): - """LineString""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: NotRequired[LineStringCoordinates] - - bbox: NotRequired[BBox] - - type: Literal["LineString"] diff --git a/foundry/v1/models/_linear_ring.py b/foundry/v1/models/_linear_ring.py deleted file mode 100644 index 4ba60b06..00000000 --- a/foundry/v1/models/_linear_ring.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from foundry.v1.models._position import Position - -LinearRing = List[Position] -""" -A linear ring is a closed LineString with four or more positions. - -The first and last positions are equivalent, and they MUST contain -identical values; their representation SHOULD also be identical. - -A linear ring is the boundary of a surface or the boundary of a hole in -a surface. - -A linear ring MUST follow the right-hand rule with respect to the area -it bounds, i.e., exterior rings are counterclockwise, and holes are -clockwise. -""" diff --git a/foundry/v1/models/_link_side_object.py b/foundry/v1/models/_link_side_object.py deleted file mode 100644 index 4cc3bfe0..00000000 --- a/foundry/v1/models/_link_side_object.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._link_side_object_dict import LinkSideObjectDict -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._property_value import PropertyValue - - -class LinkSideObject(BaseModel): - """LinkSideObject""" - - primary_key: PropertyValue = Field(alias="primaryKey") - - object_type: ObjectTypeApiName = Field(alias="objectType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> LinkSideObjectDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LinkSideObjectDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_link_side_object_dict.py b/foundry/v1/models/_link_side_object_dict.py deleted file mode 100644 index f0c447d6..00000000 --- a/foundry/v1/models/_link_side_object_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._property_value import PropertyValue - - -class LinkSideObjectDict(TypedDict): - """LinkSideObject""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - primaryKey: PropertyValue - - objectType: ObjectTypeApiName diff --git a/foundry/v1/models/_link_type_side.py b/foundry/v1/models/_link_type_side.py deleted file mode 100644 index 325cf051..00000000 --- a/foundry/v1/models/_link_type_side.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._link_type_api_name import LinkTypeApiName -from foundry.v1.models._link_type_side_cardinality import LinkTypeSideCardinality -from foundry.v1.models._link_type_side_dict import LinkTypeSideDict -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._release_status import ReleaseStatus - - -class LinkTypeSide(BaseModel): - """LinkTypeSide""" - - api_name: LinkTypeApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - status: ReleaseStatus - - object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") - - cardinality: LinkTypeSideCardinality - - foreign_key_property_api_name: Optional[PropertyApiName] = Field( - alias="foreignKeyPropertyApiName", default=None - ) - - model_config = {"extra": "allow"} - - def to_dict(self) -> LinkTypeSideDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LinkTypeSideDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_link_type_side_dict.py b/foundry/v1/models/_link_type_side_dict.py deleted file mode 100644 index 09dcce7f..00000000 --- a/foundry/v1/models/_link_type_side_dict.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._link_type_api_name import LinkTypeApiName -from foundry.v1.models._link_type_side_cardinality import LinkTypeSideCardinality -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._release_status import ReleaseStatus - - -class LinkTypeSideDict(TypedDict): - """LinkTypeSide""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: LinkTypeApiName - - displayName: DisplayName - - status: ReleaseStatus - - objectTypeApiName: ObjectTypeApiName - - cardinality: LinkTypeSideCardinality - - foreignKeyPropertyApiName: NotRequired[PropertyApiName] diff --git a/foundry/v1/models/_link_type_side_v2.py b/foundry/v1/models/_link_type_side_v2.py deleted file mode 100644 index b79f568d..00000000 --- a/foundry/v1/models/_link_type_side_v2.py +++ /dev/null @@ -1,57 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._link_type_api_name import LinkTypeApiName -from foundry.v1.models._link_type_rid import LinkTypeRid -from foundry.v1.models._link_type_side_cardinality import LinkTypeSideCardinality -from foundry.v1.models._link_type_side_v2_dict import LinkTypeSideV2Dict -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._release_status import ReleaseStatus - - -class LinkTypeSideV2(BaseModel): - """LinkTypeSideV2""" - - api_name: LinkTypeApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - status: ReleaseStatus - - object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") - - cardinality: LinkTypeSideCardinality - - foreign_key_property_api_name: Optional[PropertyApiName] = Field( - alias="foreignKeyPropertyApiName", default=None - ) - - link_type_rid: LinkTypeRid = Field(alias="linkTypeRid") - - model_config = {"extra": "allow"} - - def to_dict(self) -> LinkTypeSideV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LinkTypeSideV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_link_type_side_v2_dict.py b/foundry/v1/models/_link_type_side_v2_dict.py deleted file mode 100644 index d122f8fd..00000000 --- a/foundry/v1/models/_link_type_side_v2_dict.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._link_type_api_name import LinkTypeApiName -from foundry.v1.models._link_type_rid import LinkTypeRid -from foundry.v1.models._link_type_side_cardinality import LinkTypeSideCardinality -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._release_status import ReleaseStatus - - -class LinkTypeSideV2Dict(TypedDict): - """LinkTypeSideV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: LinkTypeApiName - - displayName: DisplayName - - status: ReleaseStatus - - objectTypeApiName: ObjectTypeApiName - - cardinality: LinkTypeSideCardinality - - foreignKeyPropertyApiName: NotRequired[PropertyApiName] - - linkTypeRid: LinkTypeRid diff --git a/foundry/v1/models/_linked_interface_type_api_name.py b/foundry/v1/models/_linked_interface_type_api_name.py deleted file mode 100644 index 59466698..00000000 --- a/foundry/v1/models/_linked_interface_type_api_name.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v1.models._linked_interface_type_api_name_dict import ( - LinkedInterfaceTypeApiNameDict, -) # NOQA - - -class LinkedInterfaceTypeApiName(BaseModel): - """A reference to the linked interface type.""" - - api_name: InterfaceTypeApiName = Field(alias="apiName") - - type: Literal["interfaceTypeApiName"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LinkedInterfaceTypeApiNameDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - LinkedInterfaceTypeApiNameDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_linked_interface_type_api_name_dict.py b/foundry/v1/models/_linked_interface_type_api_name_dict.py deleted file mode 100644 index 65de8e4e..00000000 --- a/foundry/v1/models/_linked_interface_type_api_name_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._interface_type_api_name import InterfaceTypeApiName - - -class LinkedInterfaceTypeApiNameDict(TypedDict): - """A reference to the linked interface type.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: InterfaceTypeApiName - - type: Literal["interfaceTypeApiName"] diff --git a/foundry/v1/models/_linked_object_type_api_name.py b/foundry/v1/models/_linked_object_type_api_name.py deleted file mode 100644 index af80a483..00000000 --- a/foundry/v1/models/_linked_object_type_api_name.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._linked_object_type_api_name_dict import LinkedObjectTypeApiNameDict # NOQA -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class LinkedObjectTypeApiName(BaseModel): - """A reference to the linked object type.""" - - api_name: ObjectTypeApiName = Field(alias="apiName") - - type: Literal["objectTypeApiName"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LinkedObjectTypeApiNameDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LinkedObjectTypeApiNameDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_linked_object_type_api_name_dict.py b/foundry/v1/models/_linked_object_type_api_name_dict.py deleted file mode 100644 index 796a9f18..00000000 --- a/foundry/v1/models/_linked_object_type_api_name_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class LinkedObjectTypeApiNameDict(TypedDict): - """A reference to the linked object type.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ObjectTypeApiName - - type: Literal["objectTypeApiName"] diff --git a/foundry/v1/models/_list_action_types_response.py b/foundry/v1/models/_list_action_types_response.py deleted file mode 100644 index 1c473659..00000000 --- a/foundry/v1/models/_list_action_types_response.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._action_type import ActionType -from foundry.v1.models._list_action_types_response_dict import ListActionTypesResponseDict # NOQA -from foundry.v1.models._page_token import PageToken - - -class ListActionTypesResponse(BaseModel): - """ListActionTypesResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[ActionType] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListActionTypesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListActionTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_list_action_types_response_dict.py b/foundry/v1/models/_list_action_types_response_dict.py deleted file mode 100644 index d6f79996..00000000 --- a/foundry/v1/models/_list_action_types_response_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._action_type_dict import ActionTypeDict -from foundry.v1.models._page_token import PageToken - - -class ListActionTypesResponseDict(TypedDict): - """ListActionTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[ActionTypeDict] diff --git a/foundry/v1/models/_list_action_types_response_v2.py b/foundry/v1/models/_list_action_types_response_v2.py deleted file mode 100644 index 26b6e519..00000000 --- a/foundry/v1/models/_list_action_types_response_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._action_type_v2 import ActionTypeV2 -from foundry.v1.models._list_action_types_response_v2_dict import ( - ListActionTypesResponseV2Dict, -) # NOQA -from foundry.v1.models._page_token import PageToken - - -class ListActionTypesResponseV2(BaseModel): - """ListActionTypesResponseV2""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[ActionTypeV2] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListActionTypesResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListActionTypesResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_list_action_types_response_v2_dict.py b/foundry/v1/models/_list_action_types_response_v2_dict.py deleted file mode 100644 index f6bd1367..00000000 --- a/foundry/v1/models/_list_action_types_response_v2_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._action_type_v2_dict import ActionTypeV2Dict -from foundry.v1.models._page_token import PageToken - - -class ListActionTypesResponseV2Dict(TypedDict): - """ListActionTypesResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[ActionTypeV2Dict] diff --git a/foundry/v1/models/_list_attachments_response_v2.py b/foundry/v1/models/_list_attachments_response_v2.py deleted file mode 100644 index cc844ed9..00000000 --- a/foundry/v1/models/_list_attachments_response_v2.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._attachment_v2 import AttachmentV2 -from foundry.v1.models._list_attachments_response_v2_dict import ( - ListAttachmentsResponseV2Dict, -) # NOQA -from foundry.v1.models._page_token import PageToken - - -class ListAttachmentsResponseV2(BaseModel): - """ListAttachmentsResponseV2""" - - data: List[AttachmentV2] - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - type: Literal["multiple"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListAttachmentsResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListAttachmentsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_list_attachments_response_v2_dict.py b/foundry/v1/models/_list_attachments_response_v2_dict.py deleted file mode 100644 index 3f5cbb58..00000000 --- a/foundry/v1/models/_list_attachments_response_v2_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._attachment_v2_dict import AttachmentV2Dict -from foundry.v1.models._page_token import PageToken - - -class ListAttachmentsResponseV2Dict(TypedDict): - """ListAttachmentsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[AttachmentV2Dict] - - nextPageToken: NotRequired[PageToken] - - type: Literal["multiple"] diff --git a/foundry/v1/models/_list_branches_response.py b/foundry/v1/models/_list_branches_response.py deleted file mode 100644 index 2e9b85c8..00000000 --- a/foundry/v1/models/_list_branches_response.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._branch import Branch -from foundry.v1.models._list_branches_response_dict import ListBranchesResponseDict -from foundry.v1.models._page_token import PageToken - - -class ListBranchesResponse(BaseModel): - """ListBranchesResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[Branch] - """The list of branches in the current page.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListBranchesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListBranchesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_list_branches_response_dict.py b/foundry/v1/models/_list_branches_response_dict.py deleted file mode 100644 index 79ea42a1..00000000 --- a/foundry/v1/models/_list_branches_response_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._branch_dict import BranchDict -from foundry.v1.models._page_token import PageToken - - -class ListBranchesResponseDict(TypedDict): - """ListBranchesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[BranchDict] - """The list of branches in the current page.""" diff --git a/foundry/v1/models/_list_files_response.py b/foundry/v1/models/_list_files_response.py deleted file mode 100644 index 803d1d4c..00000000 --- a/foundry/v1/models/_list_files_response.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._file import File -from foundry.v1.models._list_files_response_dict import ListFilesResponseDict -from foundry.v1.models._page_token import PageToken - - -class ListFilesResponse(BaseModel): - """A page of Files and an optional page token that can be used to retrieve the next page.""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[File] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListFilesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListFilesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_list_files_response_dict.py b/foundry/v1/models/_list_files_response_dict.py deleted file mode 100644 index ceaf4054..00000000 --- a/foundry/v1/models/_list_files_response_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._file_dict import FileDict -from foundry.v1.models._page_token import PageToken - - -class ListFilesResponseDict(TypedDict): - """A page of Files and an optional page token that can be used to retrieve the next page.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[FileDict] diff --git a/foundry/v1/models/_list_interface_types_response.py b/foundry/v1/models/_list_interface_types_response.py deleted file mode 100644 index 89a1ce72..00000000 --- a/foundry/v1/models/_list_interface_types_response.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._interface_type import InterfaceType -from foundry.v1.models._list_interface_types_response_dict import ( - ListInterfaceTypesResponseDict, -) # NOQA -from foundry.v1.models._page_token import PageToken - - -class ListInterfaceTypesResponse(BaseModel): - """ListInterfaceTypesResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[InterfaceType] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListInterfaceTypesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListInterfaceTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_list_interface_types_response_dict.py b/foundry/v1/models/_list_interface_types_response_dict.py deleted file mode 100644 index 6f5ee85f..00000000 --- a/foundry/v1/models/_list_interface_types_response_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._interface_type_dict import InterfaceTypeDict -from foundry.v1.models._page_token import PageToken - - -class ListInterfaceTypesResponseDict(TypedDict): - """ListInterfaceTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[InterfaceTypeDict] diff --git a/foundry/v1/models/_list_linked_objects_response.py b/foundry/v1/models/_list_linked_objects_response.py deleted file mode 100644 index 4437d8ee..00000000 --- a/foundry/v1/models/_list_linked_objects_response.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._list_linked_objects_response_dict import ( - ListLinkedObjectsResponseDict, -) # NOQA -from foundry.v1.models._ontology_object import OntologyObject -from foundry.v1.models._page_token import PageToken - - -class ListLinkedObjectsResponse(BaseModel): - """ListLinkedObjectsResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[OntologyObject] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListLinkedObjectsResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListLinkedObjectsResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_list_linked_objects_response_dict.py b/foundry/v1/models/_list_linked_objects_response_dict.py deleted file mode 100644 index 89c04aee..00000000 --- a/foundry/v1/models/_list_linked_objects_response_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._ontology_object_dict import OntologyObjectDict -from foundry.v1.models._page_token import PageToken - - -class ListLinkedObjectsResponseDict(TypedDict): - """ListLinkedObjectsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[OntologyObjectDict] diff --git a/foundry/v1/models/_list_linked_objects_response_v2.py b/foundry/v1/models/_list_linked_objects_response_v2.py deleted file mode 100644 index e13c7408..00000000 --- a/foundry/v1/models/_list_linked_objects_response_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._list_linked_objects_response_v2_dict import ( - ListLinkedObjectsResponseV2Dict, -) # NOQA -from foundry.v1.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v1.models._page_token import PageToken - - -class ListLinkedObjectsResponseV2(BaseModel): - """ListLinkedObjectsResponseV2""" - - data: List[OntologyObjectV2] - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListLinkedObjectsResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListLinkedObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_list_linked_objects_response_v2_dict.py b/foundry/v1/models/_list_linked_objects_response_v2_dict.py deleted file mode 100644 index 44401fae..00000000 --- a/foundry/v1/models/_list_linked_objects_response_v2_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v1.models._page_token import PageToken - - -class ListLinkedObjectsResponseV2Dict(TypedDict): - """ListLinkedObjectsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[OntologyObjectV2] - - nextPageToken: NotRequired[PageToken] diff --git a/foundry/v1/models/_list_object_types_response.py b/foundry/v1/models/_list_object_types_response.py deleted file mode 100644 index 4919c265..00000000 --- a/foundry/v1/models/_list_object_types_response.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._list_object_types_response_dict import ListObjectTypesResponseDict # NOQA -from foundry.v1.models._object_type import ObjectType -from foundry.v1.models._page_token import PageToken - - -class ListObjectTypesResponse(BaseModel): - """ListObjectTypesResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[ObjectType] - """The list of object types in the current page.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListObjectTypesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListObjectTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_list_object_types_response_dict.py b/foundry/v1/models/_list_object_types_response_dict.py deleted file mode 100644 index 0b0ea7ed..00000000 --- a/foundry/v1/models/_list_object_types_response_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._object_type_dict import ObjectTypeDict -from foundry.v1.models._page_token import PageToken - - -class ListObjectTypesResponseDict(TypedDict): - """ListObjectTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[ObjectTypeDict] - """The list of object types in the current page.""" diff --git a/foundry/v1/models/_list_object_types_v2_response.py b/foundry/v1/models/_list_object_types_v2_response.py deleted file mode 100644 index d6b7d7dd..00000000 --- a/foundry/v1/models/_list_object_types_v2_response.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._list_object_types_v2_response_dict import ( - ListObjectTypesV2ResponseDict, -) # NOQA -from foundry.v1.models._object_type_v2 import ObjectTypeV2 -from foundry.v1.models._page_token import PageToken - - -class ListObjectTypesV2Response(BaseModel): - """ListObjectTypesV2Response""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[ObjectTypeV2] - """The list of object types in the current page.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListObjectTypesV2ResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListObjectTypesV2ResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_list_object_types_v2_response_dict.py b/foundry/v1/models/_list_object_types_v2_response_dict.py deleted file mode 100644 index 8a9f8fe3..00000000 --- a/foundry/v1/models/_list_object_types_v2_response_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._object_type_v2_dict import ObjectTypeV2Dict -from foundry.v1.models._page_token import PageToken - - -class ListObjectTypesV2ResponseDict(TypedDict): - """ListObjectTypesV2Response""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[ObjectTypeV2Dict] - """The list of object types in the current page.""" diff --git a/foundry/v1/models/_list_objects_response.py b/foundry/v1/models/_list_objects_response.py deleted file mode 100644 index f3ebb908..00000000 --- a/foundry/v1/models/_list_objects_response.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._list_objects_response_dict import ListObjectsResponseDict -from foundry.v1.models._ontology_object import OntologyObject -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._total_count import TotalCount - - -class ListObjectsResponse(BaseModel): - """ListObjectsResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[OntologyObject] - """The list of objects in the current page.""" - - total_count: TotalCount = Field(alias="totalCount") - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListObjectsResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListObjectsResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_list_objects_response_dict.py b/foundry/v1/models/_list_objects_response_dict.py deleted file mode 100644 index 12f9b255..00000000 --- a/foundry/v1/models/_list_objects_response_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._ontology_object_dict import OntologyObjectDict -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._total_count import TotalCount - - -class ListObjectsResponseDict(TypedDict): - """ListObjectsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[OntologyObjectDict] - """The list of objects in the current page.""" - - totalCount: TotalCount diff --git a/foundry/v1/models/_list_objects_response_v2.py b/foundry/v1/models/_list_objects_response_v2.py deleted file mode 100644 index 536c696b..00000000 --- a/foundry/v1/models/_list_objects_response_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._list_objects_response_v2_dict import ListObjectsResponseV2Dict -from foundry.v1.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._total_count import TotalCount - - -class ListObjectsResponseV2(BaseModel): - """ListObjectsResponseV2""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[OntologyObjectV2] - """The list of objects in the current page.""" - - total_count: TotalCount = Field(alias="totalCount") - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListObjectsResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_list_objects_response_v2_dict.py b/foundry/v1/models/_list_objects_response_v2_dict.py deleted file mode 100644 index 5361e937..00000000 --- a/foundry/v1/models/_list_objects_response_v2_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._total_count import TotalCount - - -class ListObjectsResponseV2Dict(TypedDict): - """ListObjectsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[OntologyObjectV2] - """The list of objects in the current page.""" - - totalCount: TotalCount diff --git a/foundry/v1/models/_list_ontologies_response.py b/foundry/v1/models/_list_ontologies_response.py deleted file mode 100644 index fb6721cd..00000000 --- a/foundry/v1/models/_list_ontologies_response.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._list_ontologies_response_dict import ListOntologiesResponseDict -from foundry.v1.models._ontology import Ontology - - -class ListOntologiesResponse(BaseModel): - """ListOntologiesResponse""" - - data: List[Ontology] - """The list of Ontologies the user has access to.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListOntologiesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListOntologiesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_list_ontologies_response_dict.py b/foundry/v1/models/_list_ontologies_response_dict.py deleted file mode 100644 index c6a75334..00000000 --- a/foundry/v1/models/_list_ontologies_response_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._ontology_dict import OntologyDict - - -class ListOntologiesResponseDict(TypedDict): - """ListOntologiesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[OntologyDict] - """The list of Ontologies the user has access to.""" diff --git a/foundry/v1/models/_list_ontologies_v2_response.py b/foundry/v1/models/_list_ontologies_v2_response.py deleted file mode 100644 index 95563337..00000000 --- a/foundry/v1/models/_list_ontologies_v2_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._list_ontologies_v2_response_dict import ListOntologiesV2ResponseDict # NOQA -from foundry.v1.models._ontology_v2 import OntologyV2 - - -class ListOntologiesV2Response(BaseModel): - """ListOntologiesV2Response""" - - data: List[OntologyV2] - """The list of Ontologies the user has access to.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListOntologiesV2ResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListOntologiesV2ResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_list_ontologies_v2_response_dict.py b/foundry/v1/models/_list_ontologies_v2_response_dict.py deleted file mode 100644 index 5ee28cdc..00000000 --- a/foundry/v1/models/_list_ontologies_v2_response_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._ontology_v2_dict import OntologyV2Dict - - -class ListOntologiesV2ResponseDict(TypedDict): - """ListOntologiesV2Response""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[OntologyV2Dict] - """The list of Ontologies the user has access to.""" diff --git a/foundry/v1/models/_list_outgoing_link_types_response.py b/foundry/v1/models/_list_outgoing_link_types_response.py deleted file mode 100644 index 804e7691..00000000 --- a/foundry/v1/models/_list_outgoing_link_types_response.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._link_type_side import LinkTypeSide -from foundry.v1.models._list_outgoing_link_types_response_dict import ( - ListOutgoingLinkTypesResponseDict, -) # NOQA -from foundry.v1.models._page_token import PageToken - - -class ListOutgoingLinkTypesResponse(BaseModel): - """ListOutgoingLinkTypesResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[LinkTypeSide] - """The list of link type sides in the current page.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListOutgoingLinkTypesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListOutgoingLinkTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_list_outgoing_link_types_response_dict.py b/foundry/v1/models/_list_outgoing_link_types_response_dict.py deleted file mode 100644 index 30a142ad..00000000 --- a/foundry/v1/models/_list_outgoing_link_types_response_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._link_type_side_dict import LinkTypeSideDict -from foundry.v1.models._page_token import PageToken - - -class ListOutgoingLinkTypesResponseDict(TypedDict): - """ListOutgoingLinkTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[LinkTypeSideDict] - """The list of link type sides in the current page.""" diff --git a/foundry/v1/models/_list_outgoing_link_types_response_v2.py b/foundry/v1/models/_list_outgoing_link_types_response_v2.py deleted file mode 100644 index 21d6b2aa..00000000 --- a/foundry/v1/models/_list_outgoing_link_types_response_v2.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._link_type_side_v2 import LinkTypeSideV2 -from foundry.v1.models._list_outgoing_link_types_response_v2_dict import ( - ListOutgoingLinkTypesResponseV2Dict, -) # NOQA -from foundry.v1.models._page_token import PageToken - - -class ListOutgoingLinkTypesResponseV2(BaseModel): - """ListOutgoingLinkTypesResponseV2""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[LinkTypeSideV2] - """The list of link type sides in the current page.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListOutgoingLinkTypesResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListOutgoingLinkTypesResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_list_outgoing_link_types_response_v2_dict.py b/foundry/v1/models/_list_outgoing_link_types_response_v2_dict.py deleted file mode 100644 index 19c9f57f..00000000 --- a/foundry/v1/models/_list_outgoing_link_types_response_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._link_type_side_v2_dict import LinkTypeSideV2Dict -from foundry.v1.models._page_token import PageToken - - -class ListOutgoingLinkTypesResponseV2Dict(TypedDict): - """ListOutgoingLinkTypesResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[LinkTypeSideV2Dict] - """The list of link type sides in the current page.""" diff --git a/foundry/v1/models/_list_query_types_response.py b/foundry/v1/models/_list_query_types_response.py deleted file mode 100644 index 62d10c0b..00000000 --- a/foundry/v1/models/_list_query_types_response.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._list_query_types_response_dict import ListQueryTypesResponseDict -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._query_type import QueryType - - -class ListQueryTypesResponse(BaseModel): - """ListQueryTypesResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[QueryType] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListQueryTypesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListQueryTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_list_query_types_response_dict.py b/foundry/v1/models/_list_query_types_response_dict.py deleted file mode 100644 index 773200b7..00000000 --- a/foundry/v1/models/_list_query_types_response_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._query_type_dict import QueryTypeDict - - -class ListQueryTypesResponseDict(TypedDict): - """ListQueryTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[QueryTypeDict] diff --git a/foundry/v1/models/_list_query_types_response_v2.py b/foundry/v1/models/_list_query_types_response_v2.py deleted file mode 100644 index 3678575e..00000000 --- a/foundry/v1/models/_list_query_types_response_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._list_query_types_response_v2_dict import ( - ListQueryTypesResponseV2Dict, -) # NOQA -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._query_type_v2 import QueryTypeV2 - - -class ListQueryTypesResponseV2(BaseModel): - """ListQueryTypesResponseV2""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[QueryTypeV2] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListQueryTypesResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListQueryTypesResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_list_query_types_response_v2_dict.py b/foundry/v1/models/_list_query_types_response_v2_dict.py deleted file mode 100644 index a341710a..00000000 --- a/foundry/v1/models/_list_query_types_response_v2_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._query_type_v2_dict import QueryTypeV2Dict - - -class ListQueryTypesResponseV2Dict(TypedDict): - """ListQueryTypesResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[QueryTypeV2Dict] diff --git a/foundry/v1/models/_load_object_set_request_v2.py b/foundry/v1/models/_load_object_set_request_v2.py deleted file mode 100644 index 2a879ea8..00000000 --- a/foundry/v1/models/_load_object_set_request_v2.py +++ /dev/null @@ -1,57 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool - -from foundry.v1.models._load_object_set_request_v2_dict import LoadObjectSetRequestV2Dict # NOQA -from foundry.v1.models._object_set import ObjectSet -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._search_order_by_v2 import SearchOrderByV2 -from foundry.v1.models._selected_property_api_name import SelectedPropertyApiName - - -class LoadObjectSetRequestV2(BaseModel): - """Represents the API POST body when loading an `ObjectSet`.""" - - object_set: ObjectSet = Field(alias="objectSet") - - order_by: Optional[SearchOrderByV2] = Field(alias="orderBy", default=None) - - select: List[SelectedPropertyApiName] - - page_token: Optional[PageToken] = Field(alias="pageToken", default=None) - - page_size: Optional[PageSize] = Field(alias="pageSize", default=None) - - exclude_rid: Optional[StrictBool] = Field(alias="excludeRid", default=None) - """ - A flag to exclude the retrieval of the `__rid` property. - Setting this to true may improve performance of this endpoint for object types in OSV2. - """ - - model_config = {"extra": "allow"} - - def to_dict(self) -> LoadObjectSetRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LoadObjectSetRequestV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_load_object_set_request_v2_dict.py b/foundry/v1/models/_load_object_set_request_v2_dict.py deleted file mode 100644 index 46f5f209..00000000 --- a/foundry/v1/models/_load_object_set_request_v2_dict.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from pydantic import StrictBool -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._object_set_dict import ObjectSetDict -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._search_order_by_v2_dict import SearchOrderByV2Dict -from foundry.v1.models._selected_property_api_name import SelectedPropertyApiName - - -class LoadObjectSetRequestV2Dict(TypedDict): - """Represents the API POST body when loading an `ObjectSet`.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict - - orderBy: NotRequired[SearchOrderByV2Dict] - - select: List[SelectedPropertyApiName] - - pageToken: NotRequired[PageToken] - - pageSize: NotRequired[PageSize] - - excludeRid: NotRequired[StrictBool] - """ - A flag to exclude the retrieval of the `__rid` property. - Setting this to true may improve performance of this endpoint for object types in OSV2. - """ diff --git a/foundry/v1/models/_load_object_set_response_v2.py b/foundry/v1/models/_load_object_set_response_v2.py deleted file mode 100644 index 3b76c25c..00000000 --- a/foundry/v1/models/_load_object_set_response_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._load_object_set_response_v2_dict import LoadObjectSetResponseV2Dict # NOQA -from foundry.v1.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._total_count import TotalCount - - -class LoadObjectSetResponseV2(BaseModel): - """Represents the API response when loading an `ObjectSet`.""" - - data: List[OntologyObjectV2] - """The list of objects in the current Page.""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - total_count: TotalCount = Field(alias="totalCount") - - model_config = {"extra": "allow"} - - def to_dict(self) -> LoadObjectSetResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LoadObjectSetResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_load_object_set_response_v2_dict.py b/foundry/v1/models/_load_object_set_response_v2_dict.py deleted file mode 100644 index faa623d6..00000000 --- a/foundry/v1/models/_load_object_set_response_v2_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._total_count import TotalCount - - -class LoadObjectSetResponseV2Dict(TypedDict): - """Represents the API response when loading an `ObjectSet`.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[OntologyObjectV2] - """The list of objects in the current Page.""" - - nextPageToken: NotRequired[PageToken] - - totalCount: TotalCount diff --git a/foundry/v1/models/_local_file_path.py b/foundry/v1/models/_local_file_path.py deleted file mode 100644 index d32c49de..00000000 --- a/foundry/v1/models/_local_file_path.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._local_file_path_dict import LocalFilePathDict - - -class LocalFilePath(BaseModel): - """LocalFilePath""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> LocalFilePathDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LocalFilePathDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_local_file_path_dict.py b/foundry/v1/models/_local_file_path_dict.py deleted file mode 100644 index 1771cd51..00000000 --- a/foundry/v1/models/_local_file_path_dict.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - - -class LocalFilePathDict(TypedDict): - """LocalFilePath""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v1/models/_logic_rule.py b/foundry/v1/models/_logic_rule.py deleted file mode 100644 index 9c6eb5f7..00000000 --- a/foundry/v1/models/_logic_rule.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._create_link_rule import CreateLinkRule -from foundry.v1.models._create_object_rule import CreateObjectRule -from foundry.v1.models._delete_link_rule import DeleteLinkRule -from foundry.v1.models._delete_object_rule import DeleteObjectRule -from foundry.v1.models._modify_object_rule import ModifyObjectRule - -LogicRule = Annotated[ - Union[CreateObjectRule, ModifyObjectRule, DeleteObjectRule, CreateLinkRule, DeleteLinkRule], - Field(discriminator="type"), -] -"""LogicRule""" diff --git a/foundry/v1/models/_logic_rule_dict.py b/foundry/v1/models/_logic_rule_dict.py deleted file mode 100644 index f692be33..00000000 --- a/foundry/v1/models/_logic_rule_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._create_link_rule_dict import CreateLinkRuleDict -from foundry.v1.models._create_object_rule_dict import CreateObjectRuleDict -from foundry.v1.models._delete_link_rule_dict import DeleteLinkRuleDict -from foundry.v1.models._delete_object_rule_dict import DeleteObjectRuleDict -from foundry.v1.models._modify_object_rule_dict import ModifyObjectRuleDict - -LogicRuleDict = Annotated[ - Union[ - CreateObjectRuleDict, - ModifyObjectRuleDict, - DeleteObjectRuleDict, - CreateLinkRuleDict, - DeleteLinkRuleDict, - ], - Field(discriminator="type"), -] -"""LogicRule""" diff --git a/foundry/v1/models/_long_type.py b/foundry/v1/models/_long_type.py deleted file mode 100644 index 6a6d3155..00000000 --- a/foundry/v1/models/_long_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._long_type_dict import LongTypeDict - - -class LongType(BaseModel): - """LongType""" - - type: Literal["long"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LongTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LongTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_lt_query.py b/foundry/v1/models/_lt_query.py deleted file mode 100644 index 8441f947..00000000 --- a/foundry/v1/models/_lt_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._lt_query_dict import LtQueryDict -from foundry.v1.models._property_value import PropertyValue - - -class LtQuery(BaseModel): - """Returns objects where the specified field is less than a value.""" - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["lt"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LtQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LtQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_lt_query_dict.py b/foundry/v1/models/_lt_query_dict.py deleted file mode 100644 index 7bdbe3ff..00000000 --- a/foundry/v1/models/_lt_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._property_value import PropertyValue - - -class LtQueryDict(TypedDict): - """Returns objects where the specified field is less than a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["lt"] diff --git a/foundry/v1/models/_lt_query_v2.py b/foundry/v1/models/_lt_query_v2.py deleted file mode 100644 index d92bdf12..00000000 --- a/foundry/v1/models/_lt_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._lt_query_v2_dict import LtQueryV2Dict -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - - -class LtQueryV2(BaseModel): - """Returns objects where the specified field is less than a value.""" - - field: PropertyApiName - - value: PropertyValue - - type: Literal["lt"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LtQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LtQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_lt_query_v2_dict.py b/foundry/v1/models/_lt_query_v2_dict.py deleted file mode 100644 index a8ab4773..00000000 --- a/foundry/v1/models/_lt_query_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - - -class LtQueryV2Dict(TypedDict): - """Returns objects where the specified field is less than a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PropertyValue - - type: Literal["lt"] diff --git a/foundry/v1/models/_lte_query.py b/foundry/v1/models/_lte_query.py deleted file mode 100644 index f95c35bc..00000000 --- a/foundry/v1/models/_lte_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._lte_query_dict import LteQueryDict -from foundry.v1.models._property_value import PropertyValue - - -class LteQuery(BaseModel): - """Returns objects where the specified field is less than or equal to a value.""" - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["lte"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LteQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LteQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_lte_query_dict.py b/foundry/v1/models/_lte_query_dict.py deleted file mode 100644 index b02affe1..00000000 --- a/foundry/v1/models/_lte_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._property_value import PropertyValue - - -class LteQueryDict(TypedDict): - """Returns objects where the specified field is less than or equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["lte"] diff --git a/foundry/v1/models/_lte_query_v2.py b/foundry/v1/models/_lte_query_v2.py deleted file mode 100644 index bb855742..00000000 --- a/foundry/v1/models/_lte_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._lte_query_v2_dict import LteQueryV2Dict -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - - -class LteQueryV2(BaseModel): - """Returns objects where the specified field is less than or equal to a value.""" - - field: PropertyApiName - - value: PropertyValue - - type: Literal["lte"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LteQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LteQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_lte_query_v2_dict.py b/foundry/v1/models/_lte_query_v2_dict.py deleted file mode 100644 index 76043dbc..00000000 --- a/foundry/v1/models/_lte_query_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - - -class LteQueryV2Dict(TypedDict): - """Returns objects where the specified field is less than or equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PropertyValue - - type: Literal["lte"] diff --git a/foundry/v1/models/_marking_type.py b/foundry/v1/models/_marking_type.py deleted file mode 100644 index e822e758..00000000 --- a/foundry/v1/models/_marking_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._marking_type_dict import MarkingTypeDict - - -class MarkingType(BaseModel): - """MarkingType""" - - type: Literal["marking"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MarkingTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MarkingTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_max_aggregation.py b/foundry/v1/models/_max_aggregation.py deleted file mode 100644 index fd3826e1..00000000 --- a/foundry/v1/models/_max_aggregation.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._max_aggregation_dict import MaxAggregationDict - - -class MaxAggregation(BaseModel): - """Computes the maximum value for the provided field.""" - - field: FieldNameV1 - - name: Optional[AggregationMetricName] = None - - type: Literal["max"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MaxAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MaxAggregationDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_max_aggregation_dict.py b/foundry/v1/models/_max_aggregation_dict.py deleted file mode 100644 index 72de4760..00000000 --- a/foundry/v1/models/_max_aggregation_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class MaxAggregationDict(TypedDict): - """Computes the maximum value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - name: NotRequired[AggregationMetricName] - - type: Literal["max"] diff --git a/foundry/v1/models/_max_aggregation_v2.py b/foundry/v1/models/_max_aggregation_v2.py deleted file mode 100644 index 2231ba93..00000000 --- a/foundry/v1/models/_max_aggregation_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._max_aggregation_v2_dict import MaxAggregationV2Dict -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._property_api_name import PropertyApiName - - -class MaxAggregationV2(BaseModel): - """Computes the maximum value for the provided field.""" - - field: PropertyApiName - - name: Optional[AggregationMetricName] = None - - direction: Optional[OrderByDirection] = None - - type: Literal["max"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MaxAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MaxAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_max_aggregation_v2_dict.py b/foundry/v1/models/_max_aggregation_v2_dict.py deleted file mode 100644 index a44116e7..00000000 --- a/foundry/v1/models/_max_aggregation_v2_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._property_api_name import PropertyApiName - - -class MaxAggregationV2Dict(TypedDict): - """Computes the maximum value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - name: NotRequired[AggregationMetricName] - - direction: NotRequired[OrderByDirection] - - type: Literal["max"] diff --git a/foundry/v1/models/_min_aggregation.py b/foundry/v1/models/_min_aggregation.py deleted file mode 100644 index bf0fba0d..00000000 --- a/foundry/v1/models/_min_aggregation.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._min_aggregation_dict import MinAggregationDict - - -class MinAggregation(BaseModel): - """Computes the minimum value for the provided field.""" - - field: FieldNameV1 - - name: Optional[AggregationMetricName] = None - - type: Literal["min"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MinAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MinAggregationDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_min_aggregation_dict.py b/foundry/v1/models/_min_aggregation_dict.py deleted file mode 100644 index 3486da4f..00000000 --- a/foundry/v1/models/_min_aggregation_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class MinAggregationDict(TypedDict): - """Computes the minimum value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - name: NotRequired[AggregationMetricName] - - type: Literal["min"] diff --git a/foundry/v1/models/_min_aggregation_v2.py b/foundry/v1/models/_min_aggregation_v2.py deleted file mode 100644 index 3c434fdc..00000000 --- a/foundry/v1/models/_min_aggregation_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._min_aggregation_v2_dict import MinAggregationV2Dict -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._property_api_name import PropertyApiName - - -class MinAggregationV2(BaseModel): - """Computes the minimum value for the provided field.""" - - field: PropertyApiName - - name: Optional[AggregationMetricName] = None - - direction: Optional[OrderByDirection] = None - - type: Literal["min"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MinAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MinAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_min_aggregation_v2_dict.py b/foundry/v1/models/_min_aggregation_v2_dict.py deleted file mode 100644 index 47cb4c6d..00000000 --- a/foundry/v1/models/_min_aggregation_v2_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._property_api_name import PropertyApiName - - -class MinAggregationV2Dict(TypedDict): - """Computes the minimum value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - name: NotRequired[AggregationMetricName] - - direction: NotRequired[OrderByDirection] - - type: Literal["min"] diff --git a/foundry/v1/models/_modify_object.py b/foundry/v1/models/_modify_object.py deleted file mode 100644 index 62b69e09..00000000 --- a/foundry/v1/models/_modify_object.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._modify_object_dict import ModifyObjectDict -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._property_value import PropertyValue - - -class ModifyObject(BaseModel): - """ModifyObject""" - - primary_key: PropertyValue = Field(alias="primaryKey") - - object_type: ObjectTypeApiName = Field(alias="objectType") - - type: Literal["modifyObject"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ModifyObjectDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ModifyObjectDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_modify_object_dict.py b/foundry/v1/models/_modify_object_dict.py deleted file mode 100644 index 7b827a88..00000000 --- a/foundry/v1/models/_modify_object_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._property_value import PropertyValue - - -class ModifyObjectDict(TypedDict): - """ModifyObject""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - primaryKey: PropertyValue - - objectType: ObjectTypeApiName - - type: Literal["modifyObject"] diff --git a/foundry/v1/models/_modify_object_rule.py b/foundry/v1/models/_modify_object_rule.py deleted file mode 100644 index 74210fa1..00000000 --- a/foundry/v1/models/_modify_object_rule.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._modify_object_rule_dict import ModifyObjectRuleDict -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class ModifyObjectRule(BaseModel): - """ModifyObjectRule""" - - object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") - - type: Literal["modifyObject"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ModifyObjectRuleDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ModifyObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_modify_object_rule_dict.py b/foundry/v1/models/_modify_object_rule_dict.py deleted file mode 100644 index f413d012..00000000 --- a/foundry/v1/models/_modify_object_rule_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class ModifyObjectRuleDict(TypedDict): - """ModifyObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectTypeApiName: ObjectTypeApiName - - type: Literal["modifyObject"] diff --git a/foundry/v1/models/_multi_line_string.py b/foundry/v1/models/_multi_line_string.py deleted file mode 100644 index f7a20517..00000000 --- a/foundry/v1/models/_multi_line_string.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._line_string_coordinates import LineStringCoordinates -from foundry.v1.models._multi_line_string_dict import MultiLineStringDict - - -class MultiLineString(BaseModel): - """MultiLineString""" - - coordinates: List[LineStringCoordinates] - - bbox: Optional[BBox] = None - - type: Literal["MultiLineString"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MultiLineStringDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MultiLineStringDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_multi_line_string_dict.py b/foundry/v1/models/_multi_line_string_dict.py deleted file mode 100644 index 22158dec..00000000 --- a/foundry/v1/models/_multi_line_string_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._line_string_coordinates import LineStringCoordinates - - -class MultiLineStringDict(TypedDict): - """MultiLineString""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: List[LineStringCoordinates] - - bbox: NotRequired[BBox] - - type: Literal["MultiLineString"] diff --git a/foundry/v1/models/_multi_point.py b/foundry/v1/models/_multi_point.py deleted file mode 100644 index b5f19808..00000000 --- a/foundry/v1/models/_multi_point.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._multi_point_dict import MultiPointDict -from foundry.v1.models._position import Position - - -class MultiPoint(BaseModel): - """MultiPoint""" - - coordinates: List[Position] - - bbox: Optional[BBox] = None - - type: Literal["MultiPoint"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MultiPointDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MultiPointDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_multi_point_dict.py b/foundry/v1/models/_multi_point_dict.py deleted file mode 100644 index b0915de4..00000000 --- a/foundry/v1/models/_multi_point_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._position import Position - - -class MultiPointDict(TypedDict): - """MultiPoint""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: List[Position] - - bbox: NotRequired[BBox] - - type: Literal["MultiPoint"] diff --git a/foundry/v1/models/_multi_polygon.py b/foundry/v1/models/_multi_polygon.py deleted file mode 100644 index 05b8a791..00000000 --- a/foundry/v1/models/_multi_polygon.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._linear_ring import LinearRing -from foundry.v1.models._multi_polygon_dict import MultiPolygonDict - - -class MultiPolygon(BaseModel): - """MultiPolygon""" - - coordinates: List[List[LinearRing]] - - bbox: Optional[BBox] = None - - type: Literal["MultiPolygon"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MultiPolygonDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MultiPolygonDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_multi_polygon_dict.py b/foundry/v1/models/_multi_polygon_dict.py deleted file mode 100644 index 221e99b7..00000000 --- a/foundry/v1/models/_multi_polygon_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._linear_ring import LinearRing - - -class MultiPolygonDict(TypedDict): - """MultiPolygon""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: List[List[LinearRing]] - - bbox: NotRequired[BBox] - - type: Literal["MultiPolygon"] diff --git a/foundry/v1/models/_nested_query_aggregation.py b/foundry/v1/models/_nested_query_aggregation.py deleted file mode 100644 index 370f5576..00000000 --- a/foundry/v1/models/_nested_query_aggregation.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._nested_query_aggregation_dict import NestedQueryAggregationDict -from foundry.v1.models._query_aggregation import QueryAggregation - - -class NestedQueryAggregation(BaseModel): - """NestedQueryAggregation""" - - key: Any - - groups: List[QueryAggregation] - - model_config = {"extra": "allow"} - - def to_dict(self) -> NestedQueryAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(NestedQueryAggregationDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_nested_query_aggregation_dict.py b/foundry/v1/models/_nested_query_aggregation_dict.py deleted file mode 100644 index 84cad810..00000000 --- a/foundry/v1/models/_nested_query_aggregation_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._query_aggregation_dict import QueryAggregationDict - - -class NestedQueryAggregationDict(TypedDict): - """NestedQueryAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - key: Any - - groups: List[QueryAggregationDict] diff --git a/foundry/v1/models/_null_type.py b/foundry/v1/models/_null_type.py deleted file mode 100644 index 0e11391c..00000000 --- a/foundry/v1/models/_null_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._null_type_dict import NullTypeDict - - -class NullType(BaseModel): - """NullType""" - - type: Literal["null"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> NullTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(NullTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_object_edit.py b/foundry/v1/models/_object_edit.py deleted file mode 100644 index bb1a1ec4..00000000 --- a/foundry/v1/models/_object_edit.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._add_link import AddLink -from foundry.v1.models._add_object import AddObject -from foundry.v1.models._modify_object import ModifyObject - -ObjectEdit = Annotated[Union[AddObject, ModifyObject, AddLink], Field(discriminator="type")] -"""ObjectEdit""" diff --git a/foundry/v1/models/_object_edit_dict.py b/foundry/v1/models/_object_edit_dict.py deleted file mode 100644 index eacb3730..00000000 --- a/foundry/v1/models/_object_edit_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._add_link_dict import AddLinkDict -from foundry.v1.models._add_object_dict import AddObjectDict -from foundry.v1.models._modify_object_dict import ModifyObjectDict - -ObjectEditDict = Annotated[ - Union[AddObjectDict, ModifyObjectDict, AddLinkDict], Field(discriminator="type") -] -"""ObjectEdit""" diff --git a/foundry/v1/models/_object_edits.py b/foundry/v1/models/_object_edits.py deleted file mode 100644 index e33bda10..00000000 --- a/foundry/v1/models/_object_edits.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictInt - -from foundry.v1.models._object_edit import ObjectEdit -from foundry.v1.models._object_edits_dict import ObjectEditsDict - - -class ObjectEdits(BaseModel): - """ObjectEdits""" - - edits: List[ObjectEdit] - - added_object_count: StrictInt = Field(alias="addedObjectCount") - - modified_objects_count: StrictInt = Field(alias="modifiedObjectsCount") - - deleted_objects_count: StrictInt = Field(alias="deletedObjectsCount") - - added_links_count: StrictInt = Field(alias="addedLinksCount") - - deleted_links_count: StrictInt = Field(alias="deletedLinksCount") - - type: Literal["edits"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectEditsDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectEditsDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_object_edits_dict.py b/foundry/v1/models/_object_edits_dict.py deleted file mode 100644 index 58097f77..00000000 --- a/foundry/v1/models/_object_edits_dict.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from pydantic import StrictInt -from typing_extensions import TypedDict - -from foundry.v1.models._object_edit_dict import ObjectEditDict - - -class ObjectEditsDict(TypedDict): - """ObjectEdits""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - edits: List[ObjectEditDict] - - addedObjectCount: StrictInt - - modifiedObjectsCount: StrictInt - - deletedObjectsCount: StrictInt - - addedLinksCount: StrictInt - - deletedLinksCount: StrictInt - - type: Literal["edits"] diff --git a/foundry/v1/models/_object_primary_key.py b/foundry/v1/models/_object_primary_key.py deleted file mode 100644 index fcab71f0..00000000 --- a/foundry/v1/models/_object_primary_key.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict - -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - -ObjectPrimaryKey = Dict[PropertyApiName, PropertyValue] -"""ObjectPrimaryKey""" diff --git a/foundry/v1/models/_object_property_type.py b/foundry/v1/models/_object_property_type.py deleted file mode 100644 index 46615d5d..00000000 --- a/foundry/v1/models/_object_property_type.py +++ /dev/null @@ -1,81 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._attachment_type import AttachmentType -from foundry.v1.models._boolean_type import BooleanType -from foundry.v1.models._byte_type import ByteType -from foundry.v1.models._date_type import DateType -from foundry.v1.models._decimal_type import DecimalType -from foundry.v1.models._double_type import DoubleType -from foundry.v1.models._float_type import FloatType -from foundry.v1.models._geo_point_type import GeoPointType -from foundry.v1.models._geo_shape_type import GeoShapeType -from foundry.v1.models._integer_type import IntegerType -from foundry.v1.models._long_type import LongType -from foundry.v1.models._marking_type import MarkingType -from foundry.v1.models._object_property_type_dict import OntologyObjectArrayTypeDict -from foundry.v1.models._short_type import ShortType -from foundry.v1.models._string_type import StringType -from foundry.v1.models._timeseries_type import TimeseriesType -from foundry.v1.models._timestamp_type import TimestampType - - -class OntologyObjectArrayType(BaseModel): - """OntologyObjectArrayType""" - - sub_type: ObjectPropertyType = Field(alias="subType") - - type: Literal["array"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyObjectArrayTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyObjectArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -ObjectPropertyType = Annotated[ - Union[ - OntologyObjectArrayType, - AttachmentType, - BooleanType, - ByteType, - DateType, - DecimalType, - DoubleType, - FloatType, - GeoPointType, - GeoShapeType, - IntegerType, - LongType, - MarkingType, - ShortType, - StringType, - TimestampType, - TimeseriesType, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Object properties.""" diff --git a/foundry/v1/models/_object_property_type_dict.py b/foundry/v1/models/_object_property_type_dict.py deleted file mode 100644 index 34031f41..00000000 --- a/foundry/v1/models/_object_property_type_dict.py +++ /dev/null @@ -1,75 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import TypedDict - -from foundry.v1.models._attachment_type_dict import AttachmentTypeDict -from foundry.v1.models._boolean_type_dict import BooleanTypeDict -from foundry.v1.models._byte_type_dict import ByteTypeDict -from foundry.v1.models._date_type_dict import DateTypeDict -from foundry.v1.models._decimal_type_dict import DecimalTypeDict -from foundry.v1.models._double_type_dict import DoubleTypeDict -from foundry.v1.models._float_type_dict import FloatTypeDict -from foundry.v1.models._geo_point_type_dict import GeoPointTypeDict -from foundry.v1.models._geo_shape_type_dict import GeoShapeTypeDict -from foundry.v1.models._integer_type_dict import IntegerTypeDict -from foundry.v1.models._long_type_dict import LongTypeDict -from foundry.v1.models._marking_type_dict import MarkingTypeDict -from foundry.v1.models._short_type_dict import ShortTypeDict -from foundry.v1.models._string_type_dict import StringTypeDict -from foundry.v1.models._timeseries_type_dict import TimeseriesTypeDict -from foundry.v1.models._timestamp_type_dict import TimestampTypeDict - - -class OntologyObjectArrayTypeDict(TypedDict): - """OntologyObjectArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: ObjectPropertyTypeDict - - type: Literal["array"] - - -ObjectPropertyTypeDict = Annotated[ - Union[ - OntologyObjectArrayTypeDict, - AttachmentTypeDict, - BooleanTypeDict, - ByteTypeDict, - DateTypeDict, - DecimalTypeDict, - DoubleTypeDict, - FloatTypeDict, - GeoPointTypeDict, - GeoShapeTypeDict, - IntegerTypeDict, - LongTypeDict, - MarkingTypeDict, - ShortTypeDict, - StringTypeDict, - TimestampTypeDict, - TimeseriesTypeDict, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Object properties.""" diff --git a/foundry/v1/models/_object_property_value_constraint.py b/foundry/v1/models/_object_property_value_constraint.py deleted file mode 100644 index 86e8cc73..00000000 --- a/foundry/v1/models/_object_property_value_constraint.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._object_property_value_constraint_dict import ( - ObjectPropertyValueConstraintDict, -) # NOQA - - -class ObjectPropertyValueConstraint(BaseModel): - """The parameter value must be a property value of an object found within an object set.""" - - type: Literal["objectPropertyValue"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectPropertyValueConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectPropertyValueConstraintDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_object_query_result_constraint.py b/foundry/v1/models/_object_query_result_constraint.py deleted file mode 100644 index 949ddc40..00000000 --- a/foundry/v1/models/_object_query_result_constraint.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._object_query_result_constraint_dict import ( - ObjectQueryResultConstraintDict, -) # NOQA - - -class ObjectQueryResultConstraint(BaseModel): - """The parameter value must be the primary key of an object found within an object set.""" - - type: Literal["objectQueryResult"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectQueryResultConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectQueryResultConstraintDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_object_set.py b/foundry/v1/models/_object_set.py deleted file mode 100644 index 60232700..00000000 --- a/foundry/v1/models/_object_set.py +++ /dev/null @@ -1,130 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._link_type_api_name import LinkTypeApiName -from foundry.v1.models._object_set_base_type import ObjectSetBaseType -from foundry.v1.models._object_set_dict import ObjectSetFilterTypeDict -from foundry.v1.models._object_set_dict import ObjectSetIntersectionTypeDict -from foundry.v1.models._object_set_dict import ObjectSetSearchAroundTypeDict -from foundry.v1.models._object_set_dict import ObjectSetSubtractTypeDict -from foundry.v1.models._object_set_dict import ObjectSetUnionTypeDict -from foundry.v1.models._object_set_reference_type import ObjectSetReferenceType -from foundry.v1.models._object_set_static_type import ObjectSetStaticType -from foundry.v1.models._search_json_query_v2 import SearchJsonQueryV2 - - -class ObjectSetFilterType(BaseModel): - """ObjectSetFilterType""" - - object_set: ObjectSet = Field(alias="objectSet") - - where: SearchJsonQueryV2 - - type: Literal["filter"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetFilterTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectSetFilterTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class ObjectSetUnionType(BaseModel): - """ObjectSetUnionType""" - - object_sets: List[ObjectSet] = Field(alias="objectSets") - - type: Literal["union"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetUnionTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectSetUnionTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class ObjectSetIntersectionType(BaseModel): - """ObjectSetIntersectionType""" - - object_sets: List[ObjectSet] = Field(alias="objectSets") - - type: Literal["intersect"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetIntersectionTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectSetIntersectionTypeDict, self.model_dump(by_alias=True, exclude_unset=True) - ) - - -class ObjectSetSubtractType(BaseModel): - """ObjectSetSubtractType""" - - object_sets: List[ObjectSet] = Field(alias="objectSets") - - type: Literal["subtract"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetSubtractTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectSetSubtractTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class ObjectSetSearchAroundType(BaseModel): - """ObjectSetSearchAroundType""" - - object_set: ObjectSet = Field(alias="objectSet") - - link: LinkTypeApiName - - type: Literal["searchAround"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetSearchAroundTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectSetSearchAroundTypeDict, self.model_dump(by_alias=True, exclude_unset=True) - ) - - -ObjectSet = Annotated[ - Union[ - ObjectSetBaseType, - ObjectSetStaticType, - ObjectSetReferenceType, - ObjectSetFilterType, - ObjectSetUnionType, - ObjectSetIntersectionType, - ObjectSetSubtractType, - ObjectSetSearchAroundType, - ], - Field(discriminator="type"), -] -"""Represents the definition of an `ObjectSet` in the `Ontology`.""" diff --git a/foundry/v1/models/_object_set_base_type.py b/foundry/v1/models/_object_set_base_type.py deleted file mode 100644 index acd36cac..00000000 --- a/foundry/v1/models/_object_set_base_type.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._object_set_base_type_dict import ObjectSetBaseTypeDict - - -class ObjectSetBaseType(BaseModel): - """ObjectSetBaseType""" - - object_type: StrictStr = Field(alias="objectType") - - type: Literal["base"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetBaseTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectSetBaseTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_object_set_dict.py b/foundry/v1/models/_object_set_dict.py deleted file mode 100644 index 815cb213..00000000 --- a/foundry/v1/models/_object_set_dict.py +++ /dev/null @@ -1,100 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import TypedDict - -from foundry.v1.models._link_type_api_name import LinkTypeApiName -from foundry.v1.models._object_set_base_type_dict import ObjectSetBaseTypeDict -from foundry.v1.models._object_set_reference_type_dict import ObjectSetReferenceTypeDict -from foundry.v1.models._object_set_static_type_dict import ObjectSetStaticTypeDict -from foundry.v1.models._search_json_query_v2_dict import SearchJsonQueryV2Dict - - -class ObjectSetFilterTypeDict(TypedDict): - """ObjectSetFilterType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict - - where: SearchJsonQueryV2Dict - - type: Literal["filter"] - - -class ObjectSetUnionTypeDict(TypedDict): - """ObjectSetUnionType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSets: List[ObjectSetDict] - - type: Literal["union"] - - -class ObjectSetIntersectionTypeDict(TypedDict): - """ObjectSetIntersectionType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSets: List[ObjectSetDict] - - type: Literal["intersect"] - - -class ObjectSetSubtractTypeDict(TypedDict): - """ObjectSetSubtractType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSets: List[ObjectSetDict] - - type: Literal["subtract"] - - -class ObjectSetSearchAroundTypeDict(TypedDict): - """ObjectSetSearchAroundType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict - - link: LinkTypeApiName - - type: Literal["searchAround"] - - -ObjectSetDict = Annotated[ - Union[ - ObjectSetBaseTypeDict, - ObjectSetStaticTypeDict, - ObjectSetReferenceTypeDict, - ObjectSetFilterTypeDict, - ObjectSetUnionTypeDict, - ObjectSetIntersectionTypeDict, - ObjectSetSubtractTypeDict, - ObjectSetSearchAroundTypeDict, - ], - Field(discriminator="type"), -] -"""Represents the definition of an `ObjectSet` in the `Ontology`.""" diff --git a/foundry/v1/models/_object_set_reference_type.py b/foundry/v1/models/_object_set_reference_type.py deleted file mode 100644 index 7d40bc4f..00000000 --- a/foundry/v1/models/_object_set_reference_type.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry._core.utils import RID -from foundry.v1.models._object_set_reference_type_dict import ObjectSetReferenceTypeDict - - -class ObjectSetReferenceType(BaseModel): - """ObjectSetReferenceType""" - - reference: RID - - type: Literal["reference"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetReferenceTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectSetReferenceTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_object_set_static_type.py b/foundry/v1/models/_object_set_static_type.py deleted file mode 100644 index 661b8631..00000000 --- a/foundry/v1/models/_object_set_static_type.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._object_rid import ObjectRid -from foundry.v1.models._object_set_static_type_dict import ObjectSetStaticTypeDict - - -class ObjectSetStaticType(BaseModel): - """ObjectSetStaticType""" - - objects: List[ObjectRid] - - type: Literal["static"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetStaticTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectSetStaticTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_object_set_static_type_dict.py b/foundry/v1/models/_object_set_static_type_dict.py deleted file mode 100644 index e1cd5f9f..00000000 --- a/foundry/v1/models/_object_set_static_type_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._object_rid import ObjectRid - - -class ObjectSetStaticTypeDict(TypedDict): - """ObjectSetStaticType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objects: List[ObjectRid] - - type: Literal["static"] diff --git a/foundry/v1/models/_object_set_stream_subscribe_request.py b/foundry/v1/models/_object_set_stream_subscribe_request.py deleted file mode 100644 index 331d3d28..00000000 --- a/foundry/v1/models/_object_set_stream_subscribe_request.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._object_set import ObjectSet -from foundry.v1.models._object_set_stream_subscribe_request_dict import ( - ObjectSetStreamSubscribeRequestDict, -) # NOQA -from foundry.v1.models._selected_property_api_name import SelectedPropertyApiName - - -class ObjectSetStreamSubscribeRequest(BaseModel): - """ObjectSetStreamSubscribeRequest""" - - object_set: ObjectSet = Field(alias="objectSet") - - property_set: List[SelectedPropertyApiName] = Field(alias="propertySet") - - reference_set: List[SelectedPropertyApiName] = Field(alias="referenceSet") - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetStreamSubscribeRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectSetStreamSubscribeRequestDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_object_set_stream_subscribe_request_dict.py b/foundry/v1/models/_object_set_stream_subscribe_request_dict.py deleted file mode 100644 index 103195de..00000000 --- a/foundry/v1/models/_object_set_stream_subscribe_request_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._object_set_dict import ObjectSetDict -from foundry.v1.models._selected_property_api_name import SelectedPropertyApiName - - -class ObjectSetStreamSubscribeRequestDict(TypedDict): - """ObjectSetStreamSubscribeRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict - - propertySet: List[SelectedPropertyApiName] - - referenceSet: List[SelectedPropertyApiName] diff --git a/foundry/v1/models/_object_set_stream_subscribe_requests.py b/foundry/v1/models/_object_set_stream_subscribe_requests.py deleted file mode 100644 index fa6f84c7..00000000 --- a/foundry/v1/models/_object_set_stream_subscribe_requests.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._object_set_stream_subscribe_request import ( - ObjectSetStreamSubscribeRequest, -) # NOQA -from foundry.v1.models._object_set_stream_subscribe_requests_dict import ( - ObjectSetStreamSubscribeRequestsDict, -) # NOQA -from foundry.v1.models._request_id import RequestId - - -class ObjectSetStreamSubscribeRequests(BaseModel): - """ - The list of object sets that should be subscribed to. A client can stop subscribing to an object set - by removing the request from subsequent ObjectSetStreamSubscribeRequests. - """ - - id: RequestId - - requests: List[ObjectSetStreamSubscribeRequest] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetStreamSubscribeRequestsDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectSetStreamSubscribeRequestsDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_object_set_stream_subscribe_requests_dict.py b/foundry/v1/models/_object_set_stream_subscribe_requests_dict.py deleted file mode 100644 index 090acc25..00000000 --- a/foundry/v1/models/_object_set_stream_subscribe_requests_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._object_set_stream_subscribe_request_dict import ( - ObjectSetStreamSubscribeRequestDict, -) # NOQA -from foundry.v1.models._request_id import RequestId - - -class ObjectSetStreamSubscribeRequestsDict(TypedDict): - """ - The list of object sets that should be subscribed to. A client can stop subscribing to an object set - by removing the request from subsequent ObjectSetStreamSubscribeRequests. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - id: RequestId - - requests: List[ObjectSetStreamSubscribeRequestDict] diff --git a/foundry/v1/models/_object_set_subscribe_response.py b/foundry/v1/models/_object_set_subscribe_response.py deleted file mode 100644 index ec91aaea..00000000 --- a/foundry/v1/models/_object_set_subscribe_response.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._qos_error import QosError -from foundry.v1.models._subscription_error import SubscriptionError -from foundry.v1.models._subscription_success import SubscriptionSuccess - -ObjectSetSubscribeResponse = Annotated[ - Union[SubscriptionSuccess, SubscriptionError, QosError], Field(discriminator="type") -] -"""ObjectSetSubscribeResponse""" diff --git a/foundry/v1/models/_object_set_subscribe_response_dict.py b/foundry/v1/models/_object_set_subscribe_response_dict.py deleted file mode 100644 index 1fc55023..00000000 --- a/foundry/v1/models/_object_set_subscribe_response_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._qos_error_dict import QosErrorDict -from foundry.v1.models._subscription_error_dict import SubscriptionErrorDict -from foundry.v1.models._subscription_success_dict import SubscriptionSuccessDict - -ObjectSetSubscribeResponseDict = Annotated[ - Union[SubscriptionSuccessDict, SubscriptionErrorDict, QosErrorDict], Field(discriminator="type") -] -"""ObjectSetSubscribeResponse""" diff --git a/foundry/v1/models/_object_set_subscribe_responses.py b/foundry/v1/models/_object_set_subscribe_responses.py deleted file mode 100644 index fa19c207..00000000 --- a/foundry/v1/models/_object_set_subscribe_responses.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._object_set_subscribe_response import ObjectSetSubscribeResponse -from foundry.v1.models._object_set_subscribe_responses_dict import ( - ObjectSetSubscribeResponsesDict, -) # NOQA -from foundry.v1.models._request_id import RequestId - - -class ObjectSetSubscribeResponses(BaseModel): - """Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId.""" - - responses: List[ObjectSetSubscribeResponse] - - id: RequestId - - type: Literal["subscribeResponses"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetSubscribeResponsesDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectSetSubscribeResponsesDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_object_set_subscribe_responses_dict.py b/foundry/v1/models/_object_set_subscribe_responses_dict.py deleted file mode 100644 index bd7e43bb..00000000 --- a/foundry/v1/models/_object_set_subscribe_responses_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._object_set_subscribe_response_dict import ( - ObjectSetSubscribeResponseDict, -) # NOQA -from foundry.v1.models._request_id import RequestId - - -class ObjectSetSubscribeResponsesDict(TypedDict): - """Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - responses: List[ObjectSetSubscribeResponseDict] - - id: RequestId - - type: Literal["subscribeResponses"] diff --git a/foundry/v1/models/_object_set_update.py b/foundry/v1/models/_object_set_update.py deleted file mode 100644 index 59c2d9b4..00000000 --- a/foundry/v1/models/_object_set_update.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._object_update import ObjectUpdate -from foundry.v1.models._reference_update import ReferenceUpdate - -ObjectSetUpdate = Annotated[Union[ObjectUpdate, ReferenceUpdate], Field(discriminator="type")] -"""ObjectSetUpdate""" diff --git a/foundry/v1/models/_object_set_update_dict.py b/foundry/v1/models/_object_set_update_dict.py deleted file mode 100644 index 9d9b111e..00000000 --- a/foundry/v1/models/_object_set_update_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._object_update_dict import ObjectUpdateDict -from foundry.v1.models._reference_update_dict import ReferenceUpdateDict - -ObjectSetUpdateDict = Annotated[ - Union[ObjectUpdateDict, ReferenceUpdateDict], Field(discriminator="type") -] -"""ObjectSetUpdate""" diff --git a/foundry/v1/models/_object_set_updates.py b/foundry/v1/models/_object_set_updates.py deleted file mode 100644 index fabd5935..00000000 --- a/foundry/v1/models/_object_set_updates.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._object_set_update import ObjectSetUpdate -from foundry.v1.models._object_set_updates_dict import ObjectSetUpdatesDict -from foundry.v1.models._subscription_id import SubscriptionId - - -class ObjectSetUpdates(BaseModel): - """ObjectSetUpdates""" - - id: SubscriptionId - - updates: List[ObjectSetUpdate] - - type: Literal["objectSetChanged"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetUpdatesDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectSetUpdatesDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_object_set_updates_dict.py b/foundry/v1/models/_object_set_updates_dict.py deleted file mode 100644 index 46b9d537..00000000 --- a/foundry/v1/models/_object_set_updates_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._object_set_update_dict import ObjectSetUpdateDict -from foundry.v1.models._subscription_id import SubscriptionId - - -class ObjectSetUpdatesDict(TypedDict): - """ObjectSetUpdates""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - id: SubscriptionId - - updates: List[ObjectSetUpdateDict] - - type: Literal["objectSetChanged"] diff --git a/foundry/v1/models/_object_state.py b/foundry/v1/models/_object_state.py deleted file mode 100644 index 3f5d4340..00000000 --- a/foundry/v1/models/_object_state.py +++ /dev/null @@ -1,26 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -ObjectState = Literal["ADDED_OR_UPDATED", "REMOVED"] -""" -Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was -added to the set or the object has updated and was previously in the set. REMOVED indicates that the object -was removed from the set due to the object being deleted or the object no longer meets the object set -definition. -""" diff --git a/foundry/v1/models/_object_type.py b/foundry/v1/models/_object_type.py deleted file mode 100644 index 90acb664..00000000 --- a/foundry/v1/models/_object_type.py +++ /dev/null @@ -1,63 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._object_type_dict import ObjectTypeDict -from foundry.v1.models._object_type_rid import ObjectTypeRid -from foundry.v1.models._object_type_visibility import ObjectTypeVisibility -from foundry.v1.models._property import Property -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._release_status import ReleaseStatus - - -class ObjectType(BaseModel): - """Represents an object type in the Ontology.""" - - api_name: ObjectTypeApiName = Field(alias="apiName") - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - status: ReleaseStatus - - description: Optional[StrictStr] = None - """The description of the object type.""" - - visibility: Optional[ObjectTypeVisibility] = None - - primary_key: List[PropertyApiName] = Field(alias="primaryKey") - """The primary key of the object. This is a list of properties that can be used to uniquely identify the object.""" - - properties: Dict[PropertyApiName, Property] - """A map of the properties of the object type.""" - - rid: ObjectTypeRid - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_object_type_dict.py b/foundry/v1/models/_object_type_dict.py deleted file mode 100644 index aa7957be..00000000 --- a/foundry/v1/models/_object_type_dict.py +++ /dev/null @@ -1,56 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._object_type_rid import ObjectTypeRid -from foundry.v1.models._object_type_visibility import ObjectTypeVisibility -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_dict import PropertyDict -from foundry.v1.models._release_status import ReleaseStatus - - -class ObjectTypeDict(TypedDict): - """Represents an object type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ObjectTypeApiName - - displayName: NotRequired[DisplayName] - - status: ReleaseStatus - - description: NotRequired[StrictStr] - """The description of the object type.""" - - visibility: NotRequired[ObjectTypeVisibility] - - primaryKey: List[PropertyApiName] - """The primary key of the object. This is a list of properties that can be used to uniquely identify the object.""" - - properties: Dict[PropertyApiName, PropertyDict] - """A map of the properties of the object type.""" - - rid: ObjectTypeRid diff --git a/foundry/v1/models/_object_type_edits.py b/foundry/v1/models/_object_type_edits.py deleted file mode 100644 index 64222fcf..00000000 --- a/foundry/v1/models/_object_type_edits.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._object_type_edits_dict import ObjectTypeEditsDict - - -class ObjectTypeEdits(BaseModel): - """ObjectTypeEdits""" - - edited_object_types: List[ObjectTypeApiName] = Field(alias="editedObjectTypes") - - type: Literal["largeScaleEdits"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectTypeEditsDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectTypeEditsDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_object_type_edits_dict.py b/foundry/v1/models/_object_type_edits_dict.py deleted file mode 100644 index f6d3e0ca..00000000 --- a/foundry/v1/models/_object_type_edits_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class ObjectTypeEditsDict(TypedDict): - """ObjectTypeEdits""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - editedObjectTypes: List[ObjectTypeApiName] - - type: Literal["largeScaleEdits"] diff --git a/foundry/v1/models/_object_type_full_metadata.py b/foundry/v1/models/_object_type_full_metadata.py deleted file mode 100644 index 3deec6fc..00000000 --- a/foundry/v1/models/_object_type_full_metadata.py +++ /dev/null @@ -1,63 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v1.models._link_type_side_v2 import LinkTypeSideV2 -from foundry.v1.models._object_type_full_metadata_dict import ObjectTypeFullMetadataDict -from foundry.v1.models._object_type_interface_implementation import ( - ObjectTypeInterfaceImplementation, -) # NOQA -from foundry.v1.models._object_type_v2 import ObjectTypeV2 -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class ObjectTypeFullMetadata(BaseModel): - """ObjectTypeFullMetadata""" - - object_type: ObjectTypeV2 = Field(alias="objectType") - - link_types: List[LinkTypeSideV2] = Field(alias="linkTypes") - - implements_interfaces: List[InterfaceTypeApiName] = Field(alias="implementsInterfaces") - """A list of interfaces that this object type implements.""" - - implements_interfaces2: Dict[InterfaceTypeApiName, ObjectTypeInterfaceImplementation] = Field( - alias="implementsInterfaces2" - ) - """A list of interfaces that this object type implements and how it implements them.""" - - shared_property_type_mapping: Dict[SharedPropertyTypeApiName, PropertyApiName] = Field( - alias="sharedPropertyTypeMapping" - ) - """ - A map from shared property type API name to backing local property API name for the shared property types - present on this object type. - """ - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectTypeFullMetadataDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectTypeFullMetadataDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_object_type_full_metadata_dict.py b/foundry/v1/models/_object_type_full_metadata_dict.py deleted file mode 100644 index c54fe320..00000000 --- a/foundry/v1/models/_object_type_full_metadata_dict.py +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v1.models._link_type_side_v2_dict import LinkTypeSideV2Dict -from foundry.v1.models._object_type_interface_implementation_dict import ( - ObjectTypeInterfaceImplementationDict, -) # NOQA -from foundry.v1.models._object_type_v2_dict import ObjectTypeV2Dict -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class ObjectTypeFullMetadataDict(TypedDict): - """ObjectTypeFullMetadata""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectType: ObjectTypeV2Dict - - linkTypes: List[LinkTypeSideV2Dict] - - implementsInterfaces: List[InterfaceTypeApiName] - """A list of interfaces that this object type implements.""" - - implementsInterfaces2: Dict[InterfaceTypeApiName, ObjectTypeInterfaceImplementationDict] - """A list of interfaces that this object type implements and how it implements them.""" - - sharedPropertyTypeMapping: Dict[SharedPropertyTypeApiName, PropertyApiName] - """ - A map from shared property type API name to backing local property API name for the shared property types - present on this object type. - """ diff --git a/foundry/v1/models/_object_type_interface_implementation.py b/foundry/v1/models/_object_type_interface_implementation.py deleted file mode 100644 index 1a665f0b..00000000 --- a/foundry/v1/models/_object_type_interface_implementation.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._object_type_interface_implementation_dict import ( - ObjectTypeInterfaceImplementationDict, -) # NOQA -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class ObjectTypeInterfaceImplementation(BaseModel): - """ObjectTypeInterfaceImplementation""" - - properties: Dict[SharedPropertyTypeApiName, PropertyApiName] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectTypeInterfaceImplementationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectTypeInterfaceImplementationDict, - self.model_dump(by_alias=True, exclude_unset=True), - ) diff --git a/foundry/v1/models/_object_type_interface_implementation_dict.py b/foundry/v1/models/_object_type_interface_implementation_dict.py deleted file mode 100644 index c344a233..00000000 --- a/foundry/v1/models/_object_type_interface_implementation_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict - -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class ObjectTypeInterfaceImplementationDict(TypedDict): - """ObjectTypeInterfaceImplementation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - properties: Dict[SharedPropertyTypeApiName, PropertyApiName] diff --git a/foundry/v1/models/_object_type_v2.py b/foundry/v1/models/_object_type_v2.py deleted file mode 100644 index 0fa00376..00000000 --- a/foundry/v1/models/_object_type_v2.py +++ /dev/null @@ -1,69 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._icon import Icon -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._object_type_rid import ObjectTypeRid -from foundry.v1.models._object_type_v2_dict import ObjectTypeV2Dict -from foundry.v1.models._object_type_visibility import ObjectTypeVisibility -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_v2 import PropertyV2 -from foundry.v1.models._release_status import ReleaseStatus - - -class ObjectTypeV2(BaseModel): - """Represents an object type in the Ontology.""" - - api_name: ObjectTypeApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - status: ReleaseStatus - - description: Optional[StrictStr] = None - """The description of the object type.""" - - plural_display_name: StrictStr = Field(alias="pluralDisplayName") - """The plural display name of the object type.""" - - icon: Icon - - primary_key: PropertyApiName = Field(alias="primaryKey") - - properties: Dict[PropertyApiName, PropertyV2] - """A map of the properties of the object type.""" - - rid: ObjectTypeRid - - title_property: PropertyApiName = Field(alias="titleProperty") - - visibility: Optional[ObjectTypeVisibility] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectTypeV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectTypeV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_object_type_v2_dict.py b/foundry/v1/models/_object_type_v2_dict.py deleted file mode 100644 index 05931a19..00000000 --- a/foundry/v1/models/_object_type_v2_dict.py +++ /dev/null @@ -1,62 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._icon_dict import IconDict -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._object_type_rid import ObjectTypeRid -from foundry.v1.models._object_type_visibility import ObjectTypeVisibility -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_v2_dict import PropertyV2Dict -from foundry.v1.models._release_status import ReleaseStatus - - -class ObjectTypeV2Dict(TypedDict): - """Represents an object type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ObjectTypeApiName - - displayName: DisplayName - - status: ReleaseStatus - - description: NotRequired[StrictStr] - """The description of the object type.""" - - pluralDisplayName: StrictStr - """The plural display name of the object type.""" - - icon: IconDict - - primaryKey: PropertyApiName - - properties: Dict[PropertyApiName, PropertyV2Dict] - """A map of the properties of the object type.""" - - rid: ObjectTypeRid - - titleProperty: PropertyApiName - - visibility: NotRequired[ObjectTypeVisibility] diff --git a/foundry/v1/models/_object_update.py b/foundry/v1/models/_object_update.py deleted file mode 100644 index 4b4a6dfe..00000000 --- a/foundry/v1/models/_object_update.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._object_state import ObjectState -from foundry.v1.models._object_update_dict import ObjectUpdateDict -from foundry.v1.models._ontology_object_v2 import OntologyObjectV2 - - -class ObjectUpdate(BaseModel): - """ObjectUpdate""" - - object: OntologyObjectV2 - - state: ObjectState - - type: Literal["object"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectUpdateDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectUpdateDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_object_update_dict.py b/foundry/v1/models/_object_update_dict.py deleted file mode 100644 index d2e07666..00000000 --- a/foundry/v1/models/_object_update_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._object_state import ObjectState -from foundry.v1.models._ontology_object_v2 import OntologyObjectV2 - - -class ObjectUpdateDict(TypedDict): - """ObjectUpdate""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - object: OntologyObjectV2 - - state: ObjectState - - type: Literal["object"] diff --git a/foundry/v1/models/_one_of_constraint.py b/foundry/v1/models/_one_of_constraint.py deleted file mode 100644 index ec7a4558..00000000 --- a/foundry/v1/models/_one_of_constraint.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool - -from foundry.v1.models._one_of_constraint_dict import OneOfConstraintDict -from foundry.v1.models._parameter_option import ParameterOption - - -class OneOfConstraint(BaseModel): - """The parameter has a manually predefined set of options.""" - - options: List[ParameterOption] - - other_values_allowed: StrictBool = Field(alias="otherValuesAllowed") - """A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**.""" - - type: Literal["oneOf"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OneOfConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OneOfConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_one_of_constraint_dict.py b/foundry/v1/models/_one_of_constraint_dict.py deleted file mode 100644 index f81e19e9..00000000 --- a/foundry/v1/models/_one_of_constraint_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from pydantic import StrictBool -from typing_extensions import TypedDict - -from foundry.v1.models._parameter_option_dict import ParameterOptionDict - - -class OneOfConstraintDict(TypedDict): - """The parameter has a manually predefined set of options.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - options: List[ParameterOptionDict] - - otherValuesAllowed: StrictBool - """A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**.""" - - type: Literal["oneOf"] diff --git a/foundry/v1/models/_ontology.py b/foundry/v1/models/_ontology.py deleted file mode 100644 index 90c6f8f5..00000000 --- a/foundry/v1/models/_ontology.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._ontology_api_name import OntologyApiName -from foundry.v1.models._ontology_dict import OntologyDict -from foundry.v1.models._ontology_rid import OntologyRid - - -class Ontology(BaseModel): - """Metadata about an Ontology.""" - - api_name: OntologyApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - description: StrictStr - - rid: OntologyRid - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_ontology_data_type.py b/foundry/v1/models/_ontology_data_type.py deleted file mode 100644 index e9521f49..00000000 --- a/foundry/v1/models/_ontology_data_type.py +++ /dev/null @@ -1,153 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool - -from foundry.v1.models._any_type import AnyType -from foundry.v1.models._binary_type import BinaryType -from foundry.v1.models._boolean_type import BooleanType -from foundry.v1.models._byte_type import ByteType -from foundry.v1.models._date_type import DateType -from foundry.v1.models._decimal_type import DecimalType -from foundry.v1.models._double_type import DoubleType -from foundry.v1.models._float_type import FloatType -from foundry.v1.models._integer_type import IntegerType -from foundry.v1.models._long_type import LongType -from foundry.v1.models._marking_type import MarkingType -from foundry.v1.models._ontology_data_type_dict import OntologyArrayTypeDict -from foundry.v1.models._ontology_data_type_dict import OntologyMapTypeDict -from foundry.v1.models._ontology_data_type_dict import OntologySetTypeDict -from foundry.v1.models._ontology_data_type_dict import OntologyStructFieldDict -from foundry.v1.models._ontology_data_type_dict import OntologyStructTypeDict -from foundry.v1.models._ontology_object_set_type import OntologyObjectSetType -from foundry.v1.models._ontology_object_type import OntologyObjectType -from foundry.v1.models._short_type import ShortType -from foundry.v1.models._string_type import StringType -from foundry.v1.models._struct_field_name import StructFieldName -from foundry.v1.models._timestamp_type import TimestampType -from foundry.v1.models._unsupported_type import UnsupportedType - - -class OntologyArrayType(BaseModel): - """OntologyArrayType""" - - item_type: OntologyDataType = Field(alias="itemType") - - type: Literal["array"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyArrayTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class OntologyMapType(BaseModel): - """OntologyMapType""" - - key_type: OntologyDataType = Field(alias="keyType") - - value_type: OntologyDataType = Field(alias="valueType") - - type: Literal["map"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyMapTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyMapTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class OntologySetType(BaseModel): - """OntologySetType""" - - item_type: OntologyDataType = Field(alias="itemType") - - type: Literal["set"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologySetTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologySetTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class OntologyStructField(BaseModel): - """OntologyStructField""" - - name: StructFieldName - - field_type: OntologyDataType = Field(alias="fieldType") - - required: StrictBool - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyStructFieldDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyStructFieldDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class OntologyStructType(BaseModel): - """OntologyStructType""" - - fields: List[OntologyStructField] - - type: Literal["struct"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyStructTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyStructTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -OntologyDataType = Annotated[ - Union[ - AnyType, - BinaryType, - BooleanType, - ByteType, - DateType, - DecimalType, - DoubleType, - FloatType, - IntegerType, - LongType, - MarkingType, - ShortType, - StringType, - TimestampType, - OntologyArrayType, - OntologyMapType, - OntologySetType, - OntologyStructType, - OntologyObjectType, - OntologyObjectSetType, - UnsupportedType, - ], - Field(discriminator="type"), -] -"""A union of all the primitive types used by Palantir's Ontology-based products.""" diff --git a/foundry/v1/models/_ontology_data_type_dict.py b/foundry/v1/models/_ontology_data_type_dict.py deleted file mode 100644 index 09a9c19c..00000000 --- a/foundry/v1/models/_ontology_data_type_dict.py +++ /dev/null @@ -1,127 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union - -from pydantic import Field -from pydantic import StrictBool -from typing_extensions import TypedDict - -from foundry.v1.models._any_type_dict import AnyTypeDict -from foundry.v1.models._binary_type_dict import BinaryTypeDict -from foundry.v1.models._boolean_type_dict import BooleanTypeDict -from foundry.v1.models._byte_type_dict import ByteTypeDict -from foundry.v1.models._date_type_dict import DateTypeDict -from foundry.v1.models._decimal_type_dict import DecimalTypeDict -from foundry.v1.models._double_type_dict import DoubleTypeDict -from foundry.v1.models._float_type_dict import FloatTypeDict -from foundry.v1.models._integer_type_dict import IntegerTypeDict -from foundry.v1.models._long_type_dict import LongTypeDict -from foundry.v1.models._marking_type_dict import MarkingTypeDict -from foundry.v1.models._ontology_object_set_type_dict import OntologyObjectSetTypeDict -from foundry.v1.models._ontology_object_type_dict import OntologyObjectTypeDict -from foundry.v1.models._short_type_dict import ShortTypeDict -from foundry.v1.models._string_type_dict import StringTypeDict -from foundry.v1.models._struct_field_name import StructFieldName -from foundry.v1.models._timestamp_type_dict import TimestampTypeDict -from foundry.v1.models._unsupported_type_dict import UnsupportedTypeDict - - -class OntologyArrayTypeDict(TypedDict): - """OntologyArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - itemType: OntologyDataTypeDict - - type: Literal["array"] - - -class OntologyMapTypeDict(TypedDict): - """OntologyMapType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyType: OntologyDataTypeDict - - valueType: OntologyDataTypeDict - - type: Literal["map"] - - -class OntologySetTypeDict(TypedDict): - """OntologySetType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - itemType: OntologyDataTypeDict - - type: Literal["set"] - - -class OntologyStructFieldDict(TypedDict): - """OntologyStructField""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: StructFieldName - - fieldType: OntologyDataTypeDict - - required: StrictBool - - -class OntologyStructTypeDict(TypedDict): - """OntologyStructType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: List[OntologyStructFieldDict] - - type: Literal["struct"] - - -OntologyDataTypeDict = Annotated[ - Union[ - AnyTypeDict, - BinaryTypeDict, - BooleanTypeDict, - ByteTypeDict, - DateTypeDict, - DecimalTypeDict, - DoubleTypeDict, - FloatTypeDict, - IntegerTypeDict, - LongTypeDict, - MarkingTypeDict, - ShortTypeDict, - StringTypeDict, - TimestampTypeDict, - OntologyArrayTypeDict, - OntologyMapTypeDict, - OntologySetTypeDict, - OntologyStructTypeDict, - OntologyObjectTypeDict, - OntologyObjectSetTypeDict, - UnsupportedTypeDict, - ], - Field(discriminator="type"), -] -"""A union of all the primitive types used by Palantir's Ontology-based products.""" diff --git a/foundry/v1/models/_ontology_dict.py b/foundry/v1/models/_ontology_dict.py deleted file mode 100644 index 61d37f3a..00000000 --- a/foundry/v1/models/_ontology_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import TypedDict - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._ontology_api_name import OntologyApiName -from foundry.v1.models._ontology_rid import OntologyRid - - -class OntologyDict(TypedDict): - """Metadata about an Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: OntologyApiName - - displayName: DisplayName - - description: StrictStr - - rid: OntologyRid diff --git a/foundry/v1/models/_ontology_full_metadata.py b/foundry/v1/models/_ontology_full_metadata.py deleted file mode 100644 index c83e048c..00000000 --- a/foundry/v1/models/_ontology_full_metadata.py +++ /dev/null @@ -1,59 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._action_type_api_name import ActionTypeApiName -from foundry.v1.models._action_type_v2 import ActionTypeV2 -from foundry.v1.models._interface_type import InterfaceType -from foundry.v1.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._object_type_full_metadata import ObjectTypeFullMetadata -from foundry.v1.models._ontology_full_metadata_dict import OntologyFullMetadataDict -from foundry.v1.models._ontology_v2 import OntologyV2 -from foundry.v1.models._query_api_name import QueryApiName -from foundry.v1.models._query_type_v2 import QueryTypeV2 -from foundry.v1.models._shared_property_type import SharedPropertyType -from foundry.v1.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class OntologyFullMetadata(BaseModel): - """OntologyFullMetadata""" - - ontology: OntologyV2 - - object_types: Dict[ObjectTypeApiName, ObjectTypeFullMetadata] = Field(alias="objectTypes") - - action_types: Dict[ActionTypeApiName, ActionTypeV2] = Field(alias="actionTypes") - - query_types: Dict[QueryApiName, QueryTypeV2] = Field(alias="queryTypes") - - interface_types: Dict[InterfaceTypeApiName, InterfaceType] = Field(alias="interfaceTypes") - - shared_property_types: Dict[SharedPropertyTypeApiName, SharedPropertyType] = Field( - alias="sharedPropertyTypes" - ) - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyFullMetadataDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyFullMetadataDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_ontology_full_metadata_dict.py b/foundry/v1/models/_ontology_full_metadata_dict.py deleted file mode 100644 index 35081bff..00000000 --- a/foundry/v1/models/_ontology_full_metadata_dict.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict - -from typing_extensions import TypedDict - -from foundry.v1.models._action_type_api_name import ActionTypeApiName -from foundry.v1.models._action_type_v2_dict import ActionTypeV2Dict -from foundry.v1.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v1.models._interface_type_dict import InterfaceTypeDict -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._object_type_full_metadata_dict import ObjectTypeFullMetadataDict -from foundry.v1.models._ontology_v2_dict import OntologyV2Dict -from foundry.v1.models._query_api_name import QueryApiName -from foundry.v1.models._query_type_v2_dict import QueryTypeV2Dict -from foundry.v1.models._shared_property_type_api_name import SharedPropertyTypeApiName -from foundry.v1.models._shared_property_type_dict import SharedPropertyTypeDict - - -class OntologyFullMetadataDict(TypedDict): - """OntologyFullMetadata""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - ontology: OntologyV2Dict - - objectTypes: Dict[ObjectTypeApiName, ObjectTypeFullMetadataDict] - - actionTypes: Dict[ActionTypeApiName, ActionTypeV2Dict] - - queryTypes: Dict[QueryApiName, QueryTypeV2Dict] - - interfaceTypes: Dict[InterfaceTypeApiName, InterfaceTypeDict] - - sharedPropertyTypes: Dict[SharedPropertyTypeApiName, SharedPropertyTypeDict] diff --git a/foundry/v1/models/_ontology_object.py b/foundry/v1/models/_ontology_object.py deleted file mode 100644 index 9e27a737..00000000 --- a/foundry/v1/models/_ontology_object.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._object_rid import ObjectRid -from foundry.v1.models._ontology_object_dict import OntologyObjectDict -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - - -class OntologyObject(BaseModel): - """Represents an object in the Ontology.""" - - properties: Dict[PropertyApiName, Optional[PropertyValue]] - """A map of the property values of the object.""" - - rid: ObjectRid - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyObjectDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyObjectDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_ontology_object_dict.py b/foundry/v1/models/_ontology_object_dict.py deleted file mode 100644 index c5f038ad..00000000 --- a/foundry/v1/models/_ontology_object_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import TypedDict - -from foundry.v1.models._object_rid import ObjectRid -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - - -class OntologyObjectDict(TypedDict): - """Represents an object in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - properties: Dict[PropertyApiName, Optional[PropertyValue]] - """A map of the property values of the object.""" - - rid: ObjectRid diff --git a/foundry/v1/models/_ontology_object_set_type.py b/foundry/v1/models/_ontology_object_set_type.py deleted file mode 100644 index 52cc6c90..00000000 --- a/foundry/v1/models/_ontology_object_set_type.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._ontology_object_set_type_dict import OntologyObjectSetTypeDict - - -class OntologyObjectSetType(BaseModel): - """OntologyObjectSetType""" - - object_api_name: Optional[ObjectTypeApiName] = Field(alias="objectApiName", default=None) - - object_type_api_name: Optional[ObjectTypeApiName] = Field( - alias="objectTypeApiName", default=None - ) - - type: Literal["objectSet"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyObjectSetTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyObjectSetTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_ontology_object_set_type_dict.py b/foundry/v1/models/_ontology_object_set_type_dict.py deleted file mode 100644 index 86a3eac4..00000000 --- a/foundry/v1/models/_ontology_object_set_type_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class OntologyObjectSetTypeDict(TypedDict): - """OntologyObjectSetType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectApiName: NotRequired[ObjectTypeApiName] - - objectTypeApiName: NotRequired[ObjectTypeApiName] - - type: Literal["objectSet"] diff --git a/foundry/v1/models/_ontology_object_type.py b/foundry/v1/models/_ontology_object_type.py deleted file mode 100644 index bb6ba077..00000000 --- a/foundry/v1/models/_ontology_object_type.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._ontology_object_type_dict import OntologyObjectTypeDict - - -class OntologyObjectType(BaseModel): - """OntologyObjectType""" - - object_api_name: ObjectTypeApiName = Field(alias="objectApiName") - - object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") - - type: Literal["object"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyObjectTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyObjectTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_ontology_object_type_dict.py b/foundry/v1/models/_ontology_object_type_dict.py deleted file mode 100644 index 67ad43e8..00000000 --- a/foundry/v1/models/_ontology_object_type_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName - - -class OntologyObjectTypeDict(TypedDict): - """OntologyObjectType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectApiName: ObjectTypeApiName - - objectTypeApiName: ObjectTypeApiName - - type: Literal["object"] diff --git a/foundry/v1/models/_ontology_object_v2.py b/foundry/v1/models/_ontology_object_v2.py deleted file mode 100644 index fdf37aca..00000000 --- a/foundry/v1/models/_ontology_object_v2.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict - -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._property_value import PropertyValue - -OntologyObjectV2 = Dict[PropertyApiName, PropertyValue] -"""Represents an object in the Ontology.""" diff --git a/foundry/v1/models/_ontology_v2.py b/foundry/v1/models/_ontology_v2.py deleted file mode 100644 index 06714532..00000000 --- a/foundry/v1/models/_ontology_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._ontology_api_name import OntologyApiName -from foundry.v1.models._ontology_rid import OntologyRid -from foundry.v1.models._ontology_v2_dict import OntologyV2Dict - - -class OntologyV2(BaseModel): - """Metadata about an Ontology.""" - - api_name: OntologyApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - description: StrictStr - - rid: OntologyRid - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_ontology_v2_dict.py b/foundry/v1/models/_ontology_v2_dict.py deleted file mode 100644 index 9006ec2f..00000000 --- a/foundry/v1/models/_ontology_v2_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import TypedDict - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._ontology_api_name import OntologyApiName -from foundry.v1.models._ontology_rid import OntologyRid - - -class OntologyV2Dict(TypedDict): - """Metadata about an Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: OntologyApiName - - displayName: DisplayName - - description: StrictStr - - rid: OntologyRid diff --git a/foundry/v1/models/_parameter.py b/foundry/v1/models/_parameter.py deleted file mode 100644 index 47612e21..00000000 --- a/foundry/v1/models/_parameter.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool -from pydantic import StrictStr - -from foundry.v1.models._ontology_data_type import OntologyDataType -from foundry.v1.models._parameter_dict import ParameterDict -from foundry.v1.models._value_type import ValueType - - -class Parameter(BaseModel): - """Details about a parameter of an action or query.""" - - description: Optional[StrictStr] = None - - base_type: ValueType = Field(alias="baseType") - - data_type: Optional[OntologyDataType] = Field(alias="dataType", default=None) - - required: StrictBool - - model_config = {"extra": "allow"} - - def to_dict(self) -> ParameterDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ParameterDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_parameter_dict.py b/foundry/v1/models/_parameter_dict.py deleted file mode 100644 index b8f3c773..00000000 --- a/foundry/v1/models/_parameter_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictBool -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._ontology_data_type_dict import OntologyDataTypeDict -from foundry.v1.models._value_type import ValueType - - -class ParameterDict(TypedDict): - """Details about a parameter of an action or query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: NotRequired[StrictStr] - - baseType: ValueType - - dataType: NotRequired[OntologyDataTypeDict] - - required: StrictBool diff --git a/foundry/v1/models/_parameter_evaluated_constraint.py b/foundry/v1/models/_parameter_evaluated_constraint.py deleted file mode 100644 index 1d5564b7..00000000 --- a/foundry/v1/models/_parameter_evaluated_constraint.py +++ /dev/null @@ -1,67 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._array_size_constraint import ArraySizeConstraint -from foundry.v1.models._group_member_constraint import GroupMemberConstraint -from foundry.v1.models._object_property_value_constraint import ( - ObjectPropertyValueConstraint, -) # NOQA -from foundry.v1.models._object_query_result_constraint import ObjectQueryResultConstraint # NOQA -from foundry.v1.models._one_of_constraint import OneOfConstraint -from foundry.v1.models._range_constraint import RangeConstraint -from foundry.v1.models._string_length_constraint import StringLengthConstraint -from foundry.v1.models._string_regex_match_constraint import StringRegexMatchConstraint -from foundry.v1.models._unevaluable_constraint import UnevaluableConstraint - -ParameterEvaluatedConstraint = Annotated[ - Union[ - ArraySizeConstraint, - GroupMemberConstraint, - ObjectPropertyValueConstraint, - ObjectQueryResultConstraint, - OneOfConstraint, - RangeConstraint, - StringLengthConstraint, - StringRegexMatchConstraint, - UnevaluableConstraint, - ], - Field(discriminator="type"), -] -""" -A constraint that an action parameter value must satisfy in order to be considered valid. -Constraints can be configured on action parameters in the **Ontology Manager**. -Applicable constraints are determined dynamically based on parameter inputs. -Parameter values are evaluated against the final set of constraints. - -The type of the constraint. -| Type | Description | -|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | -| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | -| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | -| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | -| `oneOf` | The parameter has a manually predefined set of options. | -| `range` | The parameter value must be within the defined range. | -| `stringLength` | The parameter value must have a length within the defined range. | -| `stringRegexMatch` | The parameter value must match a predefined regular expression. | -| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | -""" diff --git a/foundry/v1/models/_parameter_evaluated_constraint_dict.py b/foundry/v1/models/_parameter_evaluated_constraint_dict.py deleted file mode 100644 index 38a8980f..00000000 --- a/foundry/v1/models/_parameter_evaluated_constraint_dict.py +++ /dev/null @@ -1,71 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._array_size_constraint_dict import ArraySizeConstraintDict -from foundry.v1.models._group_member_constraint_dict import GroupMemberConstraintDict -from foundry.v1.models._object_property_value_constraint_dict import ( - ObjectPropertyValueConstraintDict, -) # NOQA -from foundry.v1.models._object_query_result_constraint_dict import ( - ObjectQueryResultConstraintDict, -) # NOQA -from foundry.v1.models._one_of_constraint_dict import OneOfConstraintDict -from foundry.v1.models._range_constraint_dict import RangeConstraintDict -from foundry.v1.models._string_length_constraint_dict import StringLengthConstraintDict -from foundry.v1.models._string_regex_match_constraint_dict import ( - StringRegexMatchConstraintDict, -) # NOQA -from foundry.v1.models._unevaluable_constraint_dict import UnevaluableConstraintDict - -ParameterEvaluatedConstraintDict = Annotated[ - Union[ - ArraySizeConstraintDict, - GroupMemberConstraintDict, - ObjectPropertyValueConstraintDict, - ObjectQueryResultConstraintDict, - OneOfConstraintDict, - RangeConstraintDict, - StringLengthConstraintDict, - StringRegexMatchConstraintDict, - UnevaluableConstraintDict, - ], - Field(discriminator="type"), -] -""" -A constraint that an action parameter value must satisfy in order to be considered valid. -Constraints can be configured on action parameters in the **Ontology Manager**. -Applicable constraints are determined dynamically based on parameter inputs. -Parameter values are evaluated against the final set of constraints. - -The type of the constraint. -| Type | Description | -|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | -| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | -| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | -| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | -| `oneOf` | The parameter has a manually predefined set of options. | -| `range` | The parameter value must be within the defined range. | -| `stringLength` | The parameter value must have a length within the defined range. | -| `stringRegexMatch` | The parameter value must match a predefined regular expression. | -| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | -""" diff --git a/foundry/v1/models/_parameter_evaluation_result.py b/foundry/v1/models/_parameter_evaluation_result.py deleted file mode 100644 index 47cad53b..00000000 --- a/foundry/v1/models/_parameter_evaluation_result.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool - -from foundry.v1.models._parameter_evaluated_constraint import ParameterEvaluatedConstraint # NOQA -from foundry.v1.models._parameter_evaluation_result_dict import ( - ParameterEvaluationResultDict, -) # NOQA -from foundry.v1.models._validation_result import ValidationResult - - -class ParameterEvaluationResult(BaseModel): - """Represents the validity of a parameter against the configured constraints.""" - - result: ValidationResult - - evaluated_constraints: List[ParameterEvaluatedConstraint] = Field(alias="evaluatedConstraints") - - required: StrictBool - """Represents whether the parameter is a required input to the action.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ParameterEvaluationResultDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ParameterEvaluationResultDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_parameter_evaluation_result_dict.py b/foundry/v1/models/_parameter_evaluation_result_dict.py deleted file mode 100644 index 2dffb502..00000000 --- a/foundry/v1/models/_parameter_evaluation_result_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from pydantic import StrictBool -from typing_extensions import TypedDict - -from foundry.v1.models._parameter_evaluated_constraint_dict import ( - ParameterEvaluatedConstraintDict, -) # NOQA -from foundry.v1.models._validation_result import ValidationResult - - -class ParameterEvaluationResultDict(TypedDict): - """Represents the validity of a parameter against the configured constraints.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - result: ValidationResult - - evaluatedConstraints: List[ParameterEvaluatedConstraintDict] - - required: StrictBool - """Represents whether the parameter is a required input to the action.""" diff --git a/foundry/v1/models/_parameter_option.py b/foundry/v1/models/_parameter_option.py deleted file mode 100644 index 739e1d91..00000000 --- a/foundry/v1/models/_parameter_option.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._parameter_option_dict import ParameterOptionDict - - -class ParameterOption(BaseModel): - """A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.""" - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - value: Optional[Any] = None - """An allowed configured value for a parameter within an action.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ParameterOptionDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ParameterOptionDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_parameter_option_dict.py b/foundry/v1/models/_parameter_option_dict.py deleted file mode 100644 index fe986f43..00000000 --- a/foundry/v1/models/_parameter_option_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._display_name import DisplayName - - -class ParameterOptionDict(TypedDict): - """A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - displayName: NotRequired[DisplayName] - - value: NotRequired[Any] - """An allowed configured value for a parameter within an action.""" diff --git a/foundry/v1/models/_phrase_query.py b/foundry/v1/models/_phrase_query.py deleted file mode 100644 index f6a985ff..00000000 --- a/foundry/v1/models/_phrase_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._phrase_query_dict import PhraseQueryDict - - -class PhraseQuery(BaseModel): - """Returns objects where the specified field contains the provided value as a substring.""" - - field: FieldNameV1 - - value: StrictStr - - type: Literal["phrase"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> PhraseQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(PhraseQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_phrase_query_dict.py b/foundry/v1/models/_phrase_query_dict.py deleted file mode 100644 index 68c05b66..00000000 --- a/foundry/v1/models/_phrase_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import TypedDict - -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class PhraseQueryDict(TypedDict): - """Returns objects where the specified field contains the provided value as a substring.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: StrictStr - - type: Literal["phrase"] diff --git a/foundry/v1/models/_polygon.py b/foundry/v1/models/_polygon.py deleted file mode 100644 index 3113e70e..00000000 --- a/foundry/v1/models/_polygon.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._linear_ring import LinearRing -from foundry.v1.models._polygon_dict import PolygonDict - - -class Polygon(BaseModel): - """Polygon""" - - coordinates: List[LinearRing] - - bbox: Optional[BBox] = None - - type: Literal["Polygon"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> PolygonDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(PolygonDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_polygon_dict.py b/foundry/v1/models/_polygon_dict.py deleted file mode 100644 index 2a2f3b21..00000000 --- a/foundry/v1/models/_polygon_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._b_box import BBox -from foundry.v1.models._linear_ring import LinearRing - - -class PolygonDict(TypedDict): - """Polygon""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: List[LinearRing] - - bbox: NotRequired[BBox] - - type: Literal["Polygon"] diff --git a/foundry/v1/models/_polygon_value.py b/foundry/v1/models/_polygon_value.py deleted file mode 100644 index fdc82ed3..00000000 --- a/foundry/v1/models/_polygon_value.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v1.models._polygon import Polygon - -PolygonValue = Polygon -"""PolygonValue""" diff --git a/foundry/v1/models/_polygon_value_dict.py b/foundry/v1/models/_polygon_value_dict.py deleted file mode 100644 index 51b82fb9..00000000 --- a/foundry/v1/models/_polygon_value_dict.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v1.models._polygon_dict import PolygonDict - -PolygonValueDict = PolygonDict -"""PolygonValue""" diff --git a/foundry/v1/models/_position.py b/foundry/v1/models/_position.py deleted file mode 100644 index 33487b5a..00000000 --- a/foundry/v1/models/_position.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from foundry.v1.models._coordinate import Coordinate - -Position = List[Coordinate] -""" -GeoJSon fundamental geometry construct. - -A position is an array of numbers. There MUST be two or more elements. -The first two elements are longitude and latitude, precisely in that order and using decimal numbers. -Altitude or elevation MAY be included as an optional third element. - -Implementations SHOULD NOT extend positions beyond three elements -because the semantics of extra elements are unspecified and ambiguous. -Historically, some implementations have used a fourth element to carry -a linear referencing measure (sometimes denoted as "M") or a numerical -timestamp, but in most situations a parser will not be able to properly -interpret these values. The interpretation and meaning of additional -elements is beyond the scope of this specification, and additional -elements MAY be ignored by parsers. -""" diff --git a/foundry/v1/models/_prefix_query.py b/foundry/v1/models/_prefix_query.py deleted file mode 100644 index ececc955..00000000 --- a/foundry/v1/models/_prefix_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._prefix_query_dict import PrefixQueryDict - - -class PrefixQuery(BaseModel): - """Returns objects where the specified field starts with the provided value.""" - - field: FieldNameV1 - - value: StrictStr - - type: Literal["prefix"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> PrefixQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(PrefixQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_prefix_query_dict.py b/foundry/v1/models/_prefix_query_dict.py deleted file mode 100644 index 80f5598b..00000000 --- a/foundry/v1/models/_prefix_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import TypedDict - -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class PrefixQueryDict(TypedDict): - """Returns objects where the specified field starts with the provided value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: StrictStr - - type: Literal["prefix"] diff --git a/foundry/v1/models/_primary_key_value.py b/foundry/v1/models/_primary_key_value.py deleted file mode 100644 index 2afd2acb..00000000 --- a/foundry/v1/models/_primary_key_value.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any - -PrimaryKeyValue = Any -"""Represents the primary key value that is used as a unique identifier for an object.""" diff --git a/foundry/v1/models/_property.py b/foundry/v1/models/_property.py deleted file mode 100644 index a75ef962..00000000 --- a/foundry/v1/models/_property.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._property_dict import PropertyDict -from foundry.v1.models._value_type import ValueType - - -class Property(BaseModel): - """Details about some property of an object.""" - - description: Optional[StrictStr] = None - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - base_type: ValueType = Field(alias="baseType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> PropertyDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(PropertyDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_property_dict.py b/foundry/v1/models/_property_dict.py deleted file mode 100644 index ef8ca310..00000000 --- a/foundry/v1/models/_property_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._value_type import ValueType - - -class PropertyDict(TypedDict): - """Details about some property of an object.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: NotRequired[StrictStr] - - displayName: NotRequired[DisplayName] - - baseType: ValueType diff --git a/foundry/v1/models/_property_filter.py b/foundry/v1/models/_property_filter.py deleted file mode 100644 index 37e776de..00000000 --- a/foundry/v1/models/_property_filter.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -PropertyFilter = StrictStr -""" -Represents a filter used on properties. - -Endpoints that accept this supports optional parameters that have the form: -`properties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString}` to filter the returned objects. -For instance, you may use `properties.firstName.eq=John` to find objects that contain a property called -"firstName" that has the exact value of "John". - -The following are a list of supported property filters: - -- `properties.{propertyApiName}.contains` - supported on arrays and can be used to filter array properties - that have at least one of the provided values. If multiple query parameters are provided, then objects - that have any of the given values for the specified property will be matched. -- `properties.{propertyApiName}.eq` - used to filter objects that have the exact value for the provided - property. If multiple query parameters are provided, then objects that have any of the given values - will be matched. For instance, if the user provides a request by doing - `?properties.firstName.eq=John&properties.firstName.eq=Anna`, then objects that have a firstName property - of either John or Anna will be matched. This filter is supported on all property types except Arrays. -- `properties.{propertyApiName}.neq` - used to filter objects that do not have the provided property values. - Similar to the `eq` filter, if multiple values are provided, then objects that have any of the given values - will be excluded from the result. -- `properties.{propertyApiName}.lt`, `properties.{propertyApiName}.lte`, `properties.{propertyApiName}.gt` - `properties.{propertyApiName}.gte` - represent less than, less than or equal to, greater than, and greater - than or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal. -- `properties.{propertyApiName}.isNull` - used to filter objects where the provided property is (or is not) null. - This filter is supported on all property types. -""" diff --git a/foundry/v1/models/_property_id.py b/foundry/v1/models/_property_id.py deleted file mode 100644 index d2eef827..00000000 --- a/foundry/v1/models/_property_id.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -PropertyId = StrictStr -""" -The immutable ID of a property. Property IDs are only used to identify properties in the **Ontology Manager** -application and assign them API names. In every other case, API names should be used instead of property IDs. -""" diff --git a/foundry/v1/models/_property_v2.py b/foundry/v1/models/_property_v2.py deleted file mode 100644 index 3e0ed1ea..00000000 --- a/foundry/v1/models/_property_v2.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._object_property_type import ObjectPropertyType -from foundry.v1.models._property_v2_dict import PropertyV2Dict - - -class PropertyV2(BaseModel): - """Details about some property of an object.""" - - description: Optional[StrictStr] = None - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - data_type: ObjectPropertyType = Field(alias="dataType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> PropertyV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(PropertyV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_property_v2_dict.py b/foundry/v1/models/_property_v2_dict.py deleted file mode 100644 index ba0c4563..00000000 --- a/foundry/v1/models/_property_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._object_property_type_dict import ObjectPropertyTypeDict - - -class PropertyV2Dict(TypedDict): - """Details about some property of an object.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: NotRequired[StrictStr] - - displayName: NotRequired[DisplayName] - - dataType: ObjectPropertyTypeDict diff --git a/foundry/v1/models/_qos_error.py b/foundry/v1/models/_qos_error.py deleted file mode 100644 index 69f08063..00000000 --- a/foundry/v1/models/_qos_error.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._qos_error_dict import QosErrorDict - - -class QosError(BaseModel): - """An error indicating that the subscribe request should be attempted on a different node.""" - - type: Literal["qos"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QosErrorDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QosErrorDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_qos_error_dict.py b/foundry/v1/models/_qos_error_dict.py deleted file mode 100644 index 36ae0c72..00000000 --- a/foundry/v1/models/_qos_error_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - - -class QosErrorDict(TypedDict): - """An error indicating that the subscribe request should be attempted on a different node.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: Literal["qos"] diff --git a/foundry/v1/models/_query_aggregation.py b/foundry/v1/models/_query_aggregation.py deleted file mode 100644 index a3155af3..00000000 --- a/foundry/v1/models/_query_aggregation.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._query_aggregation_dict import QueryAggregationDict - - -class QueryAggregation(BaseModel): - """QueryAggregation""" - - key: Any - - value: Any - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryAggregationDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_query_aggregation_dict.py b/foundry/v1/models/_query_aggregation_dict.py deleted file mode 100644 index 53ddcfeb..00000000 --- a/foundry/v1/models/_query_aggregation_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any - -from typing_extensions import TypedDict - - -class QueryAggregationDict(TypedDict): - """QueryAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - key: Any - - value: Any diff --git a/foundry/v1/models/_query_aggregation_key_type.py b/foundry/v1/models/_query_aggregation_key_type.py deleted file mode 100644 index ab2adb4e..00000000 --- a/foundry/v1/models/_query_aggregation_key_type.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._boolean_type import BooleanType -from foundry.v1.models._date_type import DateType -from foundry.v1.models._double_type import DoubleType -from foundry.v1.models._integer_type import IntegerType -from foundry.v1.models._query_aggregation_range_type import QueryAggregationRangeType -from foundry.v1.models._string_type import StringType -from foundry.v1.models._timestamp_type import TimestampType - -QueryAggregationKeyType = Annotated[ - Union[ - BooleanType, - DateType, - DoubleType, - IntegerType, - StringType, - TimestampType, - QueryAggregationRangeType, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by query aggregation keys.""" diff --git a/foundry/v1/models/_query_aggregation_key_type_dict.py b/foundry/v1/models/_query_aggregation_key_type_dict.py deleted file mode 100644 index dd7cabcc..00000000 --- a/foundry/v1/models/_query_aggregation_key_type_dict.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._boolean_type_dict import BooleanTypeDict -from foundry.v1.models._date_type_dict import DateTypeDict -from foundry.v1.models._double_type_dict import DoubleTypeDict -from foundry.v1.models._integer_type_dict import IntegerTypeDict -from foundry.v1.models._query_aggregation_range_type_dict import ( - QueryAggregationRangeTypeDict, -) # NOQA -from foundry.v1.models._string_type_dict import StringTypeDict -from foundry.v1.models._timestamp_type_dict import TimestampTypeDict - -QueryAggregationKeyTypeDict = Annotated[ - Union[ - BooleanTypeDict, - DateTypeDict, - DoubleTypeDict, - IntegerTypeDict, - StringTypeDict, - TimestampTypeDict, - QueryAggregationRangeTypeDict, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by query aggregation keys.""" diff --git a/foundry/v1/models/_query_aggregation_range.py b/foundry/v1/models/_query_aggregation_range.py deleted file mode 100644 index 41324638..00000000 --- a/foundry/v1/models/_query_aggregation_range.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._query_aggregation_range_dict import QueryAggregationRangeDict - - -class QueryAggregationRange(BaseModel): - """Specifies a range from an inclusive start value to an exclusive end value.""" - - start_value: Optional[Any] = Field(alias="startValue", default=None) - """Inclusive start.""" - - end_value: Optional[Any] = Field(alias="endValue", default=None) - """Exclusive end.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryAggregationRangeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryAggregationRangeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_query_aggregation_range_dict.py b/foundry/v1/models/_query_aggregation_range_dict.py deleted file mode 100644 index 3072f4b7..00000000 --- a/foundry/v1/models/_query_aggregation_range_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - - -class QueryAggregationRangeDict(TypedDict): - """Specifies a range from an inclusive start value to an exclusive end value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - startValue: NotRequired[Any] - """Inclusive start.""" - - endValue: NotRequired[Any] - """Exclusive end.""" diff --git a/foundry/v1/models/_query_aggregation_range_sub_type.py b/foundry/v1/models/_query_aggregation_range_sub_type.py deleted file mode 100644 index f2cda71f..00000000 --- a/foundry/v1/models/_query_aggregation_range_sub_type.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._date_type import DateType -from foundry.v1.models._double_type import DoubleType -from foundry.v1.models._integer_type import IntegerType -from foundry.v1.models._timestamp_type import TimestampType - -QueryAggregationRangeSubType = Annotated[ - Union[DateType, DoubleType, IntegerType, TimestampType], Field(discriminator="type") -] -"""A union of all the types supported by query aggregation ranges.""" diff --git a/foundry/v1/models/_query_aggregation_range_sub_type_dict.py b/foundry/v1/models/_query_aggregation_range_sub_type_dict.py deleted file mode 100644 index 5e193e49..00000000 --- a/foundry/v1/models/_query_aggregation_range_sub_type_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._date_type_dict import DateTypeDict -from foundry.v1.models._double_type_dict import DoubleTypeDict -from foundry.v1.models._integer_type_dict import IntegerTypeDict -from foundry.v1.models._timestamp_type_dict import TimestampTypeDict - -QueryAggregationRangeSubTypeDict = Annotated[ - Union[DateTypeDict, DoubleTypeDict, IntegerTypeDict, TimestampTypeDict], - Field(discriminator="type"), -] -"""A union of all the types supported by query aggregation ranges.""" diff --git a/foundry/v1/models/_query_aggregation_range_type.py b/foundry/v1/models/_query_aggregation_range_type.py deleted file mode 100644 index 9492be30..00000000 --- a/foundry/v1/models/_query_aggregation_range_type.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._query_aggregation_range_sub_type import QueryAggregationRangeSubType # NOQA -from foundry.v1.models._query_aggregation_range_type_dict import ( - QueryAggregationRangeTypeDict, -) # NOQA - - -class QueryAggregationRangeType(BaseModel): - """QueryAggregationRangeType""" - - sub_type: QueryAggregationRangeSubType = Field(alias="subType") - - type: Literal["range"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryAggregationRangeTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - QueryAggregationRangeTypeDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_query_aggregation_range_type_dict.py b/foundry/v1/models/_query_aggregation_range_type_dict.py deleted file mode 100644 index 6ac3969d..00000000 --- a/foundry/v1/models/_query_aggregation_range_type_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._query_aggregation_range_sub_type_dict import ( - QueryAggregationRangeSubTypeDict, -) # NOQA - - -class QueryAggregationRangeTypeDict(TypedDict): - """QueryAggregationRangeType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: QueryAggregationRangeSubTypeDict - - type: Literal["range"] diff --git a/foundry/v1/models/_query_aggregation_value_type.py b/foundry/v1/models/_query_aggregation_value_type.py deleted file mode 100644 index 31337cf5..00000000 --- a/foundry/v1/models/_query_aggregation_value_type.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._date_type import DateType -from foundry.v1.models._double_type import DoubleType -from foundry.v1.models._timestamp_type import TimestampType - -QueryAggregationValueType = Annotated[ - Union[DateType, DoubleType, TimestampType], Field(discriminator="type") -] -"""A union of all the types supported by query aggregation keys.""" diff --git a/foundry/v1/models/_query_aggregation_value_type_dict.py b/foundry/v1/models/_query_aggregation_value_type_dict.py deleted file mode 100644 index 1d78cf6e..00000000 --- a/foundry/v1/models/_query_aggregation_value_type_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._date_type_dict import DateTypeDict -from foundry.v1.models._double_type_dict import DoubleTypeDict -from foundry.v1.models._timestamp_type_dict import TimestampTypeDict - -QueryAggregationValueTypeDict = Annotated[ - Union[DateTypeDict, DoubleTypeDict, TimestampTypeDict], Field(discriminator="type") -] -"""A union of all the types supported by query aggregation keys.""" diff --git a/foundry/v1/models/_query_data_type.py b/foundry/v1/models/_query_data_type.py deleted file mode 100644 index 65ee3932..00000000 --- a/foundry/v1/models/_query_data_type.py +++ /dev/null @@ -1,144 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._attachment_type import AttachmentType -from foundry.v1.models._boolean_type import BooleanType -from foundry.v1.models._date_type import DateType -from foundry.v1.models._double_type import DoubleType -from foundry.v1.models._float_type import FloatType -from foundry.v1.models._integer_type import IntegerType -from foundry.v1.models._long_type import LongType -from foundry.v1.models._null_type import NullType -from foundry.v1.models._ontology_object_set_type import OntologyObjectSetType -from foundry.v1.models._ontology_object_type import OntologyObjectType -from foundry.v1.models._query_data_type_dict import QueryArrayTypeDict -from foundry.v1.models._query_data_type_dict import QuerySetTypeDict -from foundry.v1.models._query_data_type_dict import QueryStructFieldDict -from foundry.v1.models._query_data_type_dict import QueryStructTypeDict -from foundry.v1.models._query_data_type_dict import QueryUnionTypeDict -from foundry.v1.models._string_type import StringType -from foundry.v1.models._struct_field_name import StructFieldName -from foundry.v1.models._three_dimensional_aggregation import ThreeDimensionalAggregation -from foundry.v1.models._timestamp_type import TimestampType -from foundry.v1.models._two_dimensional_aggregation import TwoDimensionalAggregation -from foundry.v1.models._unsupported_type import UnsupportedType - - -class QueryArrayType(BaseModel): - """QueryArrayType""" - - sub_type: QueryDataType = Field(alias="subType") - - type: Literal["array"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryArrayTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class QuerySetType(BaseModel): - """QuerySetType""" - - sub_type: QueryDataType = Field(alias="subType") - - type: Literal["set"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QuerySetTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QuerySetTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class QueryStructField(BaseModel): - """QueryStructField""" - - name: StructFieldName - - field_type: QueryDataType = Field(alias="fieldType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryStructFieldDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryStructFieldDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class QueryStructType(BaseModel): - """QueryStructType""" - - fields: List[QueryStructField] - - type: Literal["struct"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryStructTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryStructTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class QueryUnionType(BaseModel): - """QueryUnionType""" - - union_types: List[QueryDataType] = Field(alias="unionTypes") - - type: Literal["union"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryUnionTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryUnionTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -QueryDataType = Annotated[ - Union[ - QueryArrayType, - AttachmentType, - BooleanType, - DateType, - DoubleType, - FloatType, - IntegerType, - LongType, - OntologyObjectSetType, - OntologyObjectType, - QuerySetType, - StringType, - QueryStructType, - ThreeDimensionalAggregation, - TimestampType, - TwoDimensionalAggregation, - QueryUnionType, - NullType, - UnsupportedType, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Query parameters or outputs.""" diff --git a/foundry/v1/models/_query_data_type_dict.py b/foundry/v1/models/_query_data_type_dict.py deleted file mode 100644 index 0c937b72..00000000 --- a/foundry/v1/models/_query_data_type_dict.py +++ /dev/null @@ -1,122 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import TypedDict - -from foundry.v1.models._attachment_type_dict import AttachmentTypeDict -from foundry.v1.models._boolean_type_dict import BooleanTypeDict -from foundry.v1.models._date_type_dict import DateTypeDict -from foundry.v1.models._double_type_dict import DoubleTypeDict -from foundry.v1.models._float_type_dict import FloatTypeDict -from foundry.v1.models._integer_type_dict import IntegerTypeDict -from foundry.v1.models._long_type_dict import LongTypeDict -from foundry.v1.models._null_type_dict import NullTypeDict -from foundry.v1.models._ontology_object_set_type_dict import OntologyObjectSetTypeDict -from foundry.v1.models._ontology_object_type_dict import OntologyObjectTypeDict -from foundry.v1.models._string_type_dict import StringTypeDict -from foundry.v1.models._struct_field_name import StructFieldName -from foundry.v1.models._three_dimensional_aggregation_dict import ( - ThreeDimensionalAggregationDict, -) # NOQA -from foundry.v1.models._timestamp_type_dict import TimestampTypeDict -from foundry.v1.models._two_dimensional_aggregation_dict import ( - TwoDimensionalAggregationDict, -) # NOQA -from foundry.v1.models._unsupported_type_dict import UnsupportedTypeDict - - -class QueryArrayTypeDict(TypedDict): - """QueryArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: QueryDataTypeDict - - type: Literal["array"] - - -class QuerySetTypeDict(TypedDict): - """QuerySetType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: QueryDataTypeDict - - type: Literal["set"] - - -class QueryStructFieldDict(TypedDict): - """QueryStructField""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: StructFieldName - - fieldType: QueryDataTypeDict - - -class QueryStructTypeDict(TypedDict): - """QueryStructType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: List[QueryStructFieldDict] - - type: Literal["struct"] - - -class QueryUnionTypeDict(TypedDict): - """QueryUnionType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - unionTypes: List[QueryDataTypeDict] - - type: Literal["union"] - - -QueryDataTypeDict = Annotated[ - Union[ - QueryArrayTypeDict, - AttachmentTypeDict, - BooleanTypeDict, - DateTypeDict, - DoubleTypeDict, - FloatTypeDict, - IntegerTypeDict, - LongTypeDict, - OntologyObjectSetTypeDict, - OntologyObjectTypeDict, - QuerySetTypeDict, - StringTypeDict, - QueryStructTypeDict, - ThreeDimensionalAggregationDict, - TimestampTypeDict, - TwoDimensionalAggregationDict, - QueryUnionTypeDict, - NullTypeDict, - UnsupportedTypeDict, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Query parameters or outputs.""" diff --git a/foundry/v1/models/_query_output_v2.py b/foundry/v1/models/_query_output_v2.py deleted file mode 100644 index b171fe17..00000000 --- a/foundry/v1/models/_query_output_v2.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool - -from foundry.v1.models._query_data_type import QueryDataType -from foundry.v1.models._query_output_v2_dict import QueryOutputV2Dict - - -class QueryOutputV2(BaseModel): - """Details about the output of a query.""" - - data_type: QueryDataType = Field(alias="dataType") - - required: StrictBool - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryOutputV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryOutputV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_query_output_v2_dict.py b/foundry/v1/models/_query_output_v2_dict.py deleted file mode 100644 index 82b31da9..00000000 --- a/foundry/v1/models/_query_output_v2_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictBool -from typing_extensions import TypedDict - -from foundry.v1.models._query_data_type_dict import QueryDataTypeDict - - -class QueryOutputV2Dict(TypedDict): - """Details about the output of a query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - dataType: QueryDataTypeDict - - required: StrictBool diff --git a/foundry/v1/models/_query_parameter_v2.py b/foundry/v1/models/_query_parameter_v2.py deleted file mode 100644 index 0934707c..00000000 --- a/foundry/v1/models/_query_parameter_v2.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._query_data_type import QueryDataType -from foundry.v1.models._query_parameter_v2_dict import QueryParameterV2Dict - - -class QueryParameterV2(BaseModel): - """Details about a parameter of a query.""" - - description: Optional[StrictStr] = None - - data_type: QueryDataType = Field(alias="dataType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryParameterV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryParameterV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_query_parameter_v2_dict.py b/foundry/v1/models/_query_parameter_v2_dict.py deleted file mode 100644 index b88c9227..00000000 --- a/foundry/v1/models/_query_parameter_v2_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._query_data_type_dict import QueryDataTypeDict - - -class QueryParameterV2Dict(TypedDict): - """Details about a parameter of a query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: NotRequired[StrictStr] - - dataType: QueryDataTypeDict diff --git a/foundry/v1/models/_query_runtime_error_parameter.py b/foundry/v1/models/_query_runtime_error_parameter.py deleted file mode 100644 index 2b9d557d..00000000 --- a/foundry/v1/models/_query_runtime_error_parameter.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -QueryRuntimeErrorParameter = StrictStr -"""QueryRuntimeErrorParameter""" diff --git a/foundry/v1/models/_query_three_dimensional_aggregation.py b/foundry/v1/models/_query_three_dimensional_aggregation.py deleted file mode 100644 index f33386f0..00000000 --- a/foundry/v1/models/_query_three_dimensional_aggregation.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._nested_query_aggregation import NestedQueryAggregation -from foundry.v1.models._query_three_dimensional_aggregation_dict import ( - QueryThreeDimensionalAggregationDict, -) # NOQA - - -class QueryThreeDimensionalAggregation(BaseModel): - """QueryThreeDimensionalAggregation""" - - groups: List[NestedQueryAggregation] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryThreeDimensionalAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - QueryThreeDimensionalAggregationDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_query_three_dimensional_aggregation_dict.py b/foundry/v1/models/_query_three_dimensional_aggregation_dict.py deleted file mode 100644 index fdfbdeff..00000000 --- a/foundry/v1/models/_query_three_dimensional_aggregation_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._nested_query_aggregation_dict import NestedQueryAggregationDict - - -class QueryThreeDimensionalAggregationDict(TypedDict): - """QueryThreeDimensionalAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - groups: List[NestedQueryAggregationDict] diff --git a/foundry/v1/models/_query_two_dimensional_aggregation.py b/foundry/v1/models/_query_two_dimensional_aggregation.py deleted file mode 100644 index 1a712720..00000000 --- a/foundry/v1/models/_query_two_dimensional_aggregation.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._query_aggregation import QueryAggregation -from foundry.v1.models._query_two_dimensional_aggregation_dict import ( - QueryTwoDimensionalAggregationDict, -) # NOQA - - -class QueryTwoDimensionalAggregation(BaseModel): - """QueryTwoDimensionalAggregation""" - - groups: List[QueryAggregation] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryTwoDimensionalAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - QueryTwoDimensionalAggregationDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_query_two_dimensional_aggregation_dict.py b/foundry/v1/models/_query_two_dimensional_aggregation_dict.py deleted file mode 100644 index 4d2b7f7e..00000000 --- a/foundry/v1/models/_query_two_dimensional_aggregation_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._query_aggregation_dict import QueryAggregationDict - - -class QueryTwoDimensionalAggregationDict(TypedDict): - """QueryTwoDimensionalAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - groups: List[QueryAggregationDict] diff --git a/foundry/v1/models/_query_type.py b/foundry/v1/models/_query_type.py deleted file mode 100644 index 873d22d2..00000000 --- a/foundry/v1/models/_query_type.py +++ /dev/null @@ -1,57 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._function_rid import FunctionRid -from foundry.v1.models._function_version import FunctionVersion -from foundry.v1.models._ontology_data_type import OntologyDataType -from foundry.v1.models._parameter import Parameter -from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._query_api_name import QueryApiName -from foundry.v1.models._query_type_dict import QueryTypeDict - - -class QueryType(BaseModel): - """Represents a query type in the Ontology.""" - - api_name: QueryApiName = Field(alias="apiName") - - description: Optional[StrictStr] = None - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - parameters: Dict[ParameterId, Parameter] - - output: Optional[OntologyDataType] = None - - rid: FunctionRid - - version: FunctionVersion - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_query_type_dict.py b/foundry/v1/models/_query_type_dict.py deleted file mode 100644 index 72528879..00000000 --- a/foundry/v1/models/_query_type_dict.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._function_rid import FunctionRid -from foundry.v1.models._function_version import FunctionVersion -from foundry.v1.models._ontology_data_type_dict import OntologyDataTypeDict -from foundry.v1.models._parameter_dict import ParameterDict -from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._query_api_name import QueryApiName - - -class QueryTypeDict(TypedDict): - """Represents a query type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: QueryApiName - - description: NotRequired[StrictStr] - - displayName: NotRequired[DisplayName] - - parameters: Dict[ParameterId, ParameterDict] - - output: NotRequired[OntologyDataTypeDict] - - rid: FunctionRid - - version: FunctionVersion diff --git a/foundry/v1/models/_query_type_v2.py b/foundry/v1/models/_query_type_v2.py deleted file mode 100644 index 163383ea..00000000 --- a/foundry/v1/models/_query_type_v2.py +++ /dev/null @@ -1,57 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._function_rid import FunctionRid -from foundry.v1.models._function_version import FunctionVersion -from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._query_api_name import QueryApiName -from foundry.v1.models._query_data_type import QueryDataType -from foundry.v1.models._query_parameter_v2 import QueryParameterV2 -from foundry.v1.models._query_type_v2_dict import QueryTypeV2Dict - - -class QueryTypeV2(BaseModel): - """Represents a query type in the Ontology.""" - - api_name: QueryApiName = Field(alias="apiName") - - description: Optional[StrictStr] = None - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - parameters: Dict[ParameterId, QueryParameterV2] - - output: QueryDataType - - rid: FunctionRid - - version: FunctionVersion - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryTypeV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryTypeV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_query_type_v2_dict.py b/foundry/v1/models/_query_type_v2_dict.py deleted file mode 100644 index a527ad24..00000000 --- a/foundry/v1/models/_query_type_v2_dict.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._function_rid import FunctionRid -from foundry.v1.models._function_version import FunctionVersion -from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._query_api_name import QueryApiName -from foundry.v1.models._query_data_type_dict import QueryDataTypeDict -from foundry.v1.models._query_parameter_v2_dict import QueryParameterV2Dict - - -class QueryTypeV2Dict(TypedDict): - """Represents a query type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: QueryApiName - - description: NotRequired[StrictStr] - - displayName: NotRequired[DisplayName] - - parameters: Dict[ParameterId, QueryParameterV2Dict] - - output: QueryDataTypeDict - - rid: FunctionRid - - version: FunctionVersion diff --git a/foundry/v1/models/_range_constraint.py b/foundry/v1/models/_range_constraint.py deleted file mode 100644 index b67c02d5..00000000 --- a/foundry/v1/models/_range_constraint.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._range_constraint_dict import RangeConstraintDict - - -class RangeConstraint(BaseModel): - """The parameter value must be within the defined range.""" - - lt: Optional[Any] = None - """Less than""" - - lte: Optional[Any] = None - """Less than or equal""" - - gt: Optional[Any] = None - """Greater than""" - - gte: Optional[Any] = None - """Greater than or equal""" - - type: Literal["range"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> RangeConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(RangeConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_reason.py b/foundry/v1/models/_reason.py deleted file mode 100644 index 3ffe0aff..00000000 --- a/foundry/v1/models/_reason.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._reason_dict import ReasonDict -from foundry.v1.models._reason_type import ReasonType - - -class Reason(BaseModel): - """Reason""" - - reason: ReasonType - - type: Literal["reason"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ReasonDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ReasonDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_reason_dict.py b/foundry/v1/models/_reason_dict.py deleted file mode 100644 index fc76b309..00000000 --- a/foundry/v1/models/_reason_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._reason_type import ReasonType - - -class ReasonDict(TypedDict): - """Reason""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - reason: ReasonType - - type: Literal["reason"] diff --git a/foundry/v1/models/_reason_type.py b/foundry/v1/models/_reason_type.py deleted file mode 100644 index c388db7e..00000000 --- a/foundry/v1/models/_reason_type.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -ReasonType = Literal["USER_CLOSED", "CHANNEL_CLOSED"] -"""Represents the reason a subscription was closed.""" diff --git a/foundry/v1/models/_reference_update.py b/foundry/v1/models/_reference_update.py deleted file mode 100644 index 03221d8e..00000000 --- a/foundry/v1/models/_reference_update.py +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._object_primary_key import ObjectPrimaryKey -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._reference_update_dict import ReferenceUpdateDict -from foundry.v1.models._reference_value import ReferenceValue - - -class ReferenceUpdate(BaseModel): - """ - The updated data value associated with an object instance's external reference. The object instance - is uniquely identified by an object type and a primary key. Note that the value of the property - field returns a dereferenced value rather than the reference itself. - """ - - object_type: ObjectTypeApiName = Field(alias="objectType") - - primary_key: ObjectPrimaryKey = Field(alias="primaryKey") - - property: PropertyApiName - - value: ReferenceValue - - type: Literal["reference"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ReferenceUpdateDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ReferenceUpdateDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_reference_update_dict.py b/foundry/v1/models/_reference_update_dict.py deleted file mode 100644 index 577439bb..00000000 --- a/foundry/v1/models/_reference_update_dict.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._object_primary_key import ObjectPrimaryKey -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._reference_value_dict import ReferenceValueDict - - -class ReferenceUpdateDict(TypedDict): - """ - The updated data value associated with an object instance's external reference. The object instance - is uniquely identified by an object type and a primary key. Note that the value of the property - field returns a dereferenced value rather than the reference itself. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectType: ObjectTypeApiName - - primaryKey: ObjectPrimaryKey - - property: PropertyApiName - - value: ReferenceValueDict - - type: Literal["reference"] diff --git a/foundry/v1/models/_reference_value.py b/foundry/v1/models/_reference_value.py deleted file mode 100644 index bd4f3438..00000000 --- a/foundry/v1/models/_reference_value.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v1.models._geotime_series_value import GeotimeSeriesValue - -ReferenceValue = GeotimeSeriesValue -"""Resolved data values pointed to by a reference.""" diff --git a/foundry/v1/models/_reference_value_dict.py b/foundry/v1/models/_reference_value_dict.py deleted file mode 100644 index 52be7fe3..00000000 --- a/foundry/v1/models/_reference_value_dict.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v1.models._geotime_series_value_dict import GeotimeSeriesValueDict - -ReferenceValueDict = GeotimeSeriesValueDict -"""Resolved data values pointed to by a reference.""" diff --git a/foundry/v1/models/_refresh_object_set.py b/foundry/v1/models/_refresh_object_set.py deleted file mode 100644 index 6e3abba1..00000000 --- a/foundry/v1/models/_refresh_object_set.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._refresh_object_set_dict import RefreshObjectSetDict -from foundry.v1.models._subscription_id import SubscriptionId - - -class RefreshObjectSet(BaseModel): - """The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service.""" - - id: SubscriptionId - - object_type: ObjectTypeApiName = Field(alias="objectType") - - type: Literal["refreshObjectSet"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> RefreshObjectSetDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(RefreshObjectSetDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_refresh_object_set_dict.py b/foundry/v1/models/_refresh_object_set_dict.py deleted file mode 100644 index 43e01f63..00000000 --- a/foundry/v1/models/_refresh_object_set_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._subscription_id import SubscriptionId - - -class RefreshObjectSetDict(TypedDict): - """The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - id: SubscriptionId - - objectType: ObjectTypeApiName - - type: Literal["refreshObjectSet"] diff --git a/foundry/v1/models/_relative_time.py b/foundry/v1/models/_relative_time.py deleted file mode 100644 index be9c8b2e..00000000 --- a/foundry/v1/models/_relative_time.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictInt - -from foundry.v1.models._relative_time_dict import RelativeTimeDict -from foundry.v1.models._relative_time_relation import RelativeTimeRelation -from foundry.v1.models._relative_time_series_time_unit import RelativeTimeSeriesTimeUnit - - -class RelativeTime(BaseModel): - """A relative time, such as "3 days before" or "2 hours after" the current moment.""" - - when: RelativeTimeRelation - - value: StrictInt - - unit: RelativeTimeSeriesTimeUnit - - model_config = {"extra": "allow"} - - def to_dict(self) -> RelativeTimeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(RelativeTimeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_relative_time_dict.py b/foundry/v1/models/_relative_time_dict.py deleted file mode 100644 index 2354ee30..00000000 --- a/foundry/v1/models/_relative_time_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictInt -from typing_extensions import TypedDict - -from foundry.v1.models._relative_time_relation import RelativeTimeRelation -from foundry.v1.models._relative_time_series_time_unit import RelativeTimeSeriesTimeUnit - - -class RelativeTimeDict(TypedDict): - """A relative time, such as "3 days before" or "2 hours after" the current moment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - when: RelativeTimeRelation - - value: StrictInt - - unit: RelativeTimeSeriesTimeUnit diff --git a/foundry/v1/models/_relative_time_range.py b/foundry/v1/models/_relative_time_range.py deleted file mode 100644 index 67f37837..00000000 --- a/foundry/v1/models/_relative_time_range.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._relative_time import RelativeTime -from foundry.v1.models._relative_time_range_dict import RelativeTimeRangeDict - - -class RelativeTimeRange(BaseModel): - """A relative time range for a time series query.""" - - start_time: Optional[RelativeTime] = Field(alias="startTime", default=None) - - end_time: Optional[RelativeTime] = Field(alias="endTime", default=None) - - type: Literal["relative"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> RelativeTimeRangeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(RelativeTimeRangeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_relative_time_range_dict.py b/foundry/v1/models/_relative_time_range_dict.py deleted file mode 100644 index 7a344b9b..00000000 --- a/foundry/v1/models/_relative_time_range_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._relative_time_dict import RelativeTimeDict - - -class RelativeTimeRangeDict(TypedDict): - """A relative time range for a time series query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - startTime: NotRequired[RelativeTimeDict] - - endTime: NotRequired[RelativeTimeDict] - - type: Literal["relative"] diff --git a/foundry/v1/models/_request_id.py b/foundry/v1/models/_request_id.py deleted file mode 100644 index c6fb7855..00000000 --- a/foundry/v1/models/_request_id.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import UUID - -RequestId = UUID -"""Unique request id""" diff --git a/foundry/v1/models/_resource_path.py b/foundry/v1/models/_resource_path.py deleted file mode 100644 index 0b89bd01..00000000 --- a/foundry/v1/models/_resource_path.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -ResourcePath = StrictStr -"""A path in the Foundry file tree.""" diff --git a/foundry/v1/models/_search_json_query.py b/foundry/v1/models/_search_json_query.py deleted file mode 100644 index 55deb7eb..00000000 --- a/foundry/v1/models/_search_json_query.py +++ /dev/null @@ -1,104 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._all_terms_query import AllTermsQuery -from foundry.v1.models._any_term_query import AnyTermQuery -from foundry.v1.models._contains_query import ContainsQuery -from foundry.v1.models._equals_query import EqualsQuery -from foundry.v1.models._gt_query import GtQuery -from foundry.v1.models._gte_query import GteQuery -from foundry.v1.models._is_null_query import IsNullQuery -from foundry.v1.models._lt_query import LtQuery -from foundry.v1.models._lte_query import LteQuery -from foundry.v1.models._phrase_query import PhraseQuery -from foundry.v1.models._prefix_query import PrefixQuery -from foundry.v1.models._search_json_query_dict import AndQueryDict -from foundry.v1.models._search_json_query_dict import NotQueryDict -from foundry.v1.models._search_json_query_dict import OrQueryDict - - -class AndQuery(BaseModel): - """Returns objects where every query is satisfied.""" - - value: List[SearchJsonQuery] - - type: Literal["and"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AndQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AndQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class OrQuery(BaseModel): - """Returns objects where at least 1 query is satisfied.""" - - value: List[SearchJsonQuery] - - type: Literal["or"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OrQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OrQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class NotQuery(BaseModel): - """Returns objects where the query is not satisfied.""" - - value: SearchJsonQuery - - type: Literal["not"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> NotQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(NotQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -SearchJsonQuery = Annotated[ - Union[ - LtQuery, - GtQuery, - LteQuery, - GteQuery, - EqualsQuery, - IsNullQuery, - ContainsQuery, - AndQuery, - OrQuery, - NotQuery, - PrefixQuery, - PhraseQuery, - AnyTermQuery, - AllTermsQuery, - ], - Field(discriminator="type"), -] -"""SearchJsonQuery""" diff --git a/foundry/v1/models/_search_json_query_dict.py b/foundry/v1/models/_search_json_query_dict.py deleted file mode 100644 index 73911ff9..00000000 --- a/foundry/v1/models/_search_json_query_dict.py +++ /dev/null @@ -1,88 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import TypedDict - -from foundry.v1.models._all_terms_query_dict import AllTermsQueryDict -from foundry.v1.models._any_term_query_dict import AnyTermQueryDict -from foundry.v1.models._contains_query_dict import ContainsQueryDict -from foundry.v1.models._equals_query_dict import EqualsQueryDict -from foundry.v1.models._gt_query_dict import GtQueryDict -from foundry.v1.models._gte_query_dict import GteQueryDict -from foundry.v1.models._is_null_query_dict import IsNullQueryDict -from foundry.v1.models._lt_query_dict import LtQueryDict -from foundry.v1.models._lte_query_dict import LteQueryDict -from foundry.v1.models._phrase_query_dict import PhraseQueryDict -from foundry.v1.models._prefix_query_dict import PrefixQueryDict - - -class AndQueryDict(TypedDict): - """Returns objects where every query is satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: List[SearchJsonQueryDict] - - type: Literal["and"] - - -class OrQueryDict(TypedDict): - """Returns objects where at least 1 query is satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: List[SearchJsonQueryDict] - - type: Literal["or"] - - -class NotQueryDict(TypedDict): - """Returns objects where the query is not satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: SearchJsonQueryDict - - type: Literal["not"] - - -SearchJsonQueryDict = Annotated[ - Union[ - LtQueryDict, - GtQueryDict, - LteQueryDict, - GteQueryDict, - EqualsQueryDict, - IsNullQueryDict, - ContainsQueryDict, - AndQueryDict, - OrQueryDict, - NotQueryDict, - PrefixQueryDict, - PhraseQueryDict, - AnyTermQueryDict, - AllTermsQueryDict, - ], - Field(discriminator="type"), -] -"""SearchJsonQuery""" diff --git a/foundry/v1/models/_search_json_query_v2.py b/foundry/v1/models/_search_json_query_v2.py deleted file mode 100644 index dc8dab10..00000000 --- a/foundry/v1/models/_search_json_query_v2.py +++ /dev/null @@ -1,126 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._contains_all_terms_in_order_prefix_last_term import ( - ContainsAllTermsInOrderPrefixLastTerm, -) # NOQA -from foundry.v1.models._contains_all_terms_in_order_query import ( - ContainsAllTermsInOrderQuery, -) # NOQA -from foundry.v1.models._contains_all_terms_query import ContainsAllTermsQuery -from foundry.v1.models._contains_any_term_query import ContainsAnyTermQuery -from foundry.v1.models._contains_query_v2 import ContainsQueryV2 -from foundry.v1.models._does_not_intersect_bounding_box_query import ( - DoesNotIntersectBoundingBoxQuery, -) # NOQA -from foundry.v1.models._does_not_intersect_polygon_query import DoesNotIntersectPolygonQuery # NOQA -from foundry.v1.models._equals_query_v2 import EqualsQueryV2 -from foundry.v1.models._gt_query_v2 import GtQueryV2 -from foundry.v1.models._gte_query_v2 import GteQueryV2 -from foundry.v1.models._intersects_bounding_box_query import IntersectsBoundingBoxQuery -from foundry.v1.models._intersects_polygon_query import IntersectsPolygonQuery -from foundry.v1.models._is_null_query_v2 import IsNullQueryV2 -from foundry.v1.models._lt_query_v2 import LtQueryV2 -from foundry.v1.models._lte_query_v2 import LteQueryV2 -from foundry.v1.models._search_json_query_v2_dict import AndQueryV2Dict -from foundry.v1.models._search_json_query_v2_dict import NotQueryV2Dict -from foundry.v1.models._search_json_query_v2_dict import OrQueryV2Dict -from foundry.v1.models._starts_with_query import StartsWithQuery -from foundry.v1.models._within_bounding_box_query import WithinBoundingBoxQuery -from foundry.v1.models._within_distance_of_query import WithinDistanceOfQuery -from foundry.v1.models._within_polygon_query import WithinPolygonQuery - - -class AndQueryV2(BaseModel): - """Returns objects where every query is satisfied.""" - - value: List[SearchJsonQueryV2] - - type: Literal["and"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AndQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AndQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class OrQueryV2(BaseModel): - """Returns objects where at least 1 query is satisfied.""" - - value: List[SearchJsonQueryV2] - - type: Literal["or"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OrQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OrQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class NotQueryV2(BaseModel): - """Returns objects where the query is not satisfied.""" - - value: SearchJsonQueryV2 - - type: Literal["not"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> NotQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(NotQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) - - -SearchJsonQueryV2 = Annotated[ - Union[ - LtQueryV2, - GtQueryV2, - LteQueryV2, - GteQueryV2, - EqualsQueryV2, - IsNullQueryV2, - ContainsQueryV2, - AndQueryV2, - OrQueryV2, - NotQueryV2, - StartsWithQuery, - ContainsAllTermsInOrderQuery, - ContainsAllTermsInOrderPrefixLastTerm, - ContainsAnyTermQuery, - ContainsAllTermsQuery, - WithinDistanceOfQuery, - WithinBoundingBoxQuery, - IntersectsBoundingBoxQuery, - DoesNotIntersectBoundingBoxQuery, - WithinPolygonQuery, - IntersectsPolygonQuery, - DoesNotIntersectPolygonQuery, - ], - Field(discriminator="type"), -] -"""SearchJsonQueryV2""" diff --git a/foundry/v1/models/_search_json_query_v2_dict.py b/foundry/v1/models/_search_json_query_v2_dict.py deleted file mode 100644 index 267b7c40..00000000 --- a/foundry/v1/models/_search_json_query_v2_dict.py +++ /dev/null @@ -1,114 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import TypedDict - -from foundry.v1.models._contains_all_terms_in_order_prefix_last_term_dict import ( - ContainsAllTermsInOrderPrefixLastTermDict, -) # NOQA -from foundry.v1.models._contains_all_terms_in_order_query_dict import ( - ContainsAllTermsInOrderQueryDict, -) # NOQA -from foundry.v1.models._contains_all_terms_query_dict import ContainsAllTermsQueryDict -from foundry.v1.models._contains_any_term_query_dict import ContainsAnyTermQueryDict -from foundry.v1.models._contains_query_v2_dict import ContainsQueryV2Dict -from foundry.v1.models._does_not_intersect_bounding_box_query_dict import ( - DoesNotIntersectBoundingBoxQueryDict, -) # NOQA -from foundry.v1.models._does_not_intersect_polygon_query_dict import ( - DoesNotIntersectPolygonQueryDict, -) # NOQA -from foundry.v1.models._equals_query_v2_dict import EqualsQueryV2Dict -from foundry.v1.models._gt_query_v2_dict import GtQueryV2Dict -from foundry.v1.models._gte_query_v2_dict import GteQueryV2Dict -from foundry.v1.models._intersects_bounding_box_query_dict import ( - IntersectsBoundingBoxQueryDict, -) # NOQA -from foundry.v1.models._intersects_polygon_query_dict import IntersectsPolygonQueryDict -from foundry.v1.models._is_null_query_v2_dict import IsNullQueryV2Dict -from foundry.v1.models._lt_query_v2_dict import LtQueryV2Dict -from foundry.v1.models._lte_query_v2_dict import LteQueryV2Dict -from foundry.v1.models._starts_with_query_dict import StartsWithQueryDict -from foundry.v1.models._within_bounding_box_query_dict import WithinBoundingBoxQueryDict -from foundry.v1.models._within_distance_of_query_dict import WithinDistanceOfQueryDict -from foundry.v1.models._within_polygon_query_dict import WithinPolygonQueryDict - - -class AndQueryV2Dict(TypedDict): - """Returns objects where every query is satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: List[SearchJsonQueryV2Dict] - - type: Literal["and"] - - -class OrQueryV2Dict(TypedDict): - """Returns objects where at least 1 query is satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: List[SearchJsonQueryV2Dict] - - type: Literal["or"] - - -class NotQueryV2Dict(TypedDict): - """Returns objects where the query is not satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: SearchJsonQueryV2Dict - - type: Literal["not"] - - -SearchJsonQueryV2Dict = Annotated[ - Union[ - LtQueryV2Dict, - GtQueryV2Dict, - LteQueryV2Dict, - GteQueryV2Dict, - EqualsQueryV2Dict, - IsNullQueryV2Dict, - ContainsQueryV2Dict, - AndQueryV2Dict, - OrQueryV2Dict, - NotQueryV2Dict, - StartsWithQueryDict, - ContainsAllTermsInOrderQueryDict, - ContainsAllTermsInOrderPrefixLastTermDict, - ContainsAnyTermQueryDict, - ContainsAllTermsQueryDict, - WithinDistanceOfQueryDict, - WithinBoundingBoxQueryDict, - IntersectsBoundingBoxQueryDict, - DoesNotIntersectBoundingBoxQueryDict, - WithinPolygonQueryDict, - IntersectsPolygonQueryDict, - DoesNotIntersectPolygonQueryDict, - ], - Field(discriminator="type"), -] -"""SearchJsonQueryV2""" diff --git a/foundry/v1/models/_search_objects_for_interface_request.py b/foundry/v1/models/_search_objects_for_interface_request.py deleted file mode 100644 index e16b2b62..00000000 --- a/foundry/v1/models/_search_objects_for_interface_request.py +++ /dev/null @@ -1,95 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._search_json_query_v2 import SearchJsonQueryV2 -from foundry.v1.models._search_objects_for_interface_request_dict import ( - SearchObjectsForInterfaceRequestDict, -) # NOQA -from foundry.v1.models._search_order_by_v2 import SearchOrderByV2 -from foundry.v1.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class SearchObjectsForInterfaceRequest(BaseModel): - """SearchObjectsForInterfaceRequest""" - - where: Optional[SearchJsonQueryV2] = None - - order_by: Optional[SearchOrderByV2] = Field(alias="orderBy", default=None) - - augmented_properties: Dict[ObjectTypeApiName, List[PropertyApiName]] = Field( - alias="augmentedProperties" - ) - """ - A map from object type API name to a list of property type API names. For each returned object, if the - object’s object type is a key in the map, then we augment the response for that object type with the list - of properties specified in the value. - """ - - augmented_shared_property_types: Dict[ - InterfaceTypeApiName, List[SharedPropertyTypeApiName] - ] = Field(alias="augmentedSharedPropertyTypes") - """ - A map from interface type API name to a list of shared property type API names. For each returned object, if - the object implements an interface that is a key in the map, then we augment the response for that object - type with the list of properties specified in the value. - """ - - selected_shared_property_types: List[SharedPropertyTypeApiName] = Field( - alias="selectedSharedPropertyTypes" - ) - """ - A list of shared property type API names of the interface type that should be included in the response. - Omit this parameter to include all properties of the interface type in the response. - """ - - selected_object_types: List[ObjectTypeApiName] = Field(alias="selectedObjectTypes") - """ - A list of object type API names that should be included in the response. If non-empty, object types that are - not mentioned will not be included in the response even if they implement the specified interface. Omit the - parameter to include all object types. - """ - - other_interface_types: List[InterfaceTypeApiName] = Field(alias="otherInterfaceTypes") - """ - A list of interface type API names. Object types must implement all the mentioned interfaces in order to be - included in the response. - """ - - page_size: Optional[PageSize] = Field(alias="pageSize", default=None) - - page_token: Optional[PageToken] = Field(alias="pageToken", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchObjectsForInterfaceRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - SearchObjectsForInterfaceRequestDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_search_objects_for_interface_request_dict.py b/foundry/v1/models/_search_objects_for_interface_request_dict.py deleted file mode 100644 index 7b3f77df..00000000 --- a/foundry/v1/models/_search_objects_for_interface_request_dict.py +++ /dev/null @@ -1,78 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v1.models._object_type_api_name import ObjectTypeApiName -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._search_json_query_v2_dict import SearchJsonQueryV2Dict -from foundry.v1.models._search_order_by_v2_dict import SearchOrderByV2Dict -from foundry.v1.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class SearchObjectsForInterfaceRequestDict(TypedDict): - """SearchObjectsForInterfaceRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - where: NotRequired[SearchJsonQueryV2Dict] - - orderBy: NotRequired[SearchOrderByV2Dict] - - augmentedProperties: Dict[ObjectTypeApiName, List[PropertyApiName]] - """ - A map from object type API name to a list of property type API names. For each returned object, if the - object’s object type is a key in the map, then we augment the response for that object type with the list - of properties specified in the value. - """ - - augmentedSharedPropertyTypes: Dict[InterfaceTypeApiName, List[SharedPropertyTypeApiName]] - """ - A map from interface type API name to a list of shared property type API names. For each returned object, if - the object implements an interface that is a key in the map, then we augment the response for that object - type with the list of properties specified in the value. - """ - - selectedSharedPropertyTypes: List[SharedPropertyTypeApiName] - """ - A list of shared property type API names of the interface type that should be included in the response. - Omit this parameter to include all properties of the interface type in the response. - """ - - selectedObjectTypes: List[ObjectTypeApiName] - """ - A list of object type API names that should be included in the response. If non-empty, object types that are - not mentioned will not be included in the response even if they implement the specified interface. Omit the - parameter to include all object types. - """ - - otherInterfaceTypes: List[InterfaceTypeApiName] - """ - A list of interface type API names. Object types must implement all the mentioned interfaces in order to be - included in the response. - """ - - pageSize: NotRequired[PageSize] - - pageToken: NotRequired[PageToken] diff --git a/foundry/v1/models/_search_objects_request.py b/foundry/v1/models/_search_objects_request.py deleted file mode 100644 index 0e468179..00000000 --- a/foundry/v1/models/_search_objects_request.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._search_json_query import SearchJsonQuery -from foundry.v1.models._search_objects_request_dict import SearchObjectsRequestDict -from foundry.v1.models._search_order_by import SearchOrderBy - - -class SearchObjectsRequest(BaseModel): - """SearchObjectsRequest""" - - query: SearchJsonQuery - - order_by: Optional[SearchOrderBy] = Field(alias="orderBy", default=None) - - page_size: Optional[PageSize] = Field(alias="pageSize", default=None) - - page_token: Optional[PageToken] = Field(alias="pageToken", default=None) - - fields: List[PropertyApiName] - """The API names of the object type properties to include in the response.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchObjectsRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchObjectsRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_search_objects_request_dict.py b/foundry/v1/models/_search_objects_request_dict.py deleted file mode 100644 index 341a0ad1..00000000 --- a/foundry/v1/models/_search_objects_request_dict.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._search_json_query_dict import SearchJsonQueryDict -from foundry.v1.models._search_order_by_dict import SearchOrderByDict - - -class SearchObjectsRequestDict(TypedDict): - """SearchObjectsRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - query: SearchJsonQueryDict - - orderBy: NotRequired[SearchOrderByDict] - - pageSize: NotRequired[PageSize] - - pageToken: NotRequired[PageToken] - - fields: List[PropertyApiName] - """The API names of the object type properties to include in the response.""" diff --git a/foundry/v1/models/_search_objects_request_v2.py b/foundry/v1/models/_search_objects_request_v2.py deleted file mode 100644 index 8402c92a..00000000 --- a/foundry/v1/models/_search_objects_request_v2.py +++ /dev/null @@ -1,58 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool - -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._search_json_query_v2 import SearchJsonQueryV2 -from foundry.v1.models._search_objects_request_v2_dict import SearchObjectsRequestV2Dict -from foundry.v1.models._search_order_by_v2 import SearchOrderByV2 - - -class SearchObjectsRequestV2(BaseModel): - """SearchObjectsRequestV2""" - - where: Optional[SearchJsonQueryV2] = None - - order_by: Optional[SearchOrderByV2] = Field(alias="orderBy", default=None) - - page_size: Optional[PageSize] = Field(alias="pageSize", default=None) - - page_token: Optional[PageToken] = Field(alias="pageToken", default=None) - - select: List[PropertyApiName] - """The API names of the object type properties to include in the response.""" - - exclude_rid: Optional[StrictBool] = Field(alias="excludeRid", default=None) - """ - A flag to exclude the retrieval of the `__rid` property. - Setting this to true may improve performance of this endpoint for object types in OSV2. - """ - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchObjectsRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchObjectsRequestV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_search_objects_request_v2_dict.py b/foundry/v1/models/_search_objects_request_v2_dict.py deleted file mode 100644 index c2e29cb9..00000000 --- a/foundry/v1/models/_search_objects_request_v2_dict.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from pydantic import StrictBool -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._page_size import PageSize -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._search_json_query_v2_dict import SearchJsonQueryV2Dict -from foundry.v1.models._search_order_by_v2_dict import SearchOrderByV2Dict - - -class SearchObjectsRequestV2Dict(TypedDict): - """SearchObjectsRequestV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - where: NotRequired[SearchJsonQueryV2Dict] - - orderBy: NotRequired[SearchOrderByV2Dict] - - pageSize: NotRequired[PageSize] - - pageToken: NotRequired[PageToken] - - select: List[PropertyApiName] - """The API names of the object type properties to include in the response.""" - - excludeRid: NotRequired[StrictBool] - """ - A flag to exclude the retrieval of the `__rid` property. - Setting this to true may improve performance of this endpoint for object types in OSV2. - """ diff --git a/foundry/v1/models/_search_objects_response.py b/foundry/v1/models/_search_objects_response.py deleted file mode 100644 index a8359e4c..00000000 --- a/foundry/v1/models/_search_objects_response.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._ontology_object import OntologyObject -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._search_objects_response_dict import SearchObjectsResponseDict -from foundry.v1.models._total_count import TotalCount - - -class SearchObjectsResponse(BaseModel): - """SearchObjectsResponse""" - - data: List[OntologyObject] - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - total_count: TotalCount = Field(alias="totalCount") - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchObjectsResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchObjectsResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_search_objects_response_dict.py b/foundry/v1/models/_search_objects_response_dict.py deleted file mode 100644 index 5cf4b01f..00000000 --- a/foundry/v1/models/_search_objects_response_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._ontology_object_dict import OntologyObjectDict -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._total_count import TotalCount - - -class SearchObjectsResponseDict(TypedDict): - """SearchObjectsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[OntologyObjectDict] - - nextPageToken: NotRequired[PageToken] - - totalCount: TotalCount diff --git a/foundry/v1/models/_search_objects_response_v2.py b/foundry/v1/models/_search_objects_response_v2.py deleted file mode 100644 index 1299d52f..00000000 --- a/foundry/v1/models/_search_objects_response_v2.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._search_objects_response_v2_dict import SearchObjectsResponseV2Dict # NOQA -from foundry.v1.models._total_count import TotalCount - - -class SearchObjectsResponseV2(BaseModel): - """SearchObjectsResponseV2""" - - data: List[OntologyObjectV2] - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - total_count: TotalCount = Field(alias="totalCount") - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchObjectsResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_search_objects_response_v2_dict.py b/foundry/v1/models/_search_objects_response_v2_dict.py deleted file mode 100644 index 424739eb..00000000 --- a/foundry/v1/models/_search_objects_response_v2_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v1.models._page_token import PageToken -from foundry.v1.models._total_count import TotalCount - - -class SearchObjectsResponseV2Dict(TypedDict): - """SearchObjectsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[OntologyObjectV2] - - nextPageToken: NotRequired[PageToken] - - totalCount: TotalCount diff --git a/foundry/v1/models/_search_order_by.py b/foundry/v1/models/_search_order_by.py deleted file mode 100644 index 43a02081..00000000 --- a/foundry/v1/models/_search_order_by.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._search_order_by_dict import SearchOrderByDict -from foundry.v1.models._search_ordering import SearchOrdering - - -class SearchOrderBy(BaseModel): - """Specifies the ordering of search results by a field and an ordering direction.""" - - fields: List[SearchOrdering] - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchOrderByDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchOrderByDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_search_order_by_dict.py b/foundry/v1/models/_search_order_by_dict.py deleted file mode 100644 index 80d6b40d..00000000 --- a/foundry/v1/models/_search_order_by_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._search_ordering_dict import SearchOrderingDict - - -class SearchOrderByDict(TypedDict): - """Specifies the ordering of search results by a field and an ordering direction.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: List[SearchOrderingDict] diff --git a/foundry/v1/models/_search_order_by_v2.py b/foundry/v1/models/_search_order_by_v2.py deleted file mode 100644 index 0149f470..00000000 --- a/foundry/v1/models/_search_order_by_v2.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._search_order_by_v2_dict import SearchOrderByV2Dict -from foundry.v1.models._search_ordering_v2 import SearchOrderingV2 - - -class SearchOrderByV2(BaseModel): - """Specifies the ordering of search results by a field and an ordering direction.""" - - fields: List[SearchOrderingV2] - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchOrderByV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchOrderByV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_search_order_by_v2_dict.py b/foundry/v1/models/_search_order_by_v2_dict.py deleted file mode 100644 index 5a5762af..00000000 --- a/foundry/v1/models/_search_order_by_v2_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._search_ordering_v2_dict import SearchOrderingV2Dict - - -class SearchOrderByV2Dict(TypedDict): - """Specifies the ordering of search results by a field and an ordering direction.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: List[SearchOrderingV2Dict] diff --git a/foundry/v1/models/_search_ordering.py b/foundry/v1/models/_search_ordering.py deleted file mode 100644 index cd2bb25f..00000000 --- a/foundry/v1/models/_search_ordering.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._search_ordering_dict import SearchOrderingDict - - -class SearchOrdering(BaseModel): - """SearchOrdering""" - - field: FieldNameV1 - - direction: Optional[StrictStr] = None - """Specifies the ordering direction (can be either `asc` or `desc`)""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchOrderingDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchOrderingDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_search_ordering_dict.py b/foundry/v1/models/_search_ordering_dict.py deleted file mode 100644 index c29b68e0..00000000 --- a/foundry/v1/models/_search_ordering_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class SearchOrderingDict(TypedDict): - """SearchOrdering""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - direction: NotRequired[StrictStr] - """Specifies the ordering direction (can be either `asc` or `desc`)""" diff --git a/foundry/v1/models/_search_ordering_v2.py b/foundry/v1/models/_search_ordering_v2.py deleted file mode 100644 index fbf7bde9..00000000 --- a/foundry/v1/models/_search_ordering_v2.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._search_ordering_v2_dict import SearchOrderingV2Dict - - -class SearchOrderingV2(BaseModel): - """SearchOrderingV2""" - - field: PropertyApiName - - direction: Optional[StrictStr] = None - """Specifies the ordering direction (can be either `asc` or `desc`)""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchOrderingV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchOrderingV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_search_ordering_v2_dict.py b/foundry/v1/models/_search_ordering_v2_dict.py deleted file mode 100644 index 76669ce8..00000000 --- a/foundry/v1/models/_search_ordering_v2_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName - - -class SearchOrderingV2Dict(TypedDict): - """SearchOrderingV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - direction: NotRequired[StrictStr] - """Specifies the ordering direction (can be either `asc` or `desc`)""" diff --git a/foundry/v1/models/_shared_property_type.py b/foundry/v1/models/_shared_property_type.py deleted file mode 100644 index 7bde56a3..00000000 --- a/foundry/v1/models/_shared_property_type.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._object_property_type import ObjectPropertyType -from foundry.v1.models._shared_property_type_api_name import SharedPropertyTypeApiName -from foundry.v1.models._shared_property_type_dict import SharedPropertyTypeDict -from foundry.v1.models._shared_property_type_rid import SharedPropertyTypeRid - - -class SharedPropertyType(BaseModel): - """A property type that can be shared across object types.""" - - rid: SharedPropertyTypeRid - - api_name: SharedPropertyTypeApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - description: Optional[StrictStr] = None - """A short text that describes the SharedPropertyType.""" - - data_type: ObjectPropertyType = Field(alias="dataType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> SharedPropertyTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SharedPropertyTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_shared_property_type_dict.py b/foundry/v1/models/_shared_property_type_dict.py deleted file mode 100644 index 8734edf7..00000000 --- a/foundry/v1/models/_shared_property_type_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._display_name import DisplayName -from foundry.v1.models._object_property_type_dict import ObjectPropertyTypeDict -from foundry.v1.models._shared_property_type_api_name import SharedPropertyTypeApiName -from foundry.v1.models._shared_property_type_rid import SharedPropertyTypeRid - - -class SharedPropertyTypeDict(TypedDict): - """A property type that can be shared across object types.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: SharedPropertyTypeRid - - apiName: SharedPropertyTypeApiName - - displayName: DisplayName - - description: NotRequired[StrictStr] - """A short text that describes the SharedPropertyType.""" - - dataType: ObjectPropertyTypeDict diff --git a/foundry/v1/models/_short_type.py b/foundry/v1/models/_short_type.py deleted file mode 100644 index 0c8fa4db..00000000 --- a/foundry/v1/models/_short_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._short_type_dict import ShortTypeDict - - -class ShortType(BaseModel): - """ShortType""" - - type: Literal["short"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ShortTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ShortTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_starts_with_query.py b/foundry/v1/models/_starts_with_query.py deleted file mode 100644 index d9095330..00000000 --- a/foundry/v1/models/_starts_with_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._starts_with_query_dict import StartsWithQueryDict - - -class StartsWithQuery(BaseModel): - """Returns objects where the specified field starts with the provided value.""" - - field: PropertyApiName - - value: StrictStr - - type: Literal["startsWith"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> StartsWithQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(StartsWithQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_starts_with_query_dict.py b/foundry/v1/models/_starts_with_query_dict.py deleted file mode 100644 index 6c76d793..00000000 --- a/foundry/v1/models/_starts_with_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import TypedDict - -from foundry.v1.models._property_api_name import PropertyApiName - - -class StartsWithQueryDict(TypedDict): - """Returns objects where the specified field starts with the provided value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: StrictStr - - type: Literal["startsWith"] diff --git a/foundry/v1/models/_stream_message.py b/foundry/v1/models/_stream_message.py deleted file mode 100644 index a1e0a14a..00000000 --- a/foundry/v1/models/_stream_message.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._object_set_subscribe_responses import ObjectSetSubscribeResponses # NOQA -from foundry.v1.models._object_set_updates import ObjectSetUpdates -from foundry.v1.models._refresh_object_set import RefreshObjectSet -from foundry.v1.models._subscription_closed import SubscriptionClosed - -StreamMessage = Annotated[ - Union[ObjectSetSubscribeResponses, ObjectSetUpdates, RefreshObjectSet, SubscriptionClosed], - Field(discriminator="type"), -] -"""StreamMessage""" diff --git a/foundry/v1/models/_stream_message_dict.py b/foundry/v1/models/_stream_message_dict.py deleted file mode 100644 index bcb2fb82..00000000 --- a/foundry/v1/models/_stream_message_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._object_set_subscribe_responses_dict import ( - ObjectSetSubscribeResponsesDict, -) # NOQA -from foundry.v1.models._object_set_updates_dict import ObjectSetUpdatesDict -from foundry.v1.models._refresh_object_set_dict import RefreshObjectSetDict -from foundry.v1.models._subscription_closed_dict import SubscriptionClosedDict - -StreamMessageDict = Annotated[ - Union[ - ObjectSetSubscribeResponsesDict, - ObjectSetUpdatesDict, - RefreshObjectSetDict, - SubscriptionClosedDict, - ], - Field(discriminator="type"), -] -"""StreamMessage""" diff --git a/foundry/v1/models/_stream_time_series_points_request.py b/foundry/v1/models/_stream_time_series_points_request.py deleted file mode 100644 index 04f2f62b..00000000 --- a/foundry/v1/models/_stream_time_series_points_request.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._stream_time_series_points_request_dict import ( - StreamTimeSeriesPointsRequestDict, -) # NOQA -from foundry.v1.models._time_range import TimeRange - - -class StreamTimeSeriesPointsRequest(BaseModel): - """StreamTimeSeriesPointsRequest""" - - range: Optional[TimeRange] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> StreamTimeSeriesPointsRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - StreamTimeSeriesPointsRequestDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_stream_time_series_points_request_dict.py b/foundry/v1/models/_stream_time_series_points_request_dict.py deleted file mode 100644 index 5f462808..00000000 --- a/foundry/v1/models/_stream_time_series_points_request_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._time_range_dict import TimeRangeDict - - -class StreamTimeSeriesPointsRequestDict(TypedDict): - """StreamTimeSeriesPointsRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - range: NotRequired[TimeRangeDict] diff --git a/foundry/v1/models/_stream_time_series_points_response.py b/foundry/v1/models/_stream_time_series_points_response.py deleted file mode 100644 index 702737e5..00000000 --- a/foundry/v1/models/_stream_time_series_points_response.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._stream_time_series_points_response_dict import ( - StreamTimeSeriesPointsResponseDict, -) # NOQA -from foundry.v1.models._time_series_point import TimeSeriesPoint - - -class StreamTimeSeriesPointsResponse(BaseModel): - """StreamTimeSeriesPointsResponse""" - - data: List[TimeSeriesPoint] - - model_config = {"extra": "allow"} - - def to_dict(self) -> StreamTimeSeriesPointsResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - StreamTimeSeriesPointsResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_stream_time_series_points_response_dict.py b/foundry/v1/models/_stream_time_series_points_response_dict.py deleted file mode 100644 index 36298b8b..00000000 --- a/foundry/v1/models/_stream_time_series_points_response_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._time_series_point_dict import TimeSeriesPointDict - - -class StreamTimeSeriesPointsResponseDict(TypedDict): - """StreamTimeSeriesPointsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[TimeSeriesPointDict] diff --git a/foundry/v1/models/_string_length_constraint.py b/foundry/v1/models/_string_length_constraint.py deleted file mode 100644 index 047ab69a..00000000 --- a/foundry/v1/models/_string_length_constraint.py +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._string_length_constraint_dict import StringLengthConstraintDict - - -class StringLengthConstraint(BaseModel): - """ - The parameter value must have a length within the defined range. - *This range is always inclusive.* - """ - - lt: Optional[Any] = None - """Less than""" - - lte: Optional[Any] = None - """Less than or equal""" - - gt: Optional[Any] = None - """Greater than""" - - gte: Optional[Any] = None - """Greater than or equal""" - - type: Literal["stringLength"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> StringLengthConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(StringLengthConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_string_regex_match_constraint.py b/foundry/v1/models/_string_regex_match_constraint.py deleted file mode 100644 index 51c7f0bb..00000000 --- a/foundry/v1/models/_string_regex_match_constraint.py +++ /dev/null @@ -1,53 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._string_regex_match_constraint_dict import ( - StringRegexMatchConstraintDict, -) # NOQA - - -class StringRegexMatchConstraint(BaseModel): - """The parameter value must match a predefined regular expression.""" - - regex: StrictStr - """The regular expression configured in the **Ontology Manager**.""" - - configured_failure_message: Optional[StrictStr] = Field( - alias="configuredFailureMessage", default=None - ) - """ - The message indicating that the regular expression was not matched. - This is configured per parameter in the **Ontology Manager**. - """ - - type: Literal["stringRegexMatch"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> StringRegexMatchConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - StringRegexMatchConstraintDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_string_type.py b/foundry/v1/models/_string_type.py deleted file mode 100644 index bda4a7be..00000000 --- a/foundry/v1/models/_string_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._string_type_dict import StringTypeDict - - -class StringType(BaseModel): - """StringType""" - - type: Literal["string"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> StringTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(StringTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_submission_criteria_evaluation.py b/foundry/v1/models/_submission_criteria_evaluation.py deleted file mode 100644 index ec475719..00000000 --- a/foundry/v1/models/_submission_criteria_evaluation.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._submission_criteria_evaluation_dict import ( - SubmissionCriteriaEvaluationDict, -) # NOQA -from foundry.v1.models._validation_result import ValidationResult - - -class SubmissionCriteriaEvaluation(BaseModel): - """ - Contains the status of the **submission criteria**. - **Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. - These are configured in the **Ontology Manager**. - """ - - configured_failure_message: Optional[StrictStr] = Field( - alias="configuredFailureMessage", default=None - ) - """ - The message indicating one of the **submission criteria** was not satisfied. - This is configured per **submission criteria** in the **Ontology Manager**. - """ - - result: ValidationResult - - model_config = {"extra": "allow"} - - def to_dict(self) -> SubmissionCriteriaEvaluationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - SubmissionCriteriaEvaluationDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_submission_criteria_evaluation_dict.py b/foundry/v1/models/_submission_criteria_evaluation_dict.py deleted file mode 100644 index 215c5325..00000000 --- a/foundry/v1/models/_submission_criteria_evaluation_dict.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._validation_result import ValidationResult - - -class SubmissionCriteriaEvaluationDict(TypedDict): - """ - Contains the status of the **submission criteria**. - **Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. - These are configured in the **Ontology Manager**. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - configuredFailureMessage: NotRequired[StrictStr] - """ - The message indicating one of the **submission criteria** was not satisfied. - This is configured per **submission criteria** in the **Ontology Manager**. - """ - - result: ValidationResult diff --git a/foundry/v1/models/_subscription_closed.py b/foundry/v1/models/_subscription_closed.py deleted file mode 100644 index f3f9350c..00000000 --- a/foundry/v1/models/_subscription_closed.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._subscription_closed_dict import SubscriptionClosedDict -from foundry.v1.models._subscription_closure_cause import SubscriptionClosureCause -from foundry.v1.models._subscription_id import SubscriptionId - - -class SubscriptionClosed(BaseModel): - """The subscription has been closed due to an irrecoverable error during its lifecycle.""" - - id: SubscriptionId - - cause: SubscriptionClosureCause - - type: Literal["subscriptionClosed"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> SubscriptionClosedDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SubscriptionClosedDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_subscription_closed_dict.py b/foundry/v1/models/_subscription_closed_dict.py deleted file mode 100644 index f39a52f5..00000000 --- a/foundry/v1/models/_subscription_closed_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._subscription_closure_cause_dict import SubscriptionClosureCauseDict # NOQA -from foundry.v1.models._subscription_id import SubscriptionId - - -class SubscriptionClosedDict(TypedDict): - """The subscription has been closed due to an irrecoverable error during its lifecycle.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - id: SubscriptionId - - cause: SubscriptionClosureCauseDict - - type: Literal["subscriptionClosed"] diff --git a/foundry/v1/models/_subscription_closure_cause.py b/foundry/v1/models/_subscription_closure_cause.py deleted file mode 100644 index bc1ffc53..00000000 --- a/foundry/v1/models/_subscription_closure_cause.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._error import Error -from foundry.v1.models._reason import Reason - -SubscriptionClosureCause = Annotated[Union[Error, Reason], Field(discriminator="type")] -"""SubscriptionClosureCause""" diff --git a/foundry/v1/models/_subscription_closure_cause_dict.py b/foundry/v1/models/_subscription_closure_cause_dict.py deleted file mode 100644 index 20136287..00000000 --- a/foundry/v1/models/_subscription_closure_cause_dict.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._error_dict import ErrorDict -from foundry.v1.models._reason_dict import ReasonDict - -SubscriptionClosureCauseDict = Annotated[Union[ErrorDict, ReasonDict], Field(discriminator="type")] -"""SubscriptionClosureCause""" diff --git a/foundry/v1/models/_subscription_error.py b/foundry/v1/models/_subscription_error.py deleted file mode 100644 index 48223e4b..00000000 --- a/foundry/v1/models/_subscription_error.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._error import Error -from foundry.v1.models._subscription_error_dict import SubscriptionErrorDict - - -class SubscriptionError(BaseModel): - """SubscriptionError""" - - errors: List[Error] - - type: Literal["error"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> SubscriptionErrorDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SubscriptionErrorDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_subscription_error_dict.py b/foundry/v1/models/_subscription_error_dict.py deleted file mode 100644 index a7c12a49..00000000 --- a/foundry/v1/models/_subscription_error_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._error_dict import ErrorDict - - -class SubscriptionErrorDict(TypedDict): - """SubscriptionError""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - errors: List[ErrorDict] - - type: Literal["error"] diff --git a/foundry/v1/models/_subscription_id.py b/foundry/v1/models/_subscription_id.py deleted file mode 100644 index 97558790..00000000 --- a/foundry/v1/models/_subscription_id.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import UUID - -SubscriptionId = UUID -"""A unique identifier used to associate subscription requests with responses.""" diff --git a/foundry/v1/models/_subscription_success.py b/foundry/v1/models/_subscription_success.py deleted file mode 100644 index a0c5a1f3..00000000 --- a/foundry/v1/models/_subscription_success.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._subscription_id import SubscriptionId -from foundry.v1.models._subscription_success_dict import SubscriptionSuccessDict - - -class SubscriptionSuccess(BaseModel): - """SubscriptionSuccess""" - - id: SubscriptionId - - type: Literal["success"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> SubscriptionSuccessDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SubscriptionSuccessDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_subscription_success_dict.py b/foundry/v1/models/_subscription_success_dict.py deleted file mode 100644 index 55742619..00000000 --- a/foundry/v1/models/_subscription_success_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._subscription_id import SubscriptionId - - -class SubscriptionSuccessDict(TypedDict): - """SubscriptionSuccess""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - id: SubscriptionId - - type: Literal["success"] diff --git a/foundry/v1/models/_sum_aggregation.py b/foundry/v1/models/_sum_aggregation.py deleted file mode 100644 index f879c219..00000000 --- a/foundry/v1/models/_sum_aggregation.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._field_name_v1 import FieldNameV1 -from foundry.v1.models._sum_aggregation_dict import SumAggregationDict - - -class SumAggregation(BaseModel): - """Computes the sum of values for the provided field.""" - - field: FieldNameV1 - - name: Optional[AggregationMetricName] = None - - type: Literal["sum"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> SumAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SumAggregationDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_sum_aggregation_dict.py b/foundry/v1/models/_sum_aggregation_dict.py deleted file mode 100644 index 9a0e8ae9..00000000 --- a/foundry/v1/models/_sum_aggregation_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._field_name_v1 import FieldNameV1 - - -class SumAggregationDict(TypedDict): - """Computes the sum of values for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - name: NotRequired[AggregationMetricName] - - type: Literal["sum"] diff --git a/foundry/v1/models/_sum_aggregation_v2.py b/foundry/v1/models/_sum_aggregation_v2.py deleted file mode 100644 index b1ae8d8f..00000000 --- a/foundry/v1/models/_sum_aggregation_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._sum_aggregation_v2_dict import SumAggregationV2Dict - - -class SumAggregationV2(BaseModel): - """Computes the sum of values for the provided field.""" - - field: PropertyApiName - - name: Optional[AggregationMetricName] = None - - direction: Optional[OrderByDirection] = None - - type: Literal["sum"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> SumAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SumAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_sum_aggregation_v2_dict.py b/foundry/v1/models/_sum_aggregation_v2_dict.py deleted file mode 100644 index 537130b9..00000000 --- a/foundry/v1/models/_sum_aggregation_v2_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._aggregation_metric_name import AggregationMetricName -from foundry.v1.models._order_by_direction import OrderByDirection -from foundry.v1.models._property_api_name import PropertyApiName - - -class SumAggregationV2Dict(TypedDict): - """Computes the sum of values for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - name: NotRequired[AggregationMetricName] - - direction: NotRequired[OrderByDirection] - - type: Literal["sum"] diff --git a/foundry/v1/models/_sync_apply_action_response_v2.py b/foundry/v1/models/_sync_apply_action_response_v2.py deleted file mode 100644 index 61820785..00000000 --- a/foundry/v1/models/_sync_apply_action_response_v2.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._action_results import ActionResults -from foundry.v1.models._sync_apply_action_response_v2_dict import ( - SyncApplyActionResponseV2Dict, -) # NOQA -from foundry.v1.models._validate_action_response_v2 import ValidateActionResponseV2 - - -class SyncApplyActionResponseV2(BaseModel): - """SyncApplyActionResponseV2""" - - validation: Optional[ValidateActionResponseV2] = None - - edits: Optional[ActionResults] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> SyncApplyActionResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - SyncApplyActionResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_sync_apply_action_response_v2_dict.py b/foundry/v1/models/_sync_apply_action_response_v2_dict.py deleted file mode 100644 index 70bbb3bf..00000000 --- a/foundry/v1/models/_sync_apply_action_response_v2_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._action_results_dict import ActionResultsDict -from foundry.v1.models._validate_action_response_v2_dict import ValidateActionResponseV2Dict # NOQA - - -class SyncApplyActionResponseV2Dict(TypedDict): - """SyncApplyActionResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - validation: NotRequired[ValidateActionResponseV2Dict] - - edits: NotRequired[ActionResultsDict] diff --git a/foundry/v1/models/_three_dimensional_aggregation.py b/foundry/v1/models/_three_dimensional_aggregation.py deleted file mode 100644 index a48461a6..00000000 --- a/foundry/v1/models/_three_dimensional_aggregation.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._query_aggregation_key_type import QueryAggregationKeyType -from foundry.v1.models._three_dimensional_aggregation_dict import ( - ThreeDimensionalAggregationDict, -) # NOQA -from foundry.v1.models._two_dimensional_aggregation import TwoDimensionalAggregation - - -class ThreeDimensionalAggregation(BaseModel): - """ThreeDimensionalAggregation""" - - key_type: QueryAggregationKeyType = Field(alias="keyType") - - value_type: TwoDimensionalAggregation = Field(alias="valueType") - - type: Literal["threeDimensionalAggregation"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ThreeDimensionalAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ThreeDimensionalAggregationDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_three_dimensional_aggregation_dict.py b/foundry/v1/models/_three_dimensional_aggregation_dict.py deleted file mode 100644 index db079f7d..00000000 --- a/foundry/v1/models/_three_dimensional_aggregation_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._query_aggregation_key_type_dict import QueryAggregationKeyTypeDict # NOQA -from foundry.v1.models._two_dimensional_aggregation_dict import ( - TwoDimensionalAggregationDict, -) # NOQA - - -class ThreeDimensionalAggregationDict(TypedDict): - """ThreeDimensionalAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyType: QueryAggregationKeyTypeDict - - valueType: TwoDimensionalAggregationDict - - type: Literal["threeDimensionalAggregation"] diff --git a/foundry/v1/models/_time_range.py b/foundry/v1/models/_time_range.py deleted file mode 100644 index 4b257d19..00000000 --- a/foundry/v1/models/_time_range.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._absolute_time_range import AbsoluteTimeRange -from foundry.v1.models._relative_time_range import RelativeTimeRange - -TimeRange = Annotated[Union[AbsoluteTimeRange, RelativeTimeRange], Field(discriminator="type")] -"""An absolute or relative range for a time series query.""" diff --git a/foundry/v1/models/_time_range_dict.py b/foundry/v1/models/_time_range_dict.py deleted file mode 100644 index f152182d..00000000 --- a/foundry/v1/models/_time_range_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._absolute_time_range_dict import AbsoluteTimeRangeDict -from foundry.v1.models._relative_time_range_dict import RelativeTimeRangeDict - -TimeRangeDict = Annotated[ - Union[AbsoluteTimeRangeDict, RelativeTimeRangeDict], Field(discriminator="type") -] -"""An absolute or relative range for a time series query.""" diff --git a/foundry/v1/models/_time_series_item_type.py b/foundry/v1/models/_time_series_item_type.py deleted file mode 100644 index 9bba2ca9..00000000 --- a/foundry/v1/models/_time_series_item_type.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._double_type import DoubleType -from foundry.v1.models._string_type import StringType - -TimeSeriesItemType = Annotated[Union[DoubleType, StringType], Field(discriminator="type")] -"""A union of the types supported by time series properties.""" diff --git a/foundry/v1/models/_time_series_item_type_dict.py b/foundry/v1/models/_time_series_item_type_dict.py deleted file mode 100644 index 534dda89..00000000 --- a/foundry/v1/models/_time_series_item_type_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v1.models._double_type_dict import DoubleTypeDict -from foundry.v1.models._string_type_dict import StringTypeDict - -TimeSeriesItemTypeDict = Annotated[ - Union[DoubleTypeDict, StringTypeDict], Field(discriminator="type") -] -"""A union of the types supported by time series properties.""" diff --git a/foundry/v1/models/_time_series_point.py b/foundry/v1/models/_time_series_point.py deleted file mode 100644 index 2f31ecbf..00000000 --- a/foundry/v1/models/_time_series_point.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime -from typing import Any -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._time_series_point_dict import TimeSeriesPointDict - - -class TimeSeriesPoint(BaseModel): - """A time and value pair.""" - - time: datetime - """An ISO 8601 timestamp""" - - value: Any - """An object which is either an enum String or a double number.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> TimeSeriesPointDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(TimeSeriesPointDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_time_unit.py b/foundry/v1/models/_time_unit.py deleted file mode 100644 index 7407fe7f..00000000 --- a/foundry/v1/models/_time_unit.py +++ /dev/null @@ -1,23 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -TimeUnit = Literal[ - "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS", "QUARTERS" -] -"""TimeUnit""" diff --git a/foundry/v1/models/_timeseries_type.py b/foundry/v1/models/_timeseries_type.py deleted file mode 100644 index 5eba7a63..00000000 --- a/foundry/v1/models/_timeseries_type.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._time_series_item_type import TimeSeriesItemType -from foundry.v1.models._timeseries_type_dict import TimeseriesTypeDict - - -class TimeseriesType(BaseModel): - """TimeseriesType""" - - item_type: TimeSeriesItemType = Field(alias="itemType") - - type: Literal["timeseries"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> TimeseriesTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(TimeseriesTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_timeseries_type_dict.py b/foundry/v1/models/_timeseries_type_dict.py deleted file mode 100644 index a984557a..00000000 --- a/foundry/v1/models/_timeseries_type_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._time_series_item_type_dict import TimeSeriesItemTypeDict - - -class TimeseriesTypeDict(TypedDict): - """TimeseriesType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - itemType: TimeSeriesItemTypeDict - - type: Literal["timeseries"] diff --git a/foundry/v1/models/_timestamp_type.py b/foundry/v1/models/_timestamp_type.py deleted file mode 100644 index 4a7431d9..00000000 --- a/foundry/v1/models/_timestamp_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._timestamp_type_dict import TimestampTypeDict - - -class TimestampType(BaseModel): - """TimestampType""" - - type: Literal["timestamp"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> TimestampTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(TimestampTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_transaction.py b/foundry/v1/models/_transaction.py deleted file mode 100644 index 5c2756c1..00000000 --- a/foundry/v1/models/_transaction.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._transaction_dict import TransactionDict -from foundry.v1.models._transaction_rid import TransactionRid -from foundry.v1.models._transaction_status import TransactionStatus -from foundry.v1.models._transaction_type import TransactionType - - -class Transaction(BaseModel): - """An operation that modifies the files within a dataset.""" - - rid: TransactionRid - - transaction_type: TransactionType = Field(alias="transactionType") - - status: TransactionStatus - - created_time: datetime = Field(alias="createdTime") - """The timestamp when the transaction was created, in ISO 8601 timestamp format.""" - - closed_time: Optional[datetime] = Field(alias="closedTime", default=None) - """The timestamp when the transaction was closed, in ISO 8601 timestamp format.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> TransactionDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(TransactionDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_transaction_dict.py b/foundry/v1/models/_transaction_dict.py deleted file mode 100644 index 1d12eb52..00000000 --- a/foundry/v1/models/_transaction_dict.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v1.models._transaction_rid import TransactionRid -from foundry.v1.models._transaction_status import TransactionStatus -from foundry.v1.models._transaction_type import TransactionType - - -class TransactionDict(TypedDict): - """An operation that modifies the files within a dataset.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: TransactionRid - - transactionType: TransactionType - - status: TransactionStatus - - createdTime: datetime - """The timestamp when the transaction was created, in ISO 8601 timestamp format.""" - - closedTime: NotRequired[datetime] - """The timestamp when the transaction was closed, in ISO 8601 timestamp format.""" diff --git a/foundry/v1/models/_two_dimensional_aggregation.py b/foundry/v1/models/_two_dimensional_aggregation.py deleted file mode 100644 index bb844a17..00000000 --- a/foundry/v1/models/_two_dimensional_aggregation.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._query_aggregation_key_type import QueryAggregationKeyType -from foundry.v1.models._query_aggregation_value_type import QueryAggregationValueType -from foundry.v1.models._two_dimensional_aggregation_dict import ( - TwoDimensionalAggregationDict, -) # NOQA - - -class TwoDimensionalAggregation(BaseModel): - """TwoDimensionalAggregation""" - - key_type: QueryAggregationKeyType = Field(alias="keyType") - - value_type: QueryAggregationValueType = Field(alias="valueType") - - type: Literal["twoDimensionalAggregation"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> TwoDimensionalAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - TwoDimensionalAggregationDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_two_dimensional_aggregation_dict.py b/foundry/v1/models/_two_dimensional_aggregation_dict.py deleted file mode 100644 index bb1bdb16..00000000 --- a/foundry/v1/models/_two_dimensional_aggregation_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._query_aggregation_key_type_dict import QueryAggregationKeyTypeDict # NOQA -from foundry.v1.models._query_aggregation_value_type_dict import ( - QueryAggregationValueTypeDict, -) # NOQA - - -class TwoDimensionalAggregationDict(TypedDict): - """TwoDimensionalAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyType: QueryAggregationKeyTypeDict - - valueType: QueryAggregationValueTypeDict - - type: Literal["twoDimensionalAggregation"] diff --git a/foundry/v1/models/_unevaluable_constraint.py b/foundry/v1/models/_unevaluable_constraint.py deleted file mode 100644 index 0b627a73..00000000 --- a/foundry/v1/models/_unevaluable_constraint.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._unevaluable_constraint_dict import UnevaluableConstraintDict - - -class UnevaluableConstraint(BaseModel): - """ - The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. - This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. - """ - - type: Literal["unevaluable"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> UnevaluableConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(UnevaluableConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_unsupported_type.py b/foundry/v1/models/_unsupported_type.py deleted file mode 100644 index 89d3f493..00000000 --- a/foundry/v1/models/_unsupported_type.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v1.models._unsupported_type_dict import UnsupportedTypeDict - - -class UnsupportedType(BaseModel): - """UnsupportedType""" - - unsupported_type: StrictStr = Field(alias="unsupportedType") - - type: Literal["unsupported"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> UnsupportedTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(UnsupportedTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_updated_time.py b/foundry/v1/models/_updated_time.py deleted file mode 100644 index b668ba7f..00000000 --- a/foundry/v1/models/_updated_time.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -UpdatedTime = StrictStr -"""The time at which the resource was most recently updated.""" diff --git a/foundry/v1/models/_validate_action_request.py b/foundry/v1/models/_validate_action_request.py deleted file mode 100644 index 2ae4de20..00000000 --- a/foundry/v1/models/_validate_action_request.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._validate_action_request_dict import ValidateActionRequestDict - - -class ValidateActionRequest(BaseModel): - """ValidateActionRequest""" - - parameters: Dict[ParameterId, Optional[DataValue]] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ValidateActionRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ValidateActionRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_validate_action_request_dict.py b/foundry/v1/models/_validate_action_request_dict.py deleted file mode 100644 index 5794c455..00000000 --- a/foundry/v1/models/_validate_action_request_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import TypedDict - -from foundry.v1.models._data_value import DataValue -from foundry.v1.models._parameter_id import ParameterId - - -class ValidateActionRequestDict(TypedDict): - """ValidateActionRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v1/models/_validate_action_response.py b/foundry/v1/models/_validate_action_response.py deleted file mode 100644 index 0d2baac5..00000000 --- a/foundry/v1/models/_validate_action_response.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._parameter_evaluation_result import ParameterEvaluationResult -from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._submission_criteria_evaluation import SubmissionCriteriaEvaluation # NOQA -from foundry.v1.models._validate_action_response_dict import ValidateActionResponseDict -from foundry.v1.models._validation_result import ValidationResult - - -class ValidateActionResponse(BaseModel): - """ValidateActionResponse""" - - result: ValidationResult - - submission_criteria: List[SubmissionCriteriaEvaluation] = Field(alias="submissionCriteria") - - parameters: Dict[ParameterId, ParameterEvaluationResult] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ValidateActionResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ValidateActionResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_validate_action_response_dict.py b/foundry/v1/models/_validate_action_response_dict.py deleted file mode 100644 index 74de4382..00000000 --- a/foundry/v1/models/_validate_action_response_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._parameter_evaluation_result_dict import ( - ParameterEvaluationResultDict, -) # NOQA -from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._submission_criteria_evaluation_dict import ( - SubmissionCriteriaEvaluationDict, -) # NOQA -from foundry.v1.models._validation_result import ValidationResult - - -class ValidateActionResponseDict(TypedDict): - """ValidateActionResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - result: ValidationResult - - submissionCriteria: List[SubmissionCriteriaEvaluationDict] - - parameters: Dict[ParameterId, ParameterEvaluationResultDict] diff --git a/foundry/v1/models/_validate_action_response_v2.py b/foundry/v1/models/_validate_action_response_v2.py deleted file mode 100644 index 3e561205..00000000 --- a/foundry/v1/models/_validate_action_response_v2.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v1.models._parameter_evaluation_result import ParameterEvaluationResult -from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._submission_criteria_evaluation import SubmissionCriteriaEvaluation # NOQA -from foundry.v1.models._validate_action_response_v2_dict import ValidateActionResponseV2Dict # NOQA -from foundry.v1.models._validation_result import ValidationResult - - -class ValidateActionResponseV2(BaseModel): - """ValidateActionResponseV2""" - - result: ValidationResult - - submission_criteria: List[SubmissionCriteriaEvaluation] = Field(alias="submissionCriteria") - - parameters: Dict[ParameterId, ParameterEvaluationResult] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ValidateActionResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ValidateActionResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v1/models/_validate_action_response_v2_dict.py b/foundry/v1/models/_validate_action_response_v2_dict.py deleted file mode 100644 index 86074810..00000000 --- a/foundry/v1/models/_validate_action_response_v2_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from typing_extensions import TypedDict - -from foundry.v1.models._parameter_evaluation_result_dict import ( - ParameterEvaluationResultDict, -) # NOQA -from foundry.v1.models._parameter_id import ParameterId -from foundry.v1.models._submission_criteria_evaluation_dict import ( - SubmissionCriteriaEvaluationDict, -) # NOQA -from foundry.v1.models._validation_result import ValidationResult - - -class ValidateActionResponseV2Dict(TypedDict): - """ValidateActionResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - result: ValidationResult - - submissionCriteria: List[SubmissionCriteriaEvaluationDict] - - parameters: Dict[ParameterId, ParameterEvaluationResultDict] diff --git a/foundry/v1/models/_within_bounding_box_point.py b/foundry/v1/models/_within_bounding_box_point.py deleted file mode 100644 index 02e09abd..00000000 --- a/foundry/v1/models/_within_bounding_box_point.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v1.models._geo_point import GeoPoint - -WithinBoundingBoxPoint = GeoPoint -"""WithinBoundingBoxPoint""" diff --git a/foundry/v1/models/_within_bounding_box_point_dict.py b/foundry/v1/models/_within_bounding_box_point_dict.py deleted file mode 100644 index 67009e2f..00000000 --- a/foundry/v1/models/_within_bounding_box_point_dict.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v1.models._geo_point_dict import GeoPointDict - -WithinBoundingBoxPointDict = GeoPointDict -"""WithinBoundingBoxPoint""" diff --git a/foundry/v1/models/_within_bounding_box_query.py b/foundry/v1/models/_within_bounding_box_query.py deleted file mode 100644 index 559b57d4..00000000 --- a/foundry/v1/models/_within_bounding_box_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._bounding_box_value import BoundingBoxValue -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._within_bounding_box_query_dict import WithinBoundingBoxQueryDict - - -class WithinBoundingBoxQuery(BaseModel): - """Returns objects where the specified field contains a point within the bounding box provided.""" - - field: PropertyApiName - - value: BoundingBoxValue - - type: Literal["withinBoundingBox"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> WithinBoundingBoxQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(WithinBoundingBoxQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_within_bounding_box_query_dict.py b/foundry/v1/models/_within_bounding_box_query_dict.py deleted file mode 100644 index 60dfec5c..00000000 --- a/foundry/v1/models/_within_bounding_box_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._bounding_box_value_dict import BoundingBoxValueDict -from foundry.v1.models._property_api_name import PropertyApiName - - -class WithinBoundingBoxQueryDict(TypedDict): - """Returns objects where the specified field contains a point within the bounding box provided.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: BoundingBoxValueDict - - type: Literal["withinBoundingBox"] diff --git a/foundry/v1/models/_within_distance_of_query.py b/foundry/v1/models/_within_distance_of_query.py deleted file mode 100644 index ee00be0a..00000000 --- a/foundry/v1/models/_within_distance_of_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._center_point import CenterPoint -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._within_distance_of_query_dict import WithinDistanceOfQueryDict - - -class WithinDistanceOfQuery(BaseModel): - """Returns objects where the specified field contains a point within the distance provided of the center point.""" - - field: PropertyApiName - - value: CenterPoint - - type: Literal["withinDistanceOf"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> WithinDistanceOfQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(WithinDistanceOfQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_within_distance_of_query_dict.py b/foundry/v1/models/_within_distance_of_query_dict.py deleted file mode 100644 index b45b2225..00000000 --- a/foundry/v1/models/_within_distance_of_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._center_point_dict import CenterPointDict -from foundry.v1.models._property_api_name import PropertyApiName - - -class WithinDistanceOfQueryDict(TypedDict): - """Returns objects where the specified field contains a point within the distance provided of the center point.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: CenterPointDict - - type: Literal["withinDistanceOf"] diff --git a/foundry/v1/models/_within_polygon_query.py b/foundry/v1/models/_within_polygon_query.py deleted file mode 100644 index 94f98729..00000000 --- a/foundry/v1/models/_within_polygon_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v1.models._polygon_value import PolygonValue -from foundry.v1.models._property_api_name import PropertyApiName -from foundry.v1.models._within_polygon_query_dict import WithinPolygonQueryDict - - -class WithinPolygonQuery(BaseModel): - """Returns objects where the specified field contains a point within the polygon provided.""" - - field: PropertyApiName - - value: PolygonValue - - type: Literal["withinPolygon"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> WithinPolygonQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(WithinPolygonQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_within_polygon_query_dict.py b/foundry/v1/models/_within_polygon_query_dict.py deleted file mode 100644 index b5284c8b..00000000 --- a/foundry/v1/models/_within_polygon_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v1.models._polygon_value_dict import PolygonValueDict -from foundry.v1.models._property_api_name import PropertyApiName - - -class WithinPolygonQueryDict(TypedDict): - """Returns objects where the specified field contains a point within the polygon provided.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PolygonValueDict - - type: Literal["withinPolygon"] diff --git a/foundry/v1/ontologies/action.py b/foundry/v1/ontologies/action.py new file mode 100644 index 00000000..13680d35 --- /dev/null +++ b/foundry/v1/ontologies/action.py @@ -0,0 +1,229 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import List +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v1.ontologies.models._action_type_api_name import ActionTypeApiName +from foundry.v1.ontologies.models._apply_action_request_dict import ApplyActionRequestDict # NOQA +from foundry.v1.ontologies.models._apply_action_response import ApplyActionResponse +from foundry.v1.ontologies.models._batch_apply_action_response import ( + BatchApplyActionResponse, +) # NOQA +from foundry.v1.ontologies.models._data_value import DataValue +from foundry.v1.ontologies.models._ontology_rid import OntologyRid +from foundry.v1.ontologies.models._parameter_id import ParameterId +from foundry.v1.ontologies.models._validate_action_response import ValidateActionResponse # NOQA + + +class ActionClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def apply( + self, + ontology_rid: OntologyRid, + action_type: ActionTypeApiName, + *, + parameters: Dict[ParameterId, Optional[DataValue]], + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ApplyActionResponse: + """ + Applies an action using the given parameters. Changes to the Ontology are eventually consistent and may take + some time to be visible. + + Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by + this endpoint. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read api:ontologies-write`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param action_type: actionType + :type action_type: ActionTypeApiName + :param parameters: + :type parameters: Dict[ParameterId, Optional[DataValue]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ApplyActionResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v1/ontologies/{ontologyRid}/actions/{actionType}/apply", + query_params={}, + path_params={ + "ontologyRid": ontology_rid, + "actionType": action_type, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "parameters": parameters, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "parameters": Dict[ParameterId, Optional[DataValue]], + }, + ), + response_type=ApplyActionResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def apply_batch( + self, + ontology_rid: OntologyRid, + action_type: ActionTypeApiName, + *, + requests: List[ApplyActionRequestDict], + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> BatchApplyActionResponse: + """ + Applies multiple actions (of the same Action Type) using the given parameters. + Changes to the Ontology are eventually consistent and may take some time to be visible. + + Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not + call Functions may receive a higher limit. + + Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) and + [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read api:ontologies-write`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param action_type: actionType + :type action_type: ActionTypeApiName + :param requests: + :type requests: List[ApplyActionRequestDict] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: BatchApplyActionResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch", + query_params={}, + path_params={ + "ontologyRid": ontology_rid, + "actionType": action_type, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "requests": requests, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "requests": List[ApplyActionRequestDict], + }, + ), + response_type=BatchApplyActionResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def validate( + self, + ontology_rid: OntologyRid, + action_type: ActionTypeApiName, + *, + parameters: Dict[ParameterId, Optional[DataValue]], + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ValidateActionResponse: + """ + Validates if an action can be run with the given set of parameters. + The response contains the evaluation of parameters and **submission criteria** + that determine if the request is `VALID` or `INVALID`. + For performance reasons, validations will not consider existing objects or other data in Foundry. + For example, the uniqueness of a primary key or the existence of a user ID will not be checked. + Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by + this endpoint. Unspecified parameters will be given a default value of `null`. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param action_type: actionType + :type action_type: ActionTypeApiName + :param parameters: + :type parameters: Dict[ParameterId, Optional[DataValue]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ValidateActionResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v1/ontologies/{ontologyRid}/actions/{actionType}/validate", + query_params={}, + path_params={ + "ontologyRid": ontology_rid, + "actionType": action_type, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "parameters": parameters, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "parameters": Dict[ParameterId, Optional[DataValue]], + }, + ), + response_type=ValidateActionResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v1/ontologies/action_type.py b/foundry/v1/ontologies/action_type.py new file mode 100644 index 00000000..aebca0db --- /dev/null +++ b/foundry/v1/ontologies/action_type.py @@ -0,0 +1,183 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v1.core.models._page_size import PageSize +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._action_type import ActionType +from foundry.v1.ontologies.models._action_type_api_name import ActionTypeApiName +from foundry.v1.ontologies.models._list_action_types_response import ListActionTypesResponse # NOQA +from foundry.v1.ontologies.models._ontology_rid import OntologyRid + + +class ActionTypeClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get( + self, + ontology_rid: OntologyRid, + action_type_api_name: ActionTypeApiName, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ActionType: + """ + Gets a specific action type with the given API name. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param action_type_api_name: actionTypeApiName + :type action_type_api_name: ActionTypeApiName + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ActionType + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName}", + query_params={}, + path_params={ + "ontologyRid": ontology_rid, + "actionTypeApiName": action_type_api_name, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ActionType, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + ontology_rid: OntologyRid, + *, + page_size: Optional[PageSize] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[ActionType]: + """ + Lists the action types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[ActionType] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/actionTypes", + query_params={ + "pageSize": page_size, + }, + path_params={ + "ontologyRid": ontology_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListActionTypesResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + ontology_rid: OntologyRid, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListActionTypesResponse: + """ + Lists the action types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListActionTypesResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/actionTypes", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + }, + path_params={ + "ontologyRid": ontology_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListActionTypesResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v1/ontologies/client.py b/foundry/v1/ontologies/client.py new file mode 100644 index 00000000..0e6491c6 --- /dev/null +++ b/foundry/v1/ontologies/client.py @@ -0,0 +1,30 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry._core import Auth +from foundry.v1.ontologies.action import ActionClient +from foundry.v1.ontologies.ontology import OntologyClient +from foundry.v1.ontologies.ontology_object import OntologyObjectClient +from foundry.v1.ontologies.query import QueryClient + + +class OntologiesClient: + def __init__(self, auth: Auth, hostname: str): + self.Action = ActionClient(auth=auth, hostname=hostname) + self.Ontology = OntologyClient(auth=auth, hostname=hostname) + self.OntologyObject = OntologyObjectClient(auth=auth, hostname=hostname) + self.Query = QueryClient(auth=auth, hostname=hostname) diff --git a/foundry/v1/ontologies/models/__init__.py b/foundry/v1/ontologies/models/__init__.py new file mode 100644 index 00000000..b2fe3a22 --- /dev/null +++ b/foundry/v1/ontologies/models/__init__.py @@ -0,0 +1,430 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from foundry.v1.ontologies.models._action_type import ActionType +from foundry.v1.ontologies.models._action_type_api_name import ActionTypeApiName +from foundry.v1.ontologies.models._action_type_dict import ActionTypeDict +from foundry.v1.ontologies.models._action_type_rid import ActionTypeRid +from foundry.v1.ontologies.models._aggregate_objects_response import ( + AggregateObjectsResponse, +) # NOQA +from foundry.v1.ontologies.models._aggregate_objects_response_dict import ( + AggregateObjectsResponseDict, +) # NOQA +from foundry.v1.ontologies.models._aggregate_objects_response_item import ( + AggregateObjectsResponseItem, +) # NOQA +from foundry.v1.ontologies.models._aggregate_objects_response_item_dict import ( + AggregateObjectsResponseItemDict, +) # NOQA +from foundry.v1.ontologies.models._aggregation_dict import AggregationDict +from foundry.v1.ontologies.models._aggregation_duration_grouping_dict import ( + AggregationDurationGroupingDict, +) # NOQA +from foundry.v1.ontologies.models._aggregation_exact_grouping_dict import ( + AggregationExactGroupingDict, +) # NOQA +from foundry.v1.ontologies.models._aggregation_fixed_width_grouping_dict import ( + AggregationFixedWidthGroupingDict, +) # NOQA +from foundry.v1.ontologies.models._aggregation_group_by_dict import AggregationGroupByDict # NOQA +from foundry.v1.ontologies.models._aggregation_group_key import AggregationGroupKey +from foundry.v1.ontologies.models._aggregation_group_value import AggregationGroupValue +from foundry.v1.ontologies.models._aggregation_metric_name import AggregationMetricName +from foundry.v1.ontologies.models._aggregation_metric_result import AggregationMetricResult # NOQA +from foundry.v1.ontologies.models._aggregation_metric_result_dict import ( + AggregationMetricResultDict, +) # NOQA +from foundry.v1.ontologies.models._aggregation_range_dict import AggregationRangeDict +from foundry.v1.ontologies.models._aggregation_ranges_grouping_dict import ( + AggregationRangesGroupingDict, +) # NOQA +from foundry.v1.ontologies.models._all_terms_query_dict import AllTermsQueryDict +from foundry.v1.ontologies.models._and_query_dict import AndQueryDict +from foundry.v1.ontologies.models._any_term_query_dict import AnyTermQueryDict +from foundry.v1.ontologies.models._apply_action_request_dict import ApplyActionRequestDict # NOQA +from foundry.v1.ontologies.models._apply_action_response import ApplyActionResponse +from foundry.v1.ontologies.models._apply_action_response_dict import ApplyActionResponseDict # NOQA +from foundry.v1.ontologies.models._approximate_distinct_aggregation_dict import ( + ApproximateDistinctAggregationDict, +) # NOQA +from foundry.v1.ontologies.models._array_size_constraint import ArraySizeConstraint +from foundry.v1.ontologies.models._array_size_constraint_dict import ArraySizeConstraintDict # NOQA +from foundry.v1.ontologies.models._avg_aggregation_dict import AvgAggregationDict +from foundry.v1.ontologies.models._batch_apply_action_response import ( + BatchApplyActionResponse, +) # NOQA +from foundry.v1.ontologies.models._batch_apply_action_response_dict import ( + BatchApplyActionResponseDict, +) # NOQA +from foundry.v1.ontologies.models._contains_query_dict import ContainsQueryDict +from foundry.v1.ontologies.models._count_aggregation_dict import CountAggregationDict +from foundry.v1.ontologies.models._create_interface_object_rule import ( + CreateInterfaceObjectRule, +) # NOQA +from foundry.v1.ontologies.models._create_interface_object_rule_dict import ( + CreateInterfaceObjectRuleDict, +) # NOQA +from foundry.v1.ontologies.models._create_link_rule import CreateLinkRule +from foundry.v1.ontologies.models._create_link_rule_dict import CreateLinkRuleDict +from foundry.v1.ontologies.models._create_object_rule import CreateObjectRule +from foundry.v1.ontologies.models._create_object_rule_dict import CreateObjectRuleDict +from foundry.v1.ontologies.models._data_value import DataValue +from foundry.v1.ontologies.models._delete_link_rule import DeleteLinkRule +from foundry.v1.ontologies.models._delete_link_rule_dict import DeleteLinkRuleDict +from foundry.v1.ontologies.models._delete_object_rule import DeleteObjectRule +from foundry.v1.ontologies.models._delete_object_rule_dict import DeleteObjectRuleDict +from foundry.v1.ontologies.models._equals_query_dict import EqualsQueryDict +from foundry.v1.ontologies.models._execute_query_response import ExecuteQueryResponse +from foundry.v1.ontologies.models._execute_query_response_dict import ( + ExecuteQueryResponseDict, +) # NOQA +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 +from foundry.v1.ontologies.models._function_rid import FunctionRid +from foundry.v1.ontologies.models._function_version import FunctionVersion +from foundry.v1.ontologies.models._fuzzy import Fuzzy +from foundry.v1.ontologies.models._group_member_constraint import GroupMemberConstraint +from foundry.v1.ontologies.models._group_member_constraint_dict import ( + GroupMemberConstraintDict, +) # NOQA +from foundry.v1.ontologies.models._gt_query_dict import GtQueryDict +from foundry.v1.ontologies.models._gte_query_dict import GteQueryDict +from foundry.v1.ontologies.models._is_null_query_dict import IsNullQueryDict +from foundry.v1.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v1.ontologies.models._link_type_side import LinkTypeSide +from foundry.v1.ontologies.models._link_type_side_cardinality import LinkTypeSideCardinality # NOQA +from foundry.v1.ontologies.models._link_type_side_dict import LinkTypeSideDict +from foundry.v1.ontologies.models._list_action_types_response import ListActionTypesResponse # NOQA +from foundry.v1.ontologies.models._list_action_types_response_dict import ( + ListActionTypesResponseDict, +) # NOQA +from foundry.v1.ontologies.models._list_linked_objects_response import ( + ListLinkedObjectsResponse, +) # NOQA +from foundry.v1.ontologies.models._list_linked_objects_response_dict import ( + ListLinkedObjectsResponseDict, +) # NOQA +from foundry.v1.ontologies.models._list_object_types_response import ListObjectTypesResponse # NOQA +from foundry.v1.ontologies.models._list_object_types_response_dict import ( + ListObjectTypesResponseDict, +) # NOQA +from foundry.v1.ontologies.models._list_objects_response import ListObjectsResponse +from foundry.v1.ontologies.models._list_objects_response_dict import ListObjectsResponseDict # NOQA +from foundry.v1.ontologies.models._list_ontologies_response import ListOntologiesResponse # NOQA +from foundry.v1.ontologies.models._list_ontologies_response_dict import ( + ListOntologiesResponseDict, +) # NOQA +from foundry.v1.ontologies.models._list_outgoing_link_types_response import ( + ListOutgoingLinkTypesResponse, +) # NOQA +from foundry.v1.ontologies.models._list_outgoing_link_types_response_dict import ( + ListOutgoingLinkTypesResponseDict, +) # NOQA +from foundry.v1.ontologies.models._list_query_types_response import ListQueryTypesResponse # NOQA +from foundry.v1.ontologies.models._list_query_types_response_dict import ( + ListQueryTypesResponseDict, +) # NOQA +from foundry.v1.ontologies.models._logic_rule import LogicRule +from foundry.v1.ontologies.models._logic_rule_dict import LogicRuleDict +from foundry.v1.ontologies.models._lt_query_dict import LtQueryDict +from foundry.v1.ontologies.models._lte_query_dict import LteQueryDict +from foundry.v1.ontologies.models._max_aggregation_dict import MaxAggregationDict +from foundry.v1.ontologies.models._min_aggregation_dict import MinAggregationDict +from foundry.v1.ontologies.models._modify_interface_object_rule import ( + ModifyInterfaceObjectRule, +) # NOQA +from foundry.v1.ontologies.models._modify_interface_object_rule_dict import ( + ModifyInterfaceObjectRuleDict, +) # NOQA +from foundry.v1.ontologies.models._modify_object_rule import ModifyObjectRule +from foundry.v1.ontologies.models._modify_object_rule_dict import ModifyObjectRuleDict +from foundry.v1.ontologies.models._not_query_dict import NotQueryDict +from foundry.v1.ontologies.models._object_property_value_constraint import ( + ObjectPropertyValueConstraint, +) # NOQA +from foundry.v1.ontologies.models._object_property_value_constraint_dict import ( + ObjectPropertyValueConstraintDict, +) # NOQA +from foundry.v1.ontologies.models._object_query_result_constraint import ( + ObjectQueryResultConstraint, +) # NOQA +from foundry.v1.ontologies.models._object_query_result_constraint_dict import ( + ObjectQueryResultConstraintDict, +) # NOQA +from foundry.v1.ontologies.models._object_rid import ObjectRid +from foundry.v1.ontologies.models._object_type import ObjectType +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v1.ontologies.models._object_type_dict import ObjectTypeDict +from foundry.v1.ontologies.models._object_type_rid import ObjectTypeRid +from foundry.v1.ontologies.models._object_type_visibility import ObjectTypeVisibility +from foundry.v1.ontologies.models._one_of_constraint import OneOfConstraint +from foundry.v1.ontologies.models._one_of_constraint_dict import OneOfConstraintDict +from foundry.v1.ontologies.models._ontology import Ontology +from foundry.v1.ontologies.models._ontology_api_name import OntologyApiName +from foundry.v1.ontologies.models._ontology_array_type import OntologyArrayType +from foundry.v1.ontologies.models._ontology_array_type_dict import OntologyArrayTypeDict +from foundry.v1.ontologies.models._ontology_data_type import OntologyDataType +from foundry.v1.ontologies.models._ontology_data_type_dict import OntologyDataTypeDict +from foundry.v1.ontologies.models._ontology_dict import OntologyDict +from foundry.v1.ontologies.models._ontology_map_type import OntologyMapType +from foundry.v1.ontologies.models._ontology_map_type_dict import OntologyMapTypeDict +from foundry.v1.ontologies.models._ontology_object import OntologyObject +from foundry.v1.ontologies.models._ontology_object_dict import OntologyObjectDict +from foundry.v1.ontologies.models._ontology_object_set_type import OntologyObjectSetType +from foundry.v1.ontologies.models._ontology_object_set_type_dict import ( + OntologyObjectSetTypeDict, +) # NOQA +from foundry.v1.ontologies.models._ontology_object_type import OntologyObjectType +from foundry.v1.ontologies.models._ontology_object_type_dict import OntologyObjectTypeDict # NOQA +from foundry.v1.ontologies.models._ontology_rid import OntologyRid +from foundry.v1.ontologies.models._ontology_set_type import OntologySetType +from foundry.v1.ontologies.models._ontology_set_type_dict import OntologySetTypeDict +from foundry.v1.ontologies.models._ontology_struct_field import OntologyStructField +from foundry.v1.ontologies.models._ontology_struct_field_dict import OntologyStructFieldDict # NOQA +from foundry.v1.ontologies.models._ontology_struct_type import OntologyStructType +from foundry.v1.ontologies.models._ontology_struct_type_dict import OntologyStructTypeDict # NOQA +from foundry.v1.ontologies.models._or_query_dict import OrQueryDict +from foundry.v1.ontologies.models._order_by import OrderBy +from foundry.v1.ontologies.models._parameter import Parameter +from foundry.v1.ontologies.models._parameter_dict import ParameterDict +from foundry.v1.ontologies.models._parameter_evaluated_constraint import ( + ParameterEvaluatedConstraint, +) # NOQA +from foundry.v1.ontologies.models._parameter_evaluated_constraint_dict import ( + ParameterEvaluatedConstraintDict, +) # NOQA +from foundry.v1.ontologies.models._parameter_evaluation_result import ( + ParameterEvaluationResult, +) # NOQA +from foundry.v1.ontologies.models._parameter_evaluation_result_dict import ( + ParameterEvaluationResultDict, +) # NOQA +from foundry.v1.ontologies.models._parameter_id import ParameterId +from foundry.v1.ontologies.models._parameter_option import ParameterOption +from foundry.v1.ontologies.models._parameter_option_dict import ParameterOptionDict +from foundry.v1.ontologies.models._phrase_query_dict import PhraseQueryDict +from foundry.v1.ontologies.models._prefix_query_dict import PrefixQueryDict +from foundry.v1.ontologies.models._property import Property +from foundry.v1.ontologies.models._property_api_name import PropertyApiName +from foundry.v1.ontologies.models._property_dict import PropertyDict +from foundry.v1.ontologies.models._property_value import PropertyValue +from foundry.v1.ontologies.models._property_value_escaped_string import ( + PropertyValueEscapedString, +) # NOQA +from foundry.v1.ontologies.models._query_api_name import QueryApiName +from foundry.v1.ontologies.models._query_type import QueryType +from foundry.v1.ontologies.models._query_type_dict import QueryTypeDict +from foundry.v1.ontologies.models._range_constraint import RangeConstraint +from foundry.v1.ontologies.models._range_constraint_dict import RangeConstraintDict +from foundry.v1.ontologies.models._search_json_query_dict import SearchJsonQueryDict +from foundry.v1.ontologies.models._search_objects_response import SearchObjectsResponse +from foundry.v1.ontologies.models._search_objects_response_dict import ( + SearchObjectsResponseDict, +) # NOQA +from foundry.v1.ontologies.models._search_order_by_dict import SearchOrderByDict +from foundry.v1.ontologies.models._search_ordering_dict import SearchOrderingDict +from foundry.v1.ontologies.models._selected_property_api_name import SelectedPropertyApiName # NOQA +from foundry.v1.ontologies.models._string_length_constraint import StringLengthConstraint # NOQA +from foundry.v1.ontologies.models._string_length_constraint_dict import ( + StringLengthConstraintDict, +) # NOQA +from foundry.v1.ontologies.models._string_regex_match_constraint import ( + StringRegexMatchConstraint, +) # NOQA +from foundry.v1.ontologies.models._string_regex_match_constraint_dict import ( + StringRegexMatchConstraintDict, +) # NOQA +from foundry.v1.ontologies.models._submission_criteria_evaluation import ( + SubmissionCriteriaEvaluation, +) # NOQA +from foundry.v1.ontologies.models._submission_criteria_evaluation_dict import ( + SubmissionCriteriaEvaluationDict, +) # NOQA +from foundry.v1.ontologies.models._sum_aggregation_dict import SumAggregationDict +from foundry.v1.ontologies.models._unevaluable_constraint import UnevaluableConstraint +from foundry.v1.ontologies.models._unevaluable_constraint_dict import ( + UnevaluableConstraintDict, +) # NOQA +from foundry.v1.ontologies.models._validate_action_response import ValidateActionResponse # NOQA +from foundry.v1.ontologies.models._validate_action_response_dict import ( + ValidateActionResponseDict, +) # NOQA +from foundry.v1.ontologies.models._validation_result import ValidationResult +from foundry.v1.ontologies.models._value_type import ValueType + +__all__ = [ + "ActionType", + "ActionTypeApiName", + "ActionTypeDict", + "ActionTypeRid", + "AggregateObjectsResponse", + "AggregateObjectsResponseDict", + "AggregateObjectsResponseItem", + "AggregateObjectsResponseItemDict", + "AggregationDict", + "AggregationDurationGroupingDict", + "AggregationExactGroupingDict", + "AggregationFixedWidthGroupingDict", + "AggregationGroupByDict", + "AggregationGroupKey", + "AggregationGroupValue", + "AggregationMetricName", + "AggregationMetricResult", + "AggregationMetricResultDict", + "AggregationRangeDict", + "AggregationRangesGroupingDict", + "AllTermsQueryDict", + "AndQueryDict", + "AnyTermQueryDict", + "ApplyActionRequestDict", + "ApplyActionResponse", + "ApplyActionResponseDict", + "ApproximateDistinctAggregationDict", + "ArraySizeConstraint", + "ArraySizeConstraintDict", + "AvgAggregationDict", + "BatchApplyActionResponse", + "BatchApplyActionResponseDict", + "ContainsQueryDict", + "CountAggregationDict", + "CreateInterfaceObjectRule", + "CreateInterfaceObjectRuleDict", + "CreateLinkRule", + "CreateLinkRuleDict", + "CreateObjectRule", + "CreateObjectRuleDict", + "DataValue", + "DeleteLinkRule", + "DeleteLinkRuleDict", + "DeleteObjectRule", + "DeleteObjectRuleDict", + "EqualsQueryDict", + "ExecuteQueryResponse", + "ExecuteQueryResponseDict", + "FieldNameV1", + "FunctionRid", + "FunctionVersion", + "Fuzzy", + "GroupMemberConstraint", + "GroupMemberConstraintDict", + "GtQueryDict", + "GteQueryDict", + "IsNullQueryDict", + "LinkTypeApiName", + "LinkTypeSide", + "LinkTypeSideCardinality", + "LinkTypeSideDict", + "ListActionTypesResponse", + "ListActionTypesResponseDict", + "ListLinkedObjectsResponse", + "ListLinkedObjectsResponseDict", + "ListObjectTypesResponse", + "ListObjectTypesResponseDict", + "ListObjectsResponse", + "ListObjectsResponseDict", + "ListOntologiesResponse", + "ListOntologiesResponseDict", + "ListOutgoingLinkTypesResponse", + "ListOutgoingLinkTypesResponseDict", + "ListQueryTypesResponse", + "ListQueryTypesResponseDict", + "LogicRule", + "LogicRuleDict", + "LtQueryDict", + "LteQueryDict", + "MaxAggregationDict", + "MinAggregationDict", + "ModifyInterfaceObjectRule", + "ModifyInterfaceObjectRuleDict", + "ModifyObjectRule", + "ModifyObjectRuleDict", + "NotQueryDict", + "ObjectPropertyValueConstraint", + "ObjectPropertyValueConstraintDict", + "ObjectQueryResultConstraint", + "ObjectQueryResultConstraintDict", + "ObjectRid", + "ObjectType", + "ObjectTypeApiName", + "ObjectTypeDict", + "ObjectTypeRid", + "ObjectTypeVisibility", + "OneOfConstraint", + "OneOfConstraintDict", + "Ontology", + "OntologyApiName", + "OntologyArrayType", + "OntologyArrayTypeDict", + "OntologyDataType", + "OntologyDataTypeDict", + "OntologyDict", + "OntologyMapType", + "OntologyMapTypeDict", + "OntologyObject", + "OntologyObjectDict", + "OntologyObjectSetType", + "OntologyObjectSetTypeDict", + "OntologyObjectType", + "OntologyObjectTypeDict", + "OntologyRid", + "OntologySetType", + "OntologySetTypeDict", + "OntologyStructField", + "OntologyStructFieldDict", + "OntologyStructType", + "OntologyStructTypeDict", + "OrQueryDict", + "OrderBy", + "Parameter", + "ParameterDict", + "ParameterEvaluatedConstraint", + "ParameterEvaluatedConstraintDict", + "ParameterEvaluationResult", + "ParameterEvaluationResultDict", + "ParameterId", + "ParameterOption", + "ParameterOptionDict", + "PhraseQueryDict", + "PrefixQueryDict", + "Property", + "PropertyApiName", + "PropertyDict", + "PropertyValue", + "PropertyValueEscapedString", + "QueryApiName", + "QueryType", + "QueryTypeDict", + "RangeConstraint", + "RangeConstraintDict", + "SearchJsonQueryDict", + "SearchObjectsResponse", + "SearchObjectsResponseDict", + "SearchOrderByDict", + "SearchOrderingDict", + "SelectedPropertyApiName", + "StringLengthConstraint", + "StringLengthConstraintDict", + "StringRegexMatchConstraint", + "StringRegexMatchConstraintDict", + "SubmissionCriteriaEvaluation", + "SubmissionCriteriaEvaluationDict", + "SumAggregationDict", + "UnevaluableConstraint", + "UnevaluableConstraintDict", + "ValidateActionResponse", + "ValidateActionResponseDict", + "ValidationResult", + "ValueType", +] diff --git a/foundry/v1/ontologies/models/_action_type.py b/foundry/v1/ontologies/models/_action_type.py new file mode 100644 index 00000000..162af791 --- /dev/null +++ b/foundry/v1/ontologies/models/_action_type.py @@ -0,0 +1,58 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v1.core.models._display_name import DisplayName +from foundry.v1.core.models._release_status import ReleaseStatus +from foundry.v1.ontologies.models._action_type_api_name import ActionTypeApiName +from foundry.v1.ontologies.models._action_type_dict import ActionTypeDict +from foundry.v1.ontologies.models._action_type_rid import ActionTypeRid +from foundry.v1.ontologies.models._logic_rule import LogicRule +from foundry.v1.ontologies.models._parameter import Parameter +from foundry.v1.ontologies.models._parameter_id import ParameterId + + +class ActionType(BaseModel): + """Represents an action type in the Ontology.""" + + api_name: ActionTypeApiName = Field(alias="apiName") + + description: Optional[StrictStr] = None + + display_name: Optional[DisplayName] = Field(alias="displayName", default=None) + + status: ReleaseStatus + + parameters: Dict[ParameterId, Parameter] + + rid: ActionTypeRid + + operations: List[LogicRule] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ActionTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ActionTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_action_type_api_name.py b/foundry/v1/ontologies/models/_action_type_api_name.py similarity index 100% rename from foundry/v1/models/_action_type_api_name.py rename to foundry/v1/ontologies/models/_action_type_api_name.py diff --git a/foundry/v1/ontologies/models/_action_type_dict.py b/foundry/v1/ontologies/models/_action_type_dict.py new file mode 100644 index 00000000..70b02e3f --- /dev/null +++ b/foundry/v1/ontologies/models/_action_type_dict.py @@ -0,0 +1,51 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._display_name import DisplayName +from foundry.v1.core.models._release_status import ReleaseStatus +from foundry.v1.ontologies.models._action_type_api_name import ActionTypeApiName +from foundry.v1.ontologies.models._action_type_rid import ActionTypeRid +from foundry.v1.ontologies.models._logic_rule_dict import LogicRuleDict +from foundry.v1.ontologies.models._parameter_dict import ParameterDict +from foundry.v1.ontologies.models._parameter_id import ParameterId + + +class ActionTypeDict(TypedDict): + """Represents an action type in the Ontology.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + apiName: ActionTypeApiName + + description: NotRequired[StrictStr] + + displayName: NotRequired[DisplayName] + + status: ReleaseStatus + + parameters: Dict[ParameterId, ParameterDict] + + rid: ActionTypeRid + + operations: List[LogicRuleDict] diff --git a/foundry/v1/models/_action_type_rid.py b/foundry/v1/ontologies/models/_action_type_rid.py similarity index 100% rename from foundry/v1/models/_action_type_rid.py rename to foundry/v1/ontologies/models/_action_type_rid.py diff --git a/foundry/v1/ontologies/models/_aggregate_objects_response.py b/foundry/v1/ontologies/models/_aggregate_objects_response.py new file mode 100644 index 00000000..537dc338 --- /dev/null +++ b/foundry/v1/ontologies/models/_aggregate_objects_response.py @@ -0,0 +1,50 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictInt + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._aggregate_objects_response_dict import ( + AggregateObjectsResponseDict, +) # NOQA +from foundry.v1.ontologies.models._aggregate_objects_response_item import ( + AggregateObjectsResponseItem, +) # NOQA + + +class AggregateObjectsResponse(BaseModel): + """AggregateObjectsResponse""" + + excluded_items: Optional[StrictInt] = Field(alias="excludedItems", default=None) + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[AggregateObjectsResponseItem] + + model_config = {"extra": "allow"} + + def to_dict(self) -> AggregateObjectsResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + AggregateObjectsResponseDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v1/ontologies/models/_aggregate_objects_response_dict.py b/foundry/v1/ontologies/models/_aggregate_objects_response_dict.py new file mode 100644 index 00000000..556103b9 --- /dev/null +++ b/foundry/v1/ontologies/models/_aggregate_objects_response_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from pydantic import StrictInt +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._aggregate_objects_response_item_dict import ( + AggregateObjectsResponseItemDict, +) # NOQA + + +class AggregateObjectsResponseDict(TypedDict): + """AggregateObjectsResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + excludedItems: NotRequired[StrictInt] + + nextPageToken: NotRequired[PageToken] + + data: List[AggregateObjectsResponseItemDict] diff --git a/foundry/v1/ontologies/models/_aggregate_objects_response_item.py b/foundry/v1/ontologies/models/_aggregate_objects_response_item.py new file mode 100644 index 00000000..3e76b18c --- /dev/null +++ b/foundry/v1/ontologies/models/_aggregate_objects_response_item.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._aggregate_objects_response_item_dict import ( + AggregateObjectsResponseItemDict, +) # NOQA +from foundry.v1.ontologies.models._aggregation_group_key import AggregationGroupKey +from foundry.v1.ontologies.models._aggregation_group_value import AggregationGroupValue +from foundry.v1.ontologies.models._aggregation_metric_result import AggregationMetricResult # NOQA + + +class AggregateObjectsResponseItem(BaseModel): + """AggregateObjectsResponseItem""" + + group: Dict[AggregationGroupKey, AggregationGroupValue] + + metrics: List[AggregationMetricResult] + + model_config = {"extra": "allow"} + + def to_dict(self) -> AggregateObjectsResponseItemDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + AggregateObjectsResponseItemDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v1/ontologies/models/_aggregate_objects_response_item_dict.py b/foundry/v1/ontologies/models/_aggregate_objects_response_item_dict.py new file mode 100644 index 00000000..414d0a1b --- /dev/null +++ b/foundry/v1/ontologies/models/_aggregate_objects_response_item_dict.py @@ -0,0 +1,37 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._aggregation_group_key import AggregationGroupKey +from foundry.v1.ontologies.models._aggregation_group_value import AggregationGroupValue +from foundry.v1.ontologies.models._aggregation_metric_result_dict import ( + AggregationMetricResultDict, +) # NOQA + + +class AggregateObjectsResponseItemDict(TypedDict): + """AggregateObjectsResponseItem""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + group: Dict[AggregationGroupKey, AggregationGroupValue] + + metrics: List[AggregationMetricResultDict] diff --git a/foundry/v1/ontologies/models/_aggregation_dict.py b/foundry/v1/ontologies/models/_aggregation_dict.py new file mode 100644 index 00000000..571ffeff --- /dev/null +++ b/foundry/v1/ontologies/models/_aggregation_dict.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v1.ontologies.models._approximate_distinct_aggregation_dict import ( + ApproximateDistinctAggregationDict, +) # NOQA +from foundry.v1.ontologies.models._avg_aggregation_dict import AvgAggregationDict +from foundry.v1.ontologies.models._count_aggregation_dict import CountAggregationDict +from foundry.v1.ontologies.models._max_aggregation_dict import MaxAggregationDict +from foundry.v1.ontologies.models._min_aggregation_dict import MinAggregationDict +from foundry.v1.ontologies.models._sum_aggregation_dict import SumAggregationDict + +AggregationDict = Annotated[ + Union[ + ApproximateDistinctAggregationDict, + MinAggregationDict, + AvgAggregationDict, + MaxAggregationDict, + CountAggregationDict, + SumAggregationDict, + ], + Field(discriminator="type"), +] +"""Specifies an aggregation function.""" diff --git a/foundry/v1/ontologies/models/_aggregation_duration_grouping_dict.py b/foundry/v1/ontologies/models/_aggregation_duration_grouping_dict.py new file mode 100644 index 00000000..63fdf0bd --- /dev/null +++ b/foundry/v1/ontologies/models/_aggregation_duration_grouping_dict.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.core.models._duration import Duration +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 + + +class AggregationDurationGroupingDict(TypedDict): + """ + Divides objects into groups according to an interval. Note that this grouping applies only on date types. + The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + duration: Duration + + type: Literal["duration"] diff --git a/foundry/v1/ontologies/models/_aggregation_exact_grouping_dict.py b/foundry/v1/ontologies/models/_aggregation_exact_grouping_dict.py new file mode 100644 index 00000000..75f43157 --- /dev/null +++ b/foundry/v1/ontologies/models/_aggregation_exact_grouping_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictInt +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 + + +class AggregationExactGroupingDict(TypedDict): + """Divides objects into groups according to an exact value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + maxGroupCount: NotRequired[StrictInt] + + type: Literal["exact"] diff --git a/foundry/v1/ontologies/models/_aggregation_fixed_width_grouping_dict.py b/foundry/v1/ontologies/models/_aggregation_fixed_width_grouping_dict.py new file mode 100644 index 00000000..c338ce3e --- /dev/null +++ b/foundry/v1/ontologies/models/_aggregation_fixed_width_grouping_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictInt +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 + + +class AggregationFixedWidthGroupingDict(TypedDict): + """Divides objects into groups with the specified width.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + fixedWidth: StrictInt + + type: Literal["fixedWidth"] diff --git a/foundry/v1/ontologies/models/_aggregation_group_by_dict.py b/foundry/v1/ontologies/models/_aggregation_group_by_dict.py new file mode 100644 index 00000000..1efea740 --- /dev/null +++ b/foundry/v1/ontologies/models/_aggregation_group_by_dict.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v1.ontologies.models._aggregation_duration_grouping_dict import ( + AggregationDurationGroupingDict, +) # NOQA +from foundry.v1.ontologies.models._aggregation_exact_grouping_dict import ( + AggregationExactGroupingDict, +) # NOQA +from foundry.v1.ontologies.models._aggregation_fixed_width_grouping_dict import ( + AggregationFixedWidthGroupingDict, +) # NOQA +from foundry.v1.ontologies.models._aggregation_ranges_grouping_dict import ( + AggregationRangesGroupingDict, +) # NOQA + +AggregationGroupByDict = Annotated[ + Union[ + AggregationDurationGroupingDict, + AggregationFixedWidthGroupingDict, + AggregationRangesGroupingDict, + AggregationExactGroupingDict, + ], + Field(discriminator="type"), +] +"""Specifies a grouping for aggregation results.""" diff --git a/foundry/v1/models/_aggregation_group_key.py b/foundry/v1/ontologies/models/_aggregation_group_key.py similarity index 100% rename from foundry/v1/models/_aggregation_group_key.py rename to foundry/v1/ontologies/models/_aggregation_group_key.py diff --git a/foundry/v1/models/_aggregation_group_value.py b/foundry/v1/ontologies/models/_aggregation_group_value.py similarity index 100% rename from foundry/v1/models/_aggregation_group_value.py rename to foundry/v1/ontologies/models/_aggregation_group_value.py diff --git a/foundry/v1/models/_aggregation_metric_name.py b/foundry/v1/ontologies/models/_aggregation_metric_name.py similarity index 100% rename from foundry/v1/models/_aggregation_metric_name.py rename to foundry/v1/ontologies/models/_aggregation_metric_name.py diff --git a/foundry/v1/ontologies/models/_aggregation_metric_result.py b/foundry/v1/ontologies/models/_aggregation_metric_result.py new file mode 100644 index 00000000..3fe66bd3 --- /dev/null +++ b/foundry/v1/ontologies/models/_aggregation_metric_result.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import StrictFloat +from pydantic import StrictStr + +from foundry.v1.ontologies.models._aggregation_metric_result_dict import ( + AggregationMetricResultDict, +) # NOQA + + +class AggregationMetricResult(BaseModel): + """AggregationMetricResult""" + + name: StrictStr + + value: Optional[StrictFloat] = None + """TBD""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> AggregationMetricResultDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(AggregationMetricResultDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_aggregation_metric_result_dict.py b/foundry/v1/ontologies/models/_aggregation_metric_result_dict.py similarity index 100% rename from foundry/v1/models/_aggregation_metric_result_dict.py rename to foundry/v1/ontologies/models/_aggregation_metric_result_dict.py diff --git a/foundry/v1/models/_aggregation_range_dict.py b/foundry/v1/ontologies/models/_aggregation_range_dict.py similarity index 100% rename from foundry/v1/models/_aggregation_range_dict.py rename to foundry/v1/ontologies/models/_aggregation_range_dict.py diff --git a/foundry/v1/ontologies/models/_aggregation_ranges_grouping_dict.py b/foundry/v1/ontologies/models/_aggregation_ranges_grouping_dict.py new file mode 100644 index 00000000..86b63956 --- /dev/null +++ b/foundry/v1/ontologies/models/_aggregation_ranges_grouping_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._aggregation_range_dict import AggregationRangeDict +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 + + +class AggregationRangesGroupingDict(TypedDict): + """Divides objects into groups according to specified ranges.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + ranges: List[AggregationRangeDict] + + type: Literal["ranges"] diff --git a/foundry/v1/ontologies/models/_all_terms_query_dict.py b/foundry/v1/ontologies/models/_all_terms_query_dict.py new file mode 100644 index 00000000..3ca10104 --- /dev/null +++ b/foundry/v1/ontologies/models/_all_terms_query_dict.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 +from foundry.v1.ontologies.models._fuzzy import Fuzzy + + +class AllTermsQueryDict(TypedDict): + """ + Returns objects where the specified field contains all of the whitespace separated words in any + order in the provided value. This query supports fuzzy matching. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + value: StrictStr + + fuzzy: NotRequired[Fuzzy] + + type: Literal["allTerms"] diff --git a/foundry/v1/ontologies/models/_and_query_dict.py b/foundry/v1/ontologies/models/_and_query_dict.py new file mode 100644 index 00000000..56323456 --- /dev/null +++ b/foundry/v1/ontologies/models/_and_query_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._search_json_query_dict import SearchJsonQueryDict + + +class AndQueryDict(TypedDict): + """Returns objects where every query is satisfied.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: List[SearchJsonQueryDict] + + type: Literal["and"] diff --git a/foundry/v1/ontologies/models/_any_term_query_dict.py b/foundry/v1/ontologies/models/_any_term_query_dict.py new file mode 100644 index 00000000..04117d5f --- /dev/null +++ b/foundry/v1/ontologies/models/_any_term_query_dict.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 +from foundry.v1.ontologies.models._fuzzy import Fuzzy + + +class AnyTermQueryDict(TypedDict): + """ + Returns objects where the specified field contains any of the whitespace separated words in any + order in the provided value. This query supports fuzzy matching. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + value: StrictStr + + fuzzy: NotRequired[Fuzzy] + + type: Literal["anyTerm"] diff --git a/foundry/v1/ontologies/models/_apply_action_request_dict.py b/foundry/v1/ontologies/models/_apply_action_request_dict.py new file mode 100644 index 00000000..af2a90df --- /dev/null +++ b/foundry/v1/ontologies/models/_apply_action_request_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import Optional + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._data_value import DataValue +from foundry.v1.ontologies.models._parameter_id import ParameterId + + +class ApplyActionRequestDict(TypedDict): + """ApplyActionRequest""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v1/ontologies/models/_apply_action_response.py b/foundry/v1/ontologies/models/_apply_action_response.py new file mode 100644 index 00000000..00072ff5 --- /dev/null +++ b/foundry/v1/ontologies/models/_apply_action_response.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._apply_action_response_dict import ApplyActionResponseDict # NOQA + + +class ApplyActionResponse(BaseModel): + """ApplyActionResponse""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ApplyActionResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ApplyActionResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_apply_action_response_dict.py b/foundry/v1/ontologies/models/_apply_action_response_dict.py similarity index 100% rename from foundry/v1/models/_apply_action_response_dict.py rename to foundry/v1/ontologies/models/_apply_action_response_dict.py diff --git a/foundry/v1/ontologies/models/_approximate_distinct_aggregation_dict.py b/foundry/v1/ontologies/models/_approximate_distinct_aggregation_dict.py new file mode 100644 index 00000000..2cf895b5 --- /dev/null +++ b/foundry/v1/ontologies/models/_approximate_distinct_aggregation_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._aggregation_metric_name import AggregationMetricName +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 + + +class ApproximateDistinctAggregationDict(TypedDict): + """Computes an approximate number of distinct values for the provided field.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + name: NotRequired[AggregationMetricName] + + type: Literal["approximateDistinct"] diff --git a/foundry/v1/ontologies/models/_array_size_constraint.py b/foundry/v1/ontologies/models/_array_size_constraint.py new file mode 100644 index 00000000..616ede48 --- /dev/null +++ b/foundry/v1/ontologies/models/_array_size_constraint.py @@ -0,0 +1,49 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._array_size_constraint_dict import ArraySizeConstraintDict # NOQA + + +class ArraySizeConstraint(BaseModel): + """The parameter expects an array of values and the size of the array must fall within the defined range.""" + + lt: Optional[Any] = None + """Less than""" + + lte: Optional[Any] = None + """Less than or equal""" + + gt: Optional[Any] = None + """Greater than""" + + gte: Optional[Any] = None + """Greater than or equal""" + + type: Literal["arraySize"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ArraySizeConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ArraySizeConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_array_size_constraint_dict.py b/foundry/v1/ontologies/models/_array_size_constraint_dict.py similarity index 100% rename from foundry/v1/models/_array_size_constraint_dict.py rename to foundry/v1/ontologies/models/_array_size_constraint_dict.py diff --git a/foundry/v1/ontologies/models/_avg_aggregation_dict.py b/foundry/v1/ontologies/models/_avg_aggregation_dict.py new file mode 100644 index 00000000..c8804422 --- /dev/null +++ b/foundry/v1/ontologies/models/_avg_aggregation_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._aggregation_metric_name import AggregationMetricName +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 + + +class AvgAggregationDict(TypedDict): + """Computes the average value for the provided field.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + name: NotRequired[AggregationMetricName] + + type: Literal["avg"] diff --git a/foundry/v1/ontologies/models/_batch_apply_action_response.py b/foundry/v1/ontologies/models/_batch_apply_action_response.py new file mode 100644 index 00000000..a25eee9d --- /dev/null +++ b/foundry/v1/ontologies/models/_batch_apply_action_response.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._batch_apply_action_response_dict import ( + BatchApplyActionResponseDict, +) # NOQA + + +class BatchApplyActionResponse(BaseModel): + """BatchApplyActionResponse""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> BatchApplyActionResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + BatchApplyActionResponseDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v1/models/_batch_apply_action_response_dict.py b/foundry/v1/ontologies/models/_batch_apply_action_response_dict.py similarity index 100% rename from foundry/v1/models/_batch_apply_action_response_dict.py rename to foundry/v1/ontologies/models/_batch_apply_action_response_dict.py diff --git a/foundry/v1/ontologies/models/_contains_query_dict.py b/foundry/v1/ontologies/models/_contains_query_dict.py new file mode 100644 index 00000000..f150fb50 --- /dev/null +++ b/foundry/v1/ontologies/models/_contains_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 +from foundry.v1.ontologies.models._property_value import PropertyValue + + +class ContainsQueryDict(TypedDict): + """Returns objects where the specified array contains a value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + value: PropertyValue + + type: Literal["contains"] diff --git a/foundry/v1/ontologies/models/_count_aggregation_dict.py b/foundry/v1/ontologies/models/_count_aggregation_dict.py new file mode 100644 index 00000000..2d8a7037 --- /dev/null +++ b/foundry/v1/ontologies/models/_count_aggregation_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._aggregation_metric_name import AggregationMetricName + + +class CountAggregationDict(TypedDict): + """Computes the total count of objects.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + name: NotRequired[AggregationMetricName] + + type: Literal["count"] diff --git a/foundry/v1/ontologies/models/_create_interface_object_rule.py b/foundry/v1/ontologies/models/_create_interface_object_rule.py new file mode 100644 index 00000000..e125bd73 --- /dev/null +++ b/foundry/v1/ontologies/models/_create_interface_object_rule.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._create_interface_object_rule_dict import ( + CreateInterfaceObjectRuleDict, +) # NOQA + + +class CreateInterfaceObjectRule(BaseModel): + """CreateInterfaceObjectRule""" + + type: Literal["createInterfaceObject"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> CreateInterfaceObjectRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + CreateInterfaceObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v1/ontologies/models/_create_interface_object_rule_dict.py b/foundry/v1/ontologies/models/_create_interface_object_rule_dict.py new file mode 100644 index 00000000..37803055 --- /dev/null +++ b/foundry/v1/ontologies/models/_create_interface_object_rule_dict.py @@ -0,0 +1,28 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + + +class CreateInterfaceObjectRuleDict(TypedDict): + """CreateInterfaceObjectRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + type: Literal["createInterfaceObject"] diff --git a/foundry/v1/ontologies/models/_create_link_rule.py b/foundry/v1/ontologies/models/_create_link_rule.py new file mode 100644 index 00000000..3e37fb50 --- /dev/null +++ b/foundry/v1/ontologies/models/_create_link_rule.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.ontologies.models._create_link_rule_dict import CreateLinkRuleDict +from foundry.v1.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class CreateLinkRule(BaseModel): + """CreateLinkRule""" + + link_type_api_name_ato_b: LinkTypeApiName = Field(alias="linkTypeApiNameAtoB") + + link_type_api_name_bto_a: LinkTypeApiName = Field(alias="linkTypeApiNameBtoA") + + a_side_object_type_api_name: ObjectTypeApiName = Field(alias="aSideObjectTypeApiName") + + b_side_object_type_api_name: ObjectTypeApiName = Field(alias="bSideObjectTypeApiName") + + type: Literal["createLink"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> CreateLinkRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(CreateLinkRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_create_link_rule_dict.py b/foundry/v1/ontologies/models/_create_link_rule_dict.py new file mode 100644 index 00000000..3bf698fe --- /dev/null +++ b/foundry/v1/ontologies/models/_create_link_rule_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class CreateLinkRuleDict(TypedDict): + """CreateLinkRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + linkTypeApiNameAtoB: LinkTypeApiName + + linkTypeApiNameBtoA: LinkTypeApiName + + aSideObjectTypeApiName: ObjectTypeApiName + + bSideObjectTypeApiName: ObjectTypeApiName + + type: Literal["createLink"] diff --git a/foundry/v1/ontologies/models/_create_object_rule.py b/foundry/v1/ontologies/models/_create_object_rule.py new file mode 100644 index 00000000..bbb1a691 --- /dev/null +++ b/foundry/v1/ontologies/models/_create_object_rule.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.ontologies.models._create_object_rule_dict import CreateObjectRuleDict +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class CreateObjectRule(BaseModel): + """CreateObjectRule""" + + object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") + + type: Literal["createObject"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> CreateObjectRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(CreateObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_create_object_rule_dict.py b/foundry/v1/ontologies/models/_create_object_rule_dict.py new file mode 100644 index 00000000..a47620f6 --- /dev/null +++ b/foundry/v1/ontologies/models/_create_object_rule_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class CreateObjectRuleDict(TypedDict): + """CreateObjectRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectTypeApiName: ObjectTypeApiName + + type: Literal["createObject"] diff --git a/foundry/v1/models/_data_value.py b/foundry/v1/ontologies/models/_data_value.py similarity index 100% rename from foundry/v1/models/_data_value.py rename to foundry/v1/ontologies/models/_data_value.py diff --git a/foundry/v1/ontologies/models/_delete_link_rule.py b/foundry/v1/ontologies/models/_delete_link_rule.py new file mode 100644 index 00000000..a6549c37 --- /dev/null +++ b/foundry/v1/ontologies/models/_delete_link_rule.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.ontologies.models._delete_link_rule_dict import DeleteLinkRuleDict +from foundry.v1.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class DeleteLinkRule(BaseModel): + """DeleteLinkRule""" + + link_type_api_name_ato_b: LinkTypeApiName = Field(alias="linkTypeApiNameAtoB") + + link_type_api_name_bto_a: LinkTypeApiName = Field(alias="linkTypeApiNameBtoA") + + a_side_object_type_api_name: ObjectTypeApiName = Field(alias="aSideObjectTypeApiName") + + b_side_object_type_api_name: ObjectTypeApiName = Field(alias="bSideObjectTypeApiName") + + type: Literal["deleteLink"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> DeleteLinkRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(DeleteLinkRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_delete_link_rule_dict.py b/foundry/v1/ontologies/models/_delete_link_rule_dict.py new file mode 100644 index 00000000..72d5b04e --- /dev/null +++ b/foundry/v1/ontologies/models/_delete_link_rule_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class DeleteLinkRuleDict(TypedDict): + """DeleteLinkRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + linkTypeApiNameAtoB: LinkTypeApiName + + linkTypeApiNameBtoA: LinkTypeApiName + + aSideObjectTypeApiName: ObjectTypeApiName + + bSideObjectTypeApiName: ObjectTypeApiName + + type: Literal["deleteLink"] diff --git a/foundry/v1/ontologies/models/_delete_object_rule.py b/foundry/v1/ontologies/models/_delete_object_rule.py new file mode 100644 index 00000000..bd8ea712 --- /dev/null +++ b/foundry/v1/ontologies/models/_delete_object_rule.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.ontologies.models._delete_object_rule_dict import DeleteObjectRuleDict +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class DeleteObjectRule(BaseModel): + """DeleteObjectRule""" + + object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") + + type: Literal["deleteObject"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> DeleteObjectRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(DeleteObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_delete_object_rule_dict.py b/foundry/v1/ontologies/models/_delete_object_rule_dict.py new file mode 100644 index 00000000..f7f8b0a9 --- /dev/null +++ b/foundry/v1/ontologies/models/_delete_object_rule_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class DeleteObjectRuleDict(TypedDict): + """DeleteObjectRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectTypeApiName: ObjectTypeApiName + + type: Literal["deleteObject"] diff --git a/foundry/v1/ontologies/models/_equals_query_dict.py b/foundry/v1/ontologies/models/_equals_query_dict.py new file mode 100644 index 00000000..13458c96 --- /dev/null +++ b/foundry/v1/ontologies/models/_equals_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 +from foundry.v1.ontologies.models._property_value import PropertyValue + + +class EqualsQueryDict(TypedDict): + """Returns objects where the specified field is equal to a value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + value: PropertyValue + + type: Literal["eq"] diff --git a/foundry/v1/ontologies/models/_execute_query_response.py b/foundry/v1/ontologies/models/_execute_query_response.py new file mode 100644 index 00000000..aff74597 --- /dev/null +++ b/foundry/v1/ontologies/models/_execute_query_response.py @@ -0,0 +1,37 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._data_value import DataValue +from foundry.v1.ontologies.models._execute_query_response_dict import ( + ExecuteQueryResponseDict, +) # NOQA + + +class ExecuteQueryResponse(BaseModel): + """ExecuteQueryResponse""" + + value: DataValue + + model_config = {"extra": "allow"} + + def to_dict(self) -> ExecuteQueryResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ExecuteQueryResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_execute_query_response_dict.py b/foundry/v1/ontologies/models/_execute_query_response_dict.py new file mode 100644 index 00000000..b0286fca --- /dev/null +++ b/foundry/v1/ontologies/models/_execute_query_response_dict.py @@ -0,0 +1,28 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._data_value import DataValue + + +class ExecuteQueryResponseDict(TypedDict): + """ExecuteQueryResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: DataValue diff --git a/foundry/v1/models/_field_name_v1.py b/foundry/v1/ontologies/models/_field_name_v1.py similarity index 100% rename from foundry/v1/models/_field_name_v1.py rename to foundry/v1/ontologies/models/_field_name_v1.py diff --git a/foundry/v1/models/_function_rid.py b/foundry/v1/ontologies/models/_function_rid.py similarity index 100% rename from foundry/v1/models/_function_rid.py rename to foundry/v1/ontologies/models/_function_rid.py diff --git a/foundry/v1/models/_function_version.py b/foundry/v1/ontologies/models/_function_version.py similarity index 100% rename from foundry/v1/models/_function_version.py rename to foundry/v1/ontologies/models/_function_version.py diff --git a/foundry/v1/models/_fuzzy.py b/foundry/v1/ontologies/models/_fuzzy.py similarity index 100% rename from foundry/v1/models/_fuzzy.py rename to foundry/v1/ontologies/models/_fuzzy.py diff --git a/foundry/v1/ontologies/models/_group_member_constraint.py b/foundry/v1/ontologies/models/_group_member_constraint.py new file mode 100644 index 00000000..88267db6 --- /dev/null +++ b/foundry/v1/ontologies/models/_group_member_constraint.py @@ -0,0 +1,37 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._group_member_constraint_dict import ( + GroupMemberConstraintDict, +) # NOQA + + +class GroupMemberConstraint(BaseModel): + """The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.""" + + type: Literal["groupMember"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> GroupMemberConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(GroupMemberConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_group_member_constraint_dict.py b/foundry/v1/ontologies/models/_group_member_constraint_dict.py similarity index 100% rename from foundry/v1/models/_group_member_constraint_dict.py rename to foundry/v1/ontologies/models/_group_member_constraint_dict.py diff --git a/foundry/v1/ontologies/models/_gt_query_dict.py b/foundry/v1/ontologies/models/_gt_query_dict.py new file mode 100644 index 00000000..e64145eb --- /dev/null +++ b/foundry/v1/ontologies/models/_gt_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 +from foundry.v1.ontologies.models._property_value import PropertyValue + + +class GtQueryDict(TypedDict): + """Returns objects where the specified field is greater than a value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + value: PropertyValue + + type: Literal["gt"] diff --git a/foundry/v1/ontologies/models/_gte_query_dict.py b/foundry/v1/ontologies/models/_gte_query_dict.py new file mode 100644 index 00000000..eb2886e5 --- /dev/null +++ b/foundry/v1/ontologies/models/_gte_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 +from foundry.v1.ontologies.models._property_value import PropertyValue + + +class GteQueryDict(TypedDict): + """Returns objects where the specified field is greater than or equal to a value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + value: PropertyValue + + type: Literal["gte"] diff --git a/foundry/v1/ontologies/models/_is_null_query_dict.py b/foundry/v1/ontologies/models/_is_null_query_dict.py new file mode 100644 index 00000000..610501d3 --- /dev/null +++ b/foundry/v1/ontologies/models/_is_null_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictBool +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 + + +class IsNullQueryDict(TypedDict): + """Returns objects based on the existence of the specified field.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + value: StrictBool + + type: Literal["isNull"] diff --git a/foundry/v1/models/_link_type_api_name.py b/foundry/v1/ontologies/models/_link_type_api_name.py similarity index 100% rename from foundry/v1/models/_link_type_api_name.py rename to foundry/v1/ontologies/models/_link_type_api_name.py diff --git a/foundry/v1/ontologies/models/_link_type_side.py b/foundry/v1/ontologies/models/_link_type_side.py new file mode 100644 index 00000000..061ccf2f --- /dev/null +++ b/foundry/v1/ontologies/models/_link_type_side.py @@ -0,0 +1,54 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.core.models._display_name import DisplayName +from foundry.v1.core.models._release_status import ReleaseStatus +from foundry.v1.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v1.ontologies.models._link_type_side_cardinality import LinkTypeSideCardinality # NOQA +from foundry.v1.ontologies.models._link_type_side_dict import LinkTypeSideDict +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v1.ontologies.models._property_api_name import PropertyApiName + + +class LinkTypeSide(BaseModel): + """LinkTypeSide""" + + api_name: LinkTypeApiName = Field(alias="apiName") + + display_name: DisplayName = Field(alias="displayName") + + status: ReleaseStatus + + object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") + + cardinality: LinkTypeSideCardinality + + foreign_key_property_api_name: Optional[PropertyApiName] = Field( + alias="foreignKeyPropertyApiName", default=None + ) + + model_config = {"extra": "allow"} + + def to_dict(self) -> LinkTypeSideDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(LinkTypeSideDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_link_type_side_cardinality.py b/foundry/v1/ontologies/models/_link_type_side_cardinality.py similarity index 100% rename from foundry/v1/models/_link_type_side_cardinality.py rename to foundry/v1/ontologies/models/_link_type_side_cardinality.py diff --git a/foundry/v1/ontologies/models/_link_type_side_dict.py b/foundry/v1/ontologies/models/_link_type_side_dict.py new file mode 100644 index 00000000..a541327b --- /dev/null +++ b/foundry/v1/ontologies/models/_link_type_side_dict.py @@ -0,0 +1,44 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._display_name import DisplayName +from foundry.v1.core.models._release_status import ReleaseStatus +from foundry.v1.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v1.ontologies.models._link_type_side_cardinality import LinkTypeSideCardinality # NOQA +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v1.ontologies.models._property_api_name import PropertyApiName + + +class LinkTypeSideDict(TypedDict): + """LinkTypeSide""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + apiName: LinkTypeApiName + + displayName: DisplayName + + status: ReleaseStatus + + objectTypeApiName: ObjectTypeApiName + + cardinality: LinkTypeSideCardinality + + foreignKeyPropertyApiName: NotRequired[PropertyApiName] diff --git a/foundry/v1/ontologies/models/_list_action_types_response.py b/foundry/v1/ontologies/models/_list_action_types_response.py new file mode 100644 index 00000000..ebdf39de --- /dev/null +++ b/foundry/v1/ontologies/models/_list_action_types_response.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._action_type import ActionType +from foundry.v1.ontologies.models._list_action_types_response_dict import ( + ListActionTypesResponseDict, +) # NOQA + + +class ListActionTypesResponse(BaseModel): + """ListActionTypesResponse""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[ActionType] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListActionTypesResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ListActionTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_list_action_types_response_dict.py b/foundry/v1/ontologies/models/_list_action_types_response_dict.py new file mode 100644 index 00000000..49671a05 --- /dev/null +++ b/foundry/v1/ontologies/models/_list_action_types_response_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._action_type_dict import ActionTypeDict + + +class ListActionTypesResponseDict(TypedDict): + """ListActionTypesResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nextPageToken: NotRequired[PageToken] + + data: List[ActionTypeDict] diff --git a/foundry/v1/ontologies/models/_list_linked_objects_response.py b/foundry/v1/ontologies/models/_list_linked_objects_response.py new file mode 100644 index 00000000..4d03bf3d --- /dev/null +++ b/foundry/v1/ontologies/models/_list_linked_objects_response.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._list_linked_objects_response_dict import ( + ListLinkedObjectsResponseDict, +) # NOQA +from foundry.v1.ontologies.models._ontology_object import OntologyObject + + +class ListLinkedObjectsResponse(BaseModel): + """ListLinkedObjectsResponse""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[OntologyObject] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListLinkedObjectsResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ListLinkedObjectsResponseDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v1/ontologies/models/_list_linked_objects_response_dict.py b/foundry/v1/ontologies/models/_list_linked_objects_response_dict.py new file mode 100644 index 00000000..439cb95e --- /dev/null +++ b/foundry/v1/ontologies/models/_list_linked_objects_response_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._ontology_object_dict import OntologyObjectDict + + +class ListLinkedObjectsResponseDict(TypedDict): + """ListLinkedObjectsResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nextPageToken: NotRequired[PageToken] + + data: List[OntologyObjectDict] diff --git a/foundry/v1/ontologies/models/_list_object_types_response.py b/foundry/v1/ontologies/models/_list_object_types_response.py new file mode 100644 index 00000000..6b73043e --- /dev/null +++ b/foundry/v1/ontologies/models/_list_object_types_response.py @@ -0,0 +1,44 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._list_object_types_response_dict import ( + ListObjectTypesResponseDict, +) # NOQA +from foundry.v1.ontologies.models._object_type import ObjectType + + +class ListObjectTypesResponse(BaseModel): + """ListObjectTypesResponse""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[ObjectType] + """The list of object types in the current page.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListObjectTypesResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ListObjectTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_list_object_types_response_dict.py b/foundry/v1/ontologies/models/_list_object_types_response_dict.py new file mode 100644 index 00000000..043ca864 --- /dev/null +++ b/foundry/v1/ontologies/models/_list_object_types_response_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._object_type_dict import ObjectTypeDict + + +class ListObjectTypesResponseDict(TypedDict): + """ListObjectTypesResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nextPageToken: NotRequired[PageToken] + + data: List[ObjectTypeDict] + """The list of object types in the current page.""" diff --git a/foundry/v1/ontologies/models/_list_objects_response.py b/foundry/v1/ontologies/models/_list_objects_response.py new file mode 100644 index 00000000..d33c755c --- /dev/null +++ b/foundry/v1/ontologies/models/_list_objects_response.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.core.models._total_count import TotalCount +from foundry.v1.ontologies.models._list_objects_response_dict import ListObjectsResponseDict # NOQA +from foundry.v1.ontologies.models._ontology_object import OntologyObject + + +class ListObjectsResponse(BaseModel): + """ListObjectsResponse""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[OntologyObject] + """The list of objects in the current page.""" + + total_count: TotalCount = Field(alias="totalCount") + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListObjectsResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ListObjectsResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_list_objects_response_dict.py b/foundry/v1/ontologies/models/_list_objects_response_dict.py new file mode 100644 index 00000000..4c641c99 --- /dev/null +++ b/foundry/v1/ontologies/models/_list_objects_response_dict.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.core.models._total_count import TotalCount +from foundry.v1.ontologies.models._ontology_object_dict import OntologyObjectDict + + +class ListObjectsResponseDict(TypedDict): + """ListObjectsResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nextPageToken: NotRequired[PageToken] + + data: List[OntologyObjectDict] + """The list of objects in the current page.""" + + totalCount: TotalCount diff --git a/foundry/v1/ontologies/models/_list_ontologies_response.py b/foundry/v1/ontologies/models/_list_ontologies_response.py new file mode 100644 index 00000000..600b1594 --- /dev/null +++ b/foundry/v1/ontologies/models/_list_ontologies_response.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._list_ontologies_response_dict import ( + ListOntologiesResponseDict, +) # NOQA +from foundry.v1.ontologies.models._ontology import Ontology + + +class ListOntologiesResponse(BaseModel): + """ListOntologiesResponse""" + + data: List[Ontology] + """The list of Ontologies the user has access to.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListOntologiesResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ListOntologiesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_list_ontologies_response_dict.py b/foundry/v1/ontologies/models/_list_ontologies_response_dict.py new file mode 100644 index 00000000..7aeed316 --- /dev/null +++ b/foundry/v1/ontologies/models/_list_ontologies_response_dict.py @@ -0,0 +1,31 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._ontology_dict import OntologyDict + + +class ListOntologiesResponseDict(TypedDict): + """ListOntologiesResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + data: List[OntologyDict] + """The list of Ontologies the user has access to.""" diff --git a/foundry/v1/ontologies/models/_list_outgoing_link_types_response.py b/foundry/v1/ontologies/models/_list_outgoing_link_types_response.py new file mode 100644 index 00000000..864108b6 --- /dev/null +++ b/foundry/v1/ontologies/models/_list_outgoing_link_types_response.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._link_type_side import LinkTypeSide +from foundry.v1.ontologies.models._list_outgoing_link_types_response_dict import ( + ListOutgoingLinkTypesResponseDict, +) # NOQA + + +class ListOutgoingLinkTypesResponse(BaseModel): + """ListOutgoingLinkTypesResponse""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[LinkTypeSide] + """The list of link type sides in the current page.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListOutgoingLinkTypesResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ListOutgoingLinkTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v1/ontologies/models/_list_outgoing_link_types_response_dict.py b/foundry/v1/ontologies/models/_list_outgoing_link_types_response_dict.py new file mode 100644 index 00000000..c58b0f19 --- /dev/null +++ b/foundry/v1/ontologies/models/_list_outgoing_link_types_response_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._link_type_side_dict import LinkTypeSideDict + + +class ListOutgoingLinkTypesResponseDict(TypedDict): + """ListOutgoingLinkTypesResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nextPageToken: NotRequired[PageToken] + + data: List[LinkTypeSideDict] + """The list of link type sides in the current page.""" diff --git a/foundry/v1/ontologies/models/_list_query_types_response.py b/foundry/v1/ontologies/models/_list_query_types_response.py new file mode 100644 index 00000000..b5af0885 --- /dev/null +++ b/foundry/v1/ontologies/models/_list_query_types_response.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._list_query_types_response_dict import ( + ListQueryTypesResponseDict, +) # NOQA +from foundry.v1.ontologies.models._query_type import QueryType + + +class ListQueryTypesResponse(BaseModel): + """ListQueryTypesResponse""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[QueryType] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListQueryTypesResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ListQueryTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_list_query_types_response_dict.py b/foundry/v1/ontologies/models/_list_query_types_response_dict.py new file mode 100644 index 00000000..0806c99e --- /dev/null +++ b/foundry/v1/ontologies/models/_list_query_types_response_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._query_type_dict import QueryTypeDict + + +class ListQueryTypesResponseDict(TypedDict): + """ListQueryTypesResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nextPageToken: NotRequired[PageToken] + + data: List[QueryTypeDict] diff --git a/foundry/v1/ontologies/models/_logic_rule.py b/foundry/v1/ontologies/models/_logic_rule.py new file mode 100644 index 00000000..3da296ab --- /dev/null +++ b/foundry/v1/ontologies/models/_logic_rule.py @@ -0,0 +1,47 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v1.ontologies.models._create_interface_object_rule import ( + CreateInterfaceObjectRule, +) # NOQA +from foundry.v1.ontologies.models._create_link_rule import CreateLinkRule +from foundry.v1.ontologies.models._create_object_rule import CreateObjectRule +from foundry.v1.ontologies.models._delete_link_rule import DeleteLinkRule +from foundry.v1.ontologies.models._delete_object_rule import DeleteObjectRule +from foundry.v1.ontologies.models._modify_interface_object_rule import ( + ModifyInterfaceObjectRule, +) # NOQA +from foundry.v1.ontologies.models._modify_object_rule import ModifyObjectRule + +LogicRule = Annotated[ + Union[ + ModifyInterfaceObjectRule, + ModifyObjectRule, + DeleteObjectRule, + CreateInterfaceObjectRule, + DeleteLinkRule, + CreateObjectRule, + CreateLinkRule, + ], + Field(discriminator="type"), +] +"""LogicRule""" diff --git a/foundry/v1/ontologies/models/_logic_rule_dict.py b/foundry/v1/ontologies/models/_logic_rule_dict.py new file mode 100644 index 00000000..1b75fb49 --- /dev/null +++ b/foundry/v1/ontologies/models/_logic_rule_dict.py @@ -0,0 +1,47 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v1.ontologies.models._create_interface_object_rule_dict import ( + CreateInterfaceObjectRuleDict, +) # NOQA +from foundry.v1.ontologies.models._create_link_rule_dict import CreateLinkRuleDict +from foundry.v1.ontologies.models._create_object_rule_dict import CreateObjectRuleDict +from foundry.v1.ontologies.models._delete_link_rule_dict import DeleteLinkRuleDict +from foundry.v1.ontologies.models._delete_object_rule_dict import DeleteObjectRuleDict +from foundry.v1.ontologies.models._modify_interface_object_rule_dict import ( + ModifyInterfaceObjectRuleDict, +) # NOQA +from foundry.v1.ontologies.models._modify_object_rule_dict import ModifyObjectRuleDict + +LogicRuleDict = Annotated[ + Union[ + ModifyInterfaceObjectRuleDict, + ModifyObjectRuleDict, + DeleteObjectRuleDict, + CreateInterfaceObjectRuleDict, + DeleteLinkRuleDict, + CreateObjectRuleDict, + CreateLinkRuleDict, + ], + Field(discriminator="type"), +] +"""LogicRule""" diff --git a/foundry/v1/ontologies/models/_lt_query_dict.py b/foundry/v1/ontologies/models/_lt_query_dict.py new file mode 100644 index 00000000..921e99d0 --- /dev/null +++ b/foundry/v1/ontologies/models/_lt_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 +from foundry.v1.ontologies.models._property_value import PropertyValue + + +class LtQueryDict(TypedDict): + """Returns objects where the specified field is less than a value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + value: PropertyValue + + type: Literal["lt"] diff --git a/foundry/v1/ontologies/models/_lte_query_dict.py b/foundry/v1/ontologies/models/_lte_query_dict.py new file mode 100644 index 00000000..aec4f5ae --- /dev/null +++ b/foundry/v1/ontologies/models/_lte_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 +from foundry.v1.ontologies.models._property_value import PropertyValue + + +class LteQueryDict(TypedDict): + """Returns objects where the specified field is less than or equal to a value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + value: PropertyValue + + type: Literal["lte"] diff --git a/foundry/v1/ontologies/models/_max_aggregation_dict.py b/foundry/v1/ontologies/models/_max_aggregation_dict.py new file mode 100644 index 00000000..9c82b496 --- /dev/null +++ b/foundry/v1/ontologies/models/_max_aggregation_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._aggregation_metric_name import AggregationMetricName +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 + + +class MaxAggregationDict(TypedDict): + """Computes the maximum value for the provided field.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + name: NotRequired[AggregationMetricName] + + type: Literal["max"] diff --git a/foundry/v1/ontologies/models/_min_aggregation_dict.py b/foundry/v1/ontologies/models/_min_aggregation_dict.py new file mode 100644 index 00000000..f8b89b7c --- /dev/null +++ b/foundry/v1/ontologies/models/_min_aggregation_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._aggregation_metric_name import AggregationMetricName +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 + + +class MinAggregationDict(TypedDict): + """Computes the minimum value for the provided field.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + name: NotRequired[AggregationMetricName] + + type: Literal["min"] diff --git a/foundry/v1/ontologies/models/_modify_interface_object_rule.py b/foundry/v1/ontologies/models/_modify_interface_object_rule.py new file mode 100644 index 00000000..9becb27f --- /dev/null +++ b/foundry/v1/ontologies/models/_modify_interface_object_rule.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._modify_interface_object_rule_dict import ( + ModifyInterfaceObjectRuleDict, +) # NOQA + + +class ModifyInterfaceObjectRule(BaseModel): + """ModifyInterfaceObjectRule""" + + type: Literal["modifyInterfaceObject"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ModifyInterfaceObjectRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ModifyInterfaceObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v1/ontologies/models/_modify_interface_object_rule_dict.py b/foundry/v1/ontologies/models/_modify_interface_object_rule_dict.py new file mode 100644 index 00000000..2ce1db20 --- /dev/null +++ b/foundry/v1/ontologies/models/_modify_interface_object_rule_dict.py @@ -0,0 +1,28 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + + +class ModifyInterfaceObjectRuleDict(TypedDict): + """ModifyInterfaceObjectRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + type: Literal["modifyInterfaceObject"] diff --git a/foundry/v1/ontologies/models/_modify_object_rule.py b/foundry/v1/ontologies/models/_modify_object_rule.py new file mode 100644 index 00000000..8caeee18 --- /dev/null +++ b/foundry/v1/ontologies/models/_modify_object_rule.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.ontologies.models._modify_object_rule_dict import ModifyObjectRuleDict +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class ModifyObjectRule(BaseModel): + """ModifyObjectRule""" + + object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") + + type: Literal["modifyObject"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ModifyObjectRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ModifyObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_modify_object_rule_dict.py b/foundry/v1/ontologies/models/_modify_object_rule_dict.py new file mode 100644 index 00000000..c06cbb8c --- /dev/null +++ b/foundry/v1/ontologies/models/_modify_object_rule_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class ModifyObjectRuleDict(TypedDict): + """ModifyObjectRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectTypeApiName: ObjectTypeApiName + + type: Literal["modifyObject"] diff --git a/foundry/v1/ontologies/models/_not_query_dict.py b/foundry/v1/ontologies/models/_not_query_dict.py new file mode 100644 index 00000000..5bce360c --- /dev/null +++ b/foundry/v1/ontologies/models/_not_query_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._search_json_query_dict import SearchJsonQueryDict + + +class NotQueryDict(TypedDict): + """Returns objects where the query is not satisfied.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: SearchJsonQueryDict + + type: Literal["not"] diff --git a/foundry/v1/ontologies/models/_object_property_value_constraint.py b/foundry/v1/ontologies/models/_object_property_value_constraint.py new file mode 100644 index 00000000..3ef93fd6 --- /dev/null +++ b/foundry/v1/ontologies/models/_object_property_value_constraint.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._object_property_value_constraint_dict import ( + ObjectPropertyValueConstraintDict, +) # NOQA + + +class ObjectPropertyValueConstraint(BaseModel): + """The parameter value must be a property value of an object found within an object set.""" + + type: Literal["objectPropertyValue"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectPropertyValueConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ObjectPropertyValueConstraintDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v1/models/_object_property_value_constraint_dict.py b/foundry/v1/ontologies/models/_object_property_value_constraint_dict.py similarity index 100% rename from foundry/v1/models/_object_property_value_constraint_dict.py rename to foundry/v1/ontologies/models/_object_property_value_constraint_dict.py diff --git a/foundry/v1/ontologies/models/_object_query_result_constraint.py b/foundry/v1/ontologies/models/_object_query_result_constraint.py new file mode 100644 index 00000000..57862117 --- /dev/null +++ b/foundry/v1/ontologies/models/_object_query_result_constraint.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._object_query_result_constraint_dict import ( + ObjectQueryResultConstraintDict, +) # NOQA + + +class ObjectQueryResultConstraint(BaseModel): + """The parameter value must be the primary key of an object found within an object set.""" + + type: Literal["objectQueryResult"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectQueryResultConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ObjectQueryResultConstraintDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v1/models/_object_query_result_constraint_dict.py b/foundry/v1/ontologies/models/_object_query_result_constraint_dict.py similarity index 100% rename from foundry/v1/models/_object_query_result_constraint_dict.py rename to foundry/v1/ontologies/models/_object_query_result_constraint_dict.py diff --git a/foundry/v1/models/_object_rid.py b/foundry/v1/ontologies/models/_object_rid.py similarity index 100% rename from foundry/v1/models/_object_rid.py rename to foundry/v1/ontologies/models/_object_rid.py diff --git a/foundry/v1/ontologies/models/_object_type.py b/foundry/v1/ontologies/models/_object_type.py new file mode 100644 index 00000000..2a6bbac0 --- /dev/null +++ b/foundry/v1/ontologies/models/_object_type.py @@ -0,0 +1,63 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v1.core.models._display_name import DisplayName +from foundry.v1.core.models._release_status import ReleaseStatus +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v1.ontologies.models._object_type_dict import ObjectTypeDict +from foundry.v1.ontologies.models._object_type_rid import ObjectTypeRid +from foundry.v1.ontologies.models._object_type_visibility import ObjectTypeVisibility +from foundry.v1.ontologies.models._property import Property +from foundry.v1.ontologies.models._property_api_name import PropertyApiName + + +class ObjectType(BaseModel): + """Represents an object type in the Ontology.""" + + api_name: ObjectTypeApiName = Field(alias="apiName") + + display_name: Optional[DisplayName] = Field(alias="displayName", default=None) + + status: ReleaseStatus + + description: Optional[StrictStr] = None + """The description of the object type.""" + + visibility: Optional[ObjectTypeVisibility] = None + + primary_key: List[PropertyApiName] = Field(alias="primaryKey") + """The primary key of the object. This is a list of properties that can be used to uniquely identify the object.""" + + properties: Dict[PropertyApiName, Property] + """A map of the properties of the object type.""" + + rid: ObjectTypeRid + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ObjectTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_object_type_api_name.py b/foundry/v1/ontologies/models/_object_type_api_name.py similarity index 100% rename from foundry/v1/models/_object_type_api_name.py rename to foundry/v1/ontologies/models/_object_type_api_name.py diff --git a/foundry/v1/ontologies/models/_object_type_dict.py b/foundry/v1/ontologies/models/_object_type_dict.py new file mode 100644 index 00000000..96019d69 --- /dev/null +++ b/foundry/v1/ontologies/models/_object_type_dict.py @@ -0,0 +1,56 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._display_name import DisplayName +from foundry.v1.core.models._release_status import ReleaseStatus +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v1.ontologies.models._object_type_rid import ObjectTypeRid +from foundry.v1.ontologies.models._object_type_visibility import ObjectTypeVisibility +from foundry.v1.ontologies.models._property_api_name import PropertyApiName +from foundry.v1.ontologies.models._property_dict import PropertyDict + + +class ObjectTypeDict(TypedDict): + """Represents an object type in the Ontology.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + apiName: ObjectTypeApiName + + displayName: NotRequired[DisplayName] + + status: ReleaseStatus + + description: NotRequired[StrictStr] + """The description of the object type.""" + + visibility: NotRequired[ObjectTypeVisibility] + + primaryKey: List[PropertyApiName] + """The primary key of the object. This is a list of properties that can be used to uniquely identify the object.""" + + properties: Dict[PropertyApiName, PropertyDict] + """A map of the properties of the object type.""" + + rid: ObjectTypeRid diff --git a/foundry/v1/models/_object_type_rid.py b/foundry/v1/ontologies/models/_object_type_rid.py similarity index 100% rename from foundry/v1/models/_object_type_rid.py rename to foundry/v1/ontologies/models/_object_type_rid.py diff --git a/foundry/v1/models/_object_type_visibility.py b/foundry/v1/ontologies/models/_object_type_visibility.py similarity index 100% rename from foundry/v1/models/_object_type_visibility.py rename to foundry/v1/ontologies/models/_object_type_visibility.py diff --git a/foundry/v1/ontologies/models/_one_of_constraint.py b/foundry/v1/ontologies/models/_one_of_constraint.py new file mode 100644 index 00000000..55b374e5 --- /dev/null +++ b/foundry/v1/ontologies/models/_one_of_constraint.py @@ -0,0 +1,44 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictBool + +from foundry.v1.ontologies.models._one_of_constraint_dict import OneOfConstraintDict +from foundry.v1.ontologies.models._parameter_option import ParameterOption + + +class OneOfConstraint(BaseModel): + """The parameter has a manually predefined set of options.""" + + options: List[ParameterOption] + + other_values_allowed: StrictBool = Field(alias="otherValuesAllowed") + """A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**.""" + + type: Literal["oneOf"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OneOfConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OneOfConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_one_of_constraint_dict.py b/foundry/v1/ontologies/models/_one_of_constraint_dict.py new file mode 100644 index 00000000..750ce4a8 --- /dev/null +++ b/foundry/v1/ontologies/models/_one_of_constraint_dict.py @@ -0,0 +1,37 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from pydantic import StrictBool +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._parameter_option_dict import ParameterOptionDict + + +class OneOfConstraintDict(TypedDict): + """The parameter has a manually predefined set of options.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + options: List[ParameterOptionDict] + + otherValuesAllowed: StrictBool + """A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**.""" + + type: Literal["oneOf"] diff --git a/foundry/v1/ontologies/models/_ontology.py b/foundry/v1/ontologies/models/_ontology.py new file mode 100644 index 00000000..83b0df4c --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v1.core.models._display_name import DisplayName +from foundry.v1.ontologies.models._ontology_api_name import OntologyApiName +from foundry.v1.ontologies.models._ontology_dict import OntologyDict +from foundry.v1.ontologies.models._ontology_rid import OntologyRid + + +class Ontology(BaseModel): + """Metadata about an Ontology.""" + + api_name: OntologyApiName = Field(alias="apiName") + + display_name: DisplayName = Field(alias="displayName") + + description: StrictStr + + rid: OntologyRid + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_ontology_api_name.py b/foundry/v1/ontologies/models/_ontology_api_name.py similarity index 100% rename from foundry/v1/models/_ontology_api_name.py rename to foundry/v1/ontologies/models/_ontology_api_name.py diff --git a/foundry/v1/ontologies/models/_ontology_array_type.py b/foundry/v1/ontologies/models/_ontology_array_type.py new file mode 100644 index 00000000..11741c50 --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_array_type.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.ontologies.models._ontology_array_type_dict import OntologyArrayTypeDict +from foundry.v1.ontologies.models._ontology_data_type import OntologyDataType + + +class OntologyArrayType(BaseModel): + """OntologyArrayType""" + + item_type: OntologyDataType = Field(alias="itemType") + + type: Literal["array"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyArrayTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_ontology_array_type_dict.py b/foundry/v1/ontologies/models/_ontology_array_type_dict.py new file mode 100644 index 00000000..8657ad23 --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_array_type_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._ontology_data_type_dict import OntologyDataTypeDict + + +class OntologyArrayTypeDict(TypedDict): + """OntologyArrayType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + itemType: OntologyDataTypeDict + + type: Literal["array"] diff --git a/foundry/v1/ontologies/models/_ontology_data_type.py b/foundry/v1/ontologies/models/_ontology_data_type.py new file mode 100644 index 00000000..3a0ce0c2 --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_data_type.py @@ -0,0 +1,153 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import Union +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictBool +from typing_extensions import Annotated + +from foundry.v1.core.models._any_type import AnyType +from foundry.v1.core.models._binary_type import BinaryType +from foundry.v1.core.models._boolean_type import BooleanType +from foundry.v1.core.models._byte_type import ByteType +from foundry.v1.core.models._date_type import DateType +from foundry.v1.core.models._decimal_type import DecimalType +from foundry.v1.core.models._double_type import DoubleType +from foundry.v1.core.models._float_type import FloatType +from foundry.v1.core.models._integer_type import IntegerType +from foundry.v1.core.models._long_type import LongType +from foundry.v1.core.models._marking_type import MarkingType +from foundry.v1.core.models._short_type import ShortType +from foundry.v1.core.models._string_type import StringType +from foundry.v1.core.models._struct_field_name import StructFieldName +from foundry.v1.core.models._timestamp_type import TimestampType +from foundry.v1.core.models._unsupported_type import UnsupportedType +from foundry.v1.ontologies.models._ontology_array_type_dict import OntologyArrayTypeDict +from foundry.v1.ontologies.models._ontology_map_type_dict import OntologyMapTypeDict +from foundry.v1.ontologies.models._ontology_object_set_type import OntologyObjectSetType +from foundry.v1.ontologies.models._ontology_object_type import OntologyObjectType +from foundry.v1.ontologies.models._ontology_set_type_dict import OntologySetTypeDict +from foundry.v1.ontologies.models._ontology_struct_field_dict import OntologyStructFieldDict # NOQA +from foundry.v1.ontologies.models._ontology_struct_type_dict import OntologyStructTypeDict # NOQA + + +class OntologyStructField(BaseModel): + """OntologyStructField""" + + name: StructFieldName + + field_type: OntologyDataType = Field(alias="fieldType") + + required: StrictBool + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyStructFieldDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyStructFieldDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +class OntologyStructType(BaseModel): + """OntologyStructType""" + + fields: List[OntologyStructField] + + type: Literal["struct"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyStructTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyStructTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +class OntologySetType(BaseModel): + """OntologySetType""" + + item_type: OntologyDataType = Field(alias="itemType") + + type: Literal["set"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologySetTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologySetTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +class OntologyArrayType(BaseModel): + """OntologyArrayType""" + + item_type: OntologyDataType = Field(alias="itemType") + + type: Literal["array"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyArrayTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +class OntologyMapType(BaseModel): + """OntologyMapType""" + + key_type: OntologyDataType = Field(alias="keyType") + + value_type: OntologyDataType = Field(alias="valueType") + + type: Literal["map"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyMapTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyMapTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +OntologyDataType = Annotated[ + Union[ + DateType, + OntologyStructType, + OntologySetType, + StringType, + ByteType, + DoubleType, + IntegerType, + FloatType, + AnyType, + LongType, + BooleanType, + MarkingType, + UnsupportedType, + OntologyArrayType, + OntologyObjectSetType, + BinaryType, + ShortType, + DecimalType, + OntologyMapType, + TimestampType, + OntologyObjectType, + ], + Field(discriminator="type"), +] +"""A union of all the primitive types used by Palantir's Ontology-based products.""" diff --git a/foundry/v1/ontologies/models/_ontology_data_type_dict.py b/foundry/v1/ontologies/models/_ontology_data_type_dict.py new file mode 100644 index 00000000..0f87a5eb --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_data_type_dict.py @@ -0,0 +1,129 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import Union + +from pydantic import Field +from pydantic import StrictBool +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry.v1.core.models._any_type_dict import AnyTypeDict +from foundry.v1.core.models._binary_type_dict import BinaryTypeDict +from foundry.v1.core.models._boolean_type_dict import BooleanTypeDict +from foundry.v1.core.models._byte_type_dict import ByteTypeDict +from foundry.v1.core.models._date_type_dict import DateTypeDict +from foundry.v1.core.models._decimal_type_dict import DecimalTypeDict +from foundry.v1.core.models._double_type_dict import DoubleTypeDict +from foundry.v1.core.models._float_type_dict import FloatTypeDict +from foundry.v1.core.models._integer_type_dict import IntegerTypeDict +from foundry.v1.core.models._long_type_dict import LongTypeDict +from foundry.v1.core.models._marking_type_dict import MarkingTypeDict +from foundry.v1.core.models._short_type_dict import ShortTypeDict +from foundry.v1.core.models._string_type_dict import StringTypeDict +from foundry.v1.core.models._struct_field_name import StructFieldName +from foundry.v1.core.models._timestamp_type_dict import TimestampTypeDict +from foundry.v1.core.models._unsupported_type_dict import UnsupportedTypeDict +from foundry.v1.ontologies.models._ontology_object_set_type_dict import ( + OntologyObjectSetTypeDict, +) # NOQA +from foundry.v1.ontologies.models._ontology_object_type_dict import OntologyObjectTypeDict # NOQA + + +class OntologyStructFieldDict(TypedDict): + """OntologyStructField""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + name: StructFieldName + + fieldType: OntologyDataTypeDict + + required: StrictBool + + +class OntologyStructTypeDict(TypedDict): + """OntologyStructType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + fields: List[OntologyStructFieldDict] + + type: Literal["struct"] + + +class OntologySetTypeDict(TypedDict): + """OntologySetType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + itemType: OntologyDataTypeDict + + type: Literal["set"] + + +class OntologyArrayTypeDict(TypedDict): + """OntologyArrayType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + itemType: OntologyDataTypeDict + + type: Literal["array"] + + +class OntologyMapTypeDict(TypedDict): + """OntologyMapType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + keyType: OntologyDataTypeDict + + valueType: OntologyDataTypeDict + + type: Literal["map"] + + +OntologyDataTypeDict = Annotated[ + Union[ + DateTypeDict, + OntologyStructTypeDict, + OntologySetTypeDict, + StringTypeDict, + ByteTypeDict, + DoubleTypeDict, + IntegerTypeDict, + FloatTypeDict, + AnyTypeDict, + LongTypeDict, + BooleanTypeDict, + MarkingTypeDict, + UnsupportedTypeDict, + OntologyArrayTypeDict, + OntologyObjectSetTypeDict, + BinaryTypeDict, + ShortTypeDict, + DecimalTypeDict, + OntologyMapTypeDict, + TimestampTypeDict, + OntologyObjectTypeDict, + ], + Field(discriminator="type"), +] +"""A union of all the primitive types used by Palantir's Ontology-based products.""" diff --git a/foundry/v1/ontologies/models/_ontology_dict.py b/foundry/v1/ontologies/models/_ontology_dict.py new file mode 100644 index 00000000..ded4fcbf --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_dict.py @@ -0,0 +1,37 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr +from typing_extensions import TypedDict + +from foundry.v1.core.models._display_name import DisplayName +from foundry.v1.ontologies.models._ontology_api_name import OntologyApiName +from foundry.v1.ontologies.models._ontology_rid import OntologyRid + + +class OntologyDict(TypedDict): + """Metadata about an Ontology.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + apiName: OntologyApiName + + displayName: DisplayName + + description: StrictStr + + rid: OntologyRid diff --git a/foundry/v1/ontologies/models/_ontology_map_type.py b/foundry/v1/ontologies/models/_ontology_map_type.py new file mode 100644 index 00000000..b0661f59 --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_map_type.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.ontologies.models._ontology_data_type import OntologyDataType +from foundry.v1.ontologies.models._ontology_map_type_dict import OntologyMapTypeDict + + +class OntologyMapType(BaseModel): + """OntologyMapType""" + + key_type: OntologyDataType = Field(alias="keyType") + + value_type: OntologyDataType = Field(alias="valueType") + + type: Literal["map"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyMapTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyMapTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_ontology_map_type_dict.py b/foundry/v1/ontologies/models/_ontology_map_type_dict.py new file mode 100644 index 00000000..f2749d76 --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_map_type_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._ontology_data_type_dict import OntologyDataTypeDict + + +class OntologyMapTypeDict(TypedDict): + """OntologyMapType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + keyType: OntologyDataTypeDict + + valueType: OntologyDataTypeDict + + type: Literal["map"] diff --git a/foundry/v1/ontologies/models/_ontology_object.py b/foundry/v1/ontologies/models/_ontology_object.py new file mode 100644 index 00000000..4fc8c2d1 --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_object.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import Optional +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._object_rid import ObjectRid +from foundry.v1.ontologies.models._ontology_object_dict import OntologyObjectDict +from foundry.v1.ontologies.models._property_api_name import PropertyApiName +from foundry.v1.ontologies.models._property_value import PropertyValue + + +class OntologyObject(BaseModel): + """Represents an object in the Ontology.""" + + properties: Dict[PropertyApiName, Optional[PropertyValue]] + """A map of the property values of the object.""" + + rid: ObjectRid + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyObjectDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyObjectDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_ontology_object_dict.py b/foundry/v1/ontologies/models/_ontology_object_dict.py new file mode 100644 index 00000000..4aae3380 --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_object_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import Optional + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._object_rid import ObjectRid +from foundry.v1.ontologies.models._property_api_name import PropertyApiName +from foundry.v1.ontologies.models._property_value import PropertyValue + + +class OntologyObjectDict(TypedDict): + """Represents an object in the Ontology.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + properties: Dict[PropertyApiName, Optional[PropertyValue]] + """A map of the property values of the object.""" + + rid: ObjectRid diff --git a/foundry/v1/ontologies/models/_ontology_object_set_type.py b/foundry/v1/ontologies/models/_ontology_object_set_type.py new file mode 100644 index 00000000..2b0da4f2 --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_object_set_type.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v1.ontologies.models._ontology_object_set_type_dict import ( + OntologyObjectSetTypeDict, +) # NOQA + + +class OntologyObjectSetType(BaseModel): + """OntologyObjectSetType""" + + object_api_name: Optional[ObjectTypeApiName] = Field(alias="objectApiName", default=None) + + object_type_api_name: Optional[ObjectTypeApiName] = Field( + alias="objectTypeApiName", default=None + ) + + type: Literal["objectSet"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyObjectSetTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyObjectSetTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_ontology_object_set_type_dict.py b/foundry/v1/ontologies/models/_ontology_object_set_type_dict.py new file mode 100644 index 00000000..e604da85 --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_object_set_type_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class OntologyObjectSetTypeDict(TypedDict): + """OntologyObjectSetType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectApiName: NotRequired[ObjectTypeApiName] + + objectTypeApiName: NotRequired[ObjectTypeApiName] + + type: Literal["objectSet"] diff --git a/foundry/v1/ontologies/models/_ontology_object_type.py b/foundry/v1/ontologies/models/_ontology_object_type.py new file mode 100644 index 00000000..d30de68b --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_object_type.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v1.ontologies.models._ontology_object_type_dict import OntologyObjectTypeDict # NOQA + + +class OntologyObjectType(BaseModel): + """OntologyObjectType""" + + object_api_name: ObjectTypeApiName = Field(alias="objectApiName") + + object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") + + type: Literal["object"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyObjectTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyObjectTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_ontology_object_type_dict.py b/foundry/v1/ontologies/models/_ontology_object_type_dict.py new file mode 100644 index 00000000..acadc9e9 --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_object_type_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class OntologyObjectTypeDict(TypedDict): + """OntologyObjectType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectApiName: ObjectTypeApiName + + objectTypeApiName: ObjectTypeApiName + + type: Literal["object"] diff --git a/foundry/v1/models/_ontology_rid.py b/foundry/v1/ontologies/models/_ontology_rid.py similarity index 100% rename from foundry/v1/models/_ontology_rid.py rename to foundry/v1/ontologies/models/_ontology_rid.py diff --git a/foundry/v1/ontologies/models/_ontology_set_type.py b/foundry/v1/ontologies/models/_ontology_set_type.py new file mode 100644 index 00000000..c5d3c84c --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_set_type.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.ontologies.models._ontology_data_type import OntologyDataType +from foundry.v1.ontologies.models._ontology_set_type_dict import OntologySetTypeDict + + +class OntologySetType(BaseModel): + """OntologySetType""" + + item_type: OntologyDataType = Field(alias="itemType") + + type: Literal["set"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologySetTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologySetTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_ontology_set_type_dict.py b/foundry/v1/ontologies/models/_ontology_set_type_dict.py new file mode 100644 index 00000000..9b4aee46 --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_set_type_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._ontology_data_type_dict import OntologyDataTypeDict + + +class OntologySetTypeDict(TypedDict): + """OntologySetType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + itemType: OntologyDataTypeDict + + type: Literal["set"] diff --git a/foundry/v1/ontologies/models/_ontology_struct_field.py b/foundry/v1/ontologies/models/_ontology_struct_field.py new file mode 100644 index 00000000..9087cf82 --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_struct_field.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictBool + +from foundry.v1.core.models._struct_field_name import StructFieldName +from foundry.v1.ontologies.models._ontology_data_type import OntologyDataType +from foundry.v1.ontologies.models._ontology_struct_field_dict import OntologyStructFieldDict # NOQA + + +class OntologyStructField(BaseModel): + """OntologyStructField""" + + name: StructFieldName + + field_type: OntologyDataType = Field(alias="fieldType") + + required: StrictBool + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyStructFieldDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyStructFieldDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_ontology_struct_field_dict.py b/foundry/v1/ontologies/models/_ontology_struct_field_dict.py new file mode 100644 index 00000000..f1f1ca3d --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_struct_field_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictBool +from typing_extensions import TypedDict + +from foundry.v1.core.models._struct_field_name import StructFieldName +from foundry.v1.ontologies.models._ontology_data_type_dict import OntologyDataTypeDict + + +class OntologyStructFieldDict(TypedDict): + """OntologyStructField""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + name: StructFieldName + + fieldType: OntologyDataTypeDict + + required: StrictBool diff --git a/foundry/v1/ontologies/models/_ontology_struct_type.py b/foundry/v1/ontologies/models/_ontology_struct_type.py new file mode 100644 index 00000000..29baf3c7 --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_struct_type.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._ontology_struct_field import OntologyStructField +from foundry.v1.ontologies.models._ontology_struct_type_dict import OntologyStructTypeDict # NOQA + + +class OntologyStructType(BaseModel): + """OntologyStructType""" + + fields: List[OntologyStructField] + + type: Literal["struct"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyStructTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyStructTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_ontology_struct_type_dict.py b/foundry/v1/ontologies/models/_ontology_struct_type_dict.py new file mode 100644 index 00000000..45b65373 --- /dev/null +++ b/foundry/v1/ontologies/models/_ontology_struct_type_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._ontology_struct_field_dict import OntologyStructFieldDict # NOQA + + +class OntologyStructTypeDict(TypedDict): + """OntologyStructType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + fields: List[OntologyStructFieldDict] + + type: Literal["struct"] diff --git a/foundry/v1/ontologies/models/_or_query_dict.py b/foundry/v1/ontologies/models/_or_query_dict.py new file mode 100644 index 00000000..b43c7d96 --- /dev/null +++ b/foundry/v1/ontologies/models/_or_query_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._search_json_query_dict import SearchJsonQueryDict + + +class OrQueryDict(TypedDict): + """Returns objects where at least 1 query is satisfied.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: List[SearchJsonQueryDict] + + type: Literal["or"] diff --git a/foundry/v1/models/_order_by.py b/foundry/v1/ontologies/models/_order_by.py similarity index 100% rename from foundry/v1/models/_order_by.py rename to foundry/v1/ontologies/models/_order_by.py diff --git a/foundry/v1/ontologies/models/_parameter.py b/foundry/v1/ontologies/models/_parameter.py new file mode 100644 index 00000000..40b7ed94 --- /dev/null +++ b/foundry/v1/ontologies/models/_parameter.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictBool +from pydantic import StrictStr + +from foundry.v1.ontologies.models._ontology_data_type import OntologyDataType +from foundry.v1.ontologies.models._parameter_dict import ParameterDict +from foundry.v1.ontologies.models._value_type import ValueType + + +class Parameter(BaseModel): + """Details about a parameter of an action or query.""" + + description: Optional[StrictStr] = None + + base_type: ValueType = Field(alias="baseType") + + data_type: Optional[OntologyDataType] = Field(alias="dataType", default=None) + + required: StrictBool + + model_config = {"extra": "allow"} + + def to_dict(self) -> ParameterDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ParameterDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_parameter_dict.py b/foundry/v1/ontologies/models/_parameter_dict.py new file mode 100644 index 00000000..d8bf1b65 --- /dev/null +++ b/foundry/v1/ontologies/models/_parameter_dict.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictBool +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._ontology_data_type_dict import OntologyDataTypeDict +from foundry.v1.ontologies.models._value_type import ValueType + + +class ParameterDict(TypedDict): + """Details about a parameter of an action or query.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + description: NotRequired[StrictStr] + + baseType: ValueType + + dataType: NotRequired[OntologyDataTypeDict] + + required: StrictBool diff --git a/foundry/v1/ontologies/models/_parameter_evaluated_constraint.py b/foundry/v1/ontologies/models/_parameter_evaluated_constraint.py new file mode 100644 index 00000000..c0122665 --- /dev/null +++ b/foundry/v1/ontologies/models/_parameter_evaluated_constraint.py @@ -0,0 +1,71 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v1.ontologies.models._array_size_constraint import ArraySizeConstraint +from foundry.v1.ontologies.models._group_member_constraint import GroupMemberConstraint +from foundry.v1.ontologies.models._object_property_value_constraint import ( + ObjectPropertyValueConstraint, +) # NOQA +from foundry.v1.ontologies.models._object_query_result_constraint import ( + ObjectQueryResultConstraint, +) # NOQA +from foundry.v1.ontologies.models._one_of_constraint import OneOfConstraint +from foundry.v1.ontologies.models._range_constraint import RangeConstraint +from foundry.v1.ontologies.models._string_length_constraint import StringLengthConstraint # NOQA +from foundry.v1.ontologies.models._string_regex_match_constraint import ( + StringRegexMatchConstraint, +) # NOQA +from foundry.v1.ontologies.models._unevaluable_constraint import UnevaluableConstraint + +ParameterEvaluatedConstraint = Annotated[ + Union[ + OneOfConstraint, + GroupMemberConstraint, + ObjectPropertyValueConstraint, + RangeConstraint, + ArraySizeConstraint, + ObjectQueryResultConstraint, + StringLengthConstraint, + StringRegexMatchConstraint, + UnevaluableConstraint, + ], + Field(discriminator="type"), +] +""" +A constraint that an action parameter value must satisfy in order to be considered valid. +Constraints can be configured on action parameters in the **Ontology Manager**. +Applicable constraints are determined dynamically based on parameter inputs. +Parameter values are evaluated against the final set of constraints. + +The type of the constraint. +| Type | Description | +|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | +| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | +| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | +| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | +| `oneOf` | The parameter has a manually predefined set of options. | +| `range` | The parameter value must be within the defined range. | +| `stringLength` | The parameter value must have a length within the defined range. | +| `stringRegexMatch` | The parameter value must match a predefined regular expression. | +| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | +""" diff --git a/foundry/v1/ontologies/models/_parameter_evaluated_constraint_dict.py b/foundry/v1/ontologies/models/_parameter_evaluated_constraint_dict.py new file mode 100644 index 00000000..3bb668e7 --- /dev/null +++ b/foundry/v1/ontologies/models/_parameter_evaluated_constraint_dict.py @@ -0,0 +1,77 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v1.ontologies.models._array_size_constraint_dict import ArraySizeConstraintDict # NOQA +from foundry.v1.ontologies.models._group_member_constraint_dict import ( + GroupMemberConstraintDict, +) # NOQA +from foundry.v1.ontologies.models._object_property_value_constraint_dict import ( + ObjectPropertyValueConstraintDict, +) # NOQA +from foundry.v1.ontologies.models._object_query_result_constraint_dict import ( + ObjectQueryResultConstraintDict, +) # NOQA +from foundry.v1.ontologies.models._one_of_constraint_dict import OneOfConstraintDict +from foundry.v1.ontologies.models._range_constraint_dict import RangeConstraintDict +from foundry.v1.ontologies.models._string_length_constraint_dict import ( + StringLengthConstraintDict, +) # NOQA +from foundry.v1.ontologies.models._string_regex_match_constraint_dict import ( + StringRegexMatchConstraintDict, +) # NOQA +from foundry.v1.ontologies.models._unevaluable_constraint_dict import ( + UnevaluableConstraintDict, +) # NOQA + +ParameterEvaluatedConstraintDict = Annotated[ + Union[ + OneOfConstraintDict, + GroupMemberConstraintDict, + ObjectPropertyValueConstraintDict, + RangeConstraintDict, + ArraySizeConstraintDict, + ObjectQueryResultConstraintDict, + StringLengthConstraintDict, + StringRegexMatchConstraintDict, + UnevaluableConstraintDict, + ], + Field(discriminator="type"), +] +""" +A constraint that an action parameter value must satisfy in order to be considered valid. +Constraints can be configured on action parameters in the **Ontology Manager**. +Applicable constraints are determined dynamically based on parameter inputs. +Parameter values are evaluated against the final set of constraints. + +The type of the constraint. +| Type | Description | +|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | +| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | +| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | +| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | +| `oneOf` | The parameter has a manually predefined set of options. | +| `range` | The parameter value must be within the defined range. | +| `stringLength` | The parameter value must have a length within the defined range. | +| `stringRegexMatch` | The parameter value must match a predefined regular expression. | +| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | +""" diff --git a/foundry/v1/ontologies/models/_parameter_evaluation_result.py b/foundry/v1/ontologies/models/_parameter_evaluation_result.py new file mode 100644 index 00000000..b18c40d4 --- /dev/null +++ b/foundry/v1/ontologies/models/_parameter_evaluation_result.py @@ -0,0 +1,50 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictBool + +from foundry.v1.ontologies.models._parameter_evaluated_constraint import ( + ParameterEvaluatedConstraint, +) # NOQA +from foundry.v1.ontologies.models._parameter_evaluation_result_dict import ( + ParameterEvaluationResultDict, +) # NOQA +from foundry.v1.ontologies.models._validation_result import ValidationResult + + +class ParameterEvaluationResult(BaseModel): + """Represents the validity of a parameter against the configured constraints.""" + + result: ValidationResult + + evaluated_constraints: List[ParameterEvaluatedConstraint] = Field(alias="evaluatedConstraints") + + required: StrictBool + """Represents whether the parameter is a required input to the action.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ParameterEvaluationResultDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ParameterEvaluationResultDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v1/ontologies/models/_parameter_evaluation_result_dict.py b/foundry/v1/ontologies/models/_parameter_evaluation_result_dict.py new file mode 100644 index 00000000..11e5b641 --- /dev/null +++ b/foundry/v1/ontologies/models/_parameter_evaluation_result_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from pydantic import StrictBool +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._parameter_evaluated_constraint_dict import ( + ParameterEvaluatedConstraintDict, +) # NOQA +from foundry.v1.ontologies.models._validation_result import ValidationResult + + +class ParameterEvaluationResultDict(TypedDict): + """Represents the validity of a parameter against the configured constraints.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + result: ValidationResult + + evaluatedConstraints: List[ParameterEvaluatedConstraintDict] + + required: StrictBool + """Represents whether the parameter is a required input to the action.""" diff --git a/foundry/v1/models/_parameter_id.py b/foundry/v1/ontologies/models/_parameter_id.py similarity index 100% rename from foundry/v1/models/_parameter_id.py rename to foundry/v1/ontologies/models/_parameter_id.py diff --git a/foundry/v1/ontologies/models/_parameter_option.py b/foundry/v1/ontologies/models/_parameter_option.py new file mode 100644 index 00000000..e325489d --- /dev/null +++ b/foundry/v1/ontologies/models/_parameter_option.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.core.models._display_name import DisplayName +from foundry.v1.ontologies.models._parameter_option_dict import ParameterOptionDict + + +class ParameterOption(BaseModel): + """A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.""" + + display_name: Optional[DisplayName] = Field(alias="displayName", default=None) + + value: Optional[Any] = None + """An allowed configured value for a parameter within an action.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ParameterOptionDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ParameterOptionDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_parameter_option_dict.py b/foundry/v1/ontologies/models/_parameter_option_dict.py new file mode 100644 index 00000000..b207e2d5 --- /dev/null +++ b/foundry/v1/ontologies/models/_parameter_option_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._display_name import DisplayName + + +class ParameterOptionDict(TypedDict): + """A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + displayName: NotRequired[DisplayName] + + value: NotRequired[Any] + """An allowed configured value for a parameter within an action.""" diff --git a/foundry/v1/ontologies/models/_phrase_query_dict.py b/foundry/v1/ontologies/models/_phrase_query_dict.py new file mode 100644 index 00000000..9e2eb582 --- /dev/null +++ b/foundry/v1/ontologies/models/_phrase_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictStr +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 + + +class PhraseQueryDict(TypedDict): + """Returns objects where the specified field contains the provided value as a substring.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + value: StrictStr + + type: Literal["phrase"] diff --git a/foundry/v1/ontologies/models/_prefix_query_dict.py b/foundry/v1/ontologies/models/_prefix_query_dict.py new file mode 100644 index 00000000..d52a0136 --- /dev/null +++ b/foundry/v1/ontologies/models/_prefix_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictStr +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 + + +class PrefixQueryDict(TypedDict): + """Returns objects where the specified field starts with the provided value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + value: StrictStr + + type: Literal["prefix"] diff --git a/foundry/v1/ontologies/models/_property.py b/foundry/v1/ontologies/models/_property.py new file mode 100644 index 00000000..058d50e3 --- /dev/null +++ b/foundry/v1/ontologies/models/_property.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v1.core.models._display_name import DisplayName +from foundry.v1.ontologies.models._property_dict import PropertyDict +from foundry.v1.ontologies.models._value_type import ValueType + + +class Property(BaseModel): + """Details about some property of an object.""" + + description: Optional[StrictStr] = None + + display_name: Optional[DisplayName] = Field(alias="displayName", default=None) + + base_type: ValueType = Field(alias="baseType") + + model_config = {"extra": "allow"} + + def to_dict(self) -> PropertyDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(PropertyDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_property_api_name.py b/foundry/v1/ontologies/models/_property_api_name.py similarity index 100% rename from foundry/v1/models/_property_api_name.py rename to foundry/v1/ontologies/models/_property_api_name.py diff --git a/foundry/v1/ontologies/models/_property_dict.py b/foundry/v1/ontologies/models/_property_dict.py new file mode 100644 index 00000000..1152be47 --- /dev/null +++ b/foundry/v1/ontologies/models/_property_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._display_name import DisplayName +from foundry.v1.ontologies.models._value_type import ValueType + + +class PropertyDict(TypedDict): + """Details about some property of an object.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + description: NotRequired[StrictStr] + + displayName: NotRequired[DisplayName] + + baseType: ValueType diff --git a/foundry/v1/models/_property_value.py b/foundry/v1/ontologies/models/_property_value.py similarity index 100% rename from foundry/v1/models/_property_value.py rename to foundry/v1/ontologies/models/_property_value.py diff --git a/foundry/v1/models/_property_value_escaped_string.py b/foundry/v1/ontologies/models/_property_value_escaped_string.py similarity index 100% rename from foundry/v1/models/_property_value_escaped_string.py rename to foundry/v1/ontologies/models/_property_value_escaped_string.py diff --git a/foundry/v1/models/_query_api_name.py b/foundry/v1/ontologies/models/_query_api_name.py similarity index 100% rename from foundry/v1/models/_query_api_name.py rename to foundry/v1/ontologies/models/_query_api_name.py diff --git a/foundry/v1/ontologies/models/_query_type.py b/foundry/v1/ontologies/models/_query_type.py new file mode 100644 index 00000000..04c443ea --- /dev/null +++ b/foundry/v1/ontologies/models/_query_type.py @@ -0,0 +1,57 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v1.core.models._display_name import DisplayName +from foundry.v1.ontologies.models._function_rid import FunctionRid +from foundry.v1.ontologies.models._function_version import FunctionVersion +from foundry.v1.ontologies.models._ontology_data_type import OntologyDataType +from foundry.v1.ontologies.models._parameter import Parameter +from foundry.v1.ontologies.models._parameter_id import ParameterId +from foundry.v1.ontologies.models._query_api_name import QueryApiName +from foundry.v1.ontologies.models._query_type_dict import QueryTypeDict + + +class QueryType(BaseModel): + """Represents a query type in the Ontology.""" + + api_name: QueryApiName = Field(alias="apiName") + + description: Optional[StrictStr] = None + + display_name: Optional[DisplayName] = Field(alias="displayName", default=None) + + parameters: Dict[ParameterId, Parameter] + + output: Optional[OntologyDataType] = None + + rid: FunctionRid + + version: FunctionVersion + + model_config = {"extra": "allow"} + + def to_dict(self) -> QueryTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(QueryTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_query_type_dict.py b/foundry/v1/ontologies/models/_query_type_dict.py new file mode 100644 index 00000000..18c0345d --- /dev/null +++ b/foundry/v1/ontologies/models/_query_type_dict.py @@ -0,0 +1,50 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._display_name import DisplayName +from foundry.v1.ontologies.models._function_rid import FunctionRid +from foundry.v1.ontologies.models._function_version import FunctionVersion +from foundry.v1.ontologies.models._ontology_data_type_dict import OntologyDataTypeDict +from foundry.v1.ontologies.models._parameter_dict import ParameterDict +from foundry.v1.ontologies.models._parameter_id import ParameterId +from foundry.v1.ontologies.models._query_api_name import QueryApiName + + +class QueryTypeDict(TypedDict): + """Represents a query type in the Ontology.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + apiName: QueryApiName + + description: NotRequired[StrictStr] + + displayName: NotRequired[DisplayName] + + parameters: Dict[ParameterId, ParameterDict] + + output: NotRequired[OntologyDataTypeDict] + + rid: FunctionRid + + version: FunctionVersion diff --git a/foundry/v1/ontologies/models/_range_constraint.py b/foundry/v1/ontologies/models/_range_constraint.py new file mode 100644 index 00000000..ac38b1b6 --- /dev/null +++ b/foundry/v1/ontologies/models/_range_constraint.py @@ -0,0 +1,49 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._range_constraint_dict import RangeConstraintDict + + +class RangeConstraint(BaseModel): + """The parameter value must be within the defined range.""" + + lt: Optional[Any] = None + """Less than""" + + lte: Optional[Any] = None + """Less than or equal""" + + gt: Optional[Any] = None + """Greater than""" + + gte: Optional[Any] = None + """Greater than or equal""" + + type: Literal["range"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> RangeConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(RangeConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_range_constraint_dict.py b/foundry/v1/ontologies/models/_range_constraint_dict.py similarity index 100% rename from foundry/v1/models/_range_constraint_dict.py rename to foundry/v1/ontologies/models/_range_constraint_dict.py diff --git a/foundry/v1/ontologies/models/_search_json_query_dict.py b/foundry/v1/ontologies/models/_search_json_query_dict.py new file mode 100644 index 00000000..0cd90dc4 --- /dev/null +++ b/foundry/v1/ontologies/models/_search_json_query_dict.py @@ -0,0 +1,88 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._all_terms_query_dict import AllTermsQueryDict +from foundry.v1.ontologies.models._any_term_query_dict import AnyTermQueryDict +from foundry.v1.ontologies.models._contains_query_dict import ContainsQueryDict +from foundry.v1.ontologies.models._equals_query_dict import EqualsQueryDict +from foundry.v1.ontologies.models._gt_query_dict import GtQueryDict +from foundry.v1.ontologies.models._gte_query_dict import GteQueryDict +from foundry.v1.ontologies.models._is_null_query_dict import IsNullQueryDict +from foundry.v1.ontologies.models._lt_query_dict import LtQueryDict +from foundry.v1.ontologies.models._lte_query_dict import LteQueryDict +from foundry.v1.ontologies.models._phrase_query_dict import PhraseQueryDict +from foundry.v1.ontologies.models._prefix_query_dict import PrefixQueryDict + + +class OrQueryDict(TypedDict): + """Returns objects where at least 1 query is satisfied.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: List[SearchJsonQueryDict] + + type: Literal["or"] + + +class NotQueryDict(TypedDict): + """Returns objects where the query is not satisfied.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: SearchJsonQueryDict + + type: Literal["not"] + + +class AndQueryDict(TypedDict): + """Returns objects where every query is satisfied.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: List[SearchJsonQueryDict] + + type: Literal["and"] + + +SearchJsonQueryDict = Annotated[ + Union[ + OrQueryDict, + PrefixQueryDict, + LtQueryDict, + AllTermsQueryDict, + EqualsQueryDict, + GtQueryDict, + ContainsQueryDict, + NotQueryDict, + PhraseQueryDict, + AndQueryDict, + IsNullQueryDict, + GteQueryDict, + AnyTermQueryDict, + LteQueryDict, + ], + Field(discriminator="type"), +] +"""SearchJsonQuery""" diff --git a/foundry/v1/ontologies/models/_search_objects_response.py b/foundry/v1/ontologies/models/_search_objects_response.py new file mode 100644 index 00000000..4f5e3b64 --- /dev/null +++ b/foundry/v1/ontologies/models/_search_objects_response.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.core.models._total_count import TotalCount +from foundry.v1.ontologies.models._ontology_object import OntologyObject +from foundry.v1.ontologies.models._search_objects_response_dict import ( + SearchObjectsResponseDict, +) # NOQA + + +class SearchObjectsResponse(BaseModel): + """SearchObjectsResponse""" + + data: List[OntologyObject] + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + total_count: TotalCount = Field(alias="totalCount") + + model_config = {"extra": "allow"} + + def to_dict(self) -> SearchObjectsResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(SearchObjectsResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_search_objects_response_dict.py b/foundry/v1/ontologies/models/_search_objects_response_dict.py new file mode 100644 index 00000000..c1e64200 --- /dev/null +++ b/foundry/v1/ontologies/models/_search_objects_response_dict.py @@ -0,0 +1,37 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.core.models._total_count import TotalCount +from foundry.v1.ontologies.models._ontology_object_dict import OntologyObjectDict + + +class SearchObjectsResponseDict(TypedDict): + """SearchObjectsResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + data: List[OntologyObjectDict] + + nextPageToken: NotRequired[PageToken] + + totalCount: TotalCount diff --git a/foundry/v1/ontologies/models/_search_order_by_dict.py b/foundry/v1/ontologies/models/_search_order_by_dict.py new file mode 100644 index 00000000..1c72e0fb --- /dev/null +++ b/foundry/v1/ontologies/models/_search_order_by_dict.py @@ -0,0 +1,30 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._search_ordering_dict import SearchOrderingDict + + +class SearchOrderByDict(TypedDict): + """Specifies the ordering of search results by a field and an ordering direction.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + fields: List[SearchOrderingDict] diff --git a/foundry/v1/ontologies/models/_search_ordering_dict.py b/foundry/v1/ontologies/models/_search_ordering_dict.py new file mode 100644 index 00000000..1c89be4c --- /dev/null +++ b/foundry/v1/ontologies/models/_search_ordering_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 + + +class SearchOrderingDict(TypedDict): + """SearchOrdering""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + direction: NotRequired[StrictStr] + """Specifies the ordering direction (can be either `asc` or `desc`)""" diff --git a/foundry/v1/models/_selected_property_api_name.py b/foundry/v1/ontologies/models/_selected_property_api_name.py similarity index 100% rename from foundry/v1/models/_selected_property_api_name.py rename to foundry/v1/ontologies/models/_selected_property_api_name.py diff --git a/foundry/v1/ontologies/models/_string_length_constraint.py b/foundry/v1/ontologies/models/_string_length_constraint.py new file mode 100644 index 00000000..630c02a8 --- /dev/null +++ b/foundry/v1/ontologies/models/_string_length_constraint.py @@ -0,0 +1,54 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._string_length_constraint_dict import ( + StringLengthConstraintDict, +) # NOQA + + +class StringLengthConstraint(BaseModel): + """ + The parameter value must have a length within the defined range. + *This range is always inclusive.* + """ + + lt: Optional[Any] = None + """Less than""" + + lte: Optional[Any] = None + """Less than or equal""" + + gt: Optional[Any] = None + """Greater than""" + + gte: Optional[Any] = None + """Greater than or equal""" + + type: Literal["stringLength"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> StringLengthConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(StringLengthConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_string_length_constraint_dict.py b/foundry/v1/ontologies/models/_string_length_constraint_dict.py similarity index 100% rename from foundry/v1/models/_string_length_constraint_dict.py rename to foundry/v1/ontologies/models/_string_length_constraint_dict.py diff --git a/foundry/v1/ontologies/models/_string_regex_match_constraint.py b/foundry/v1/ontologies/models/_string_regex_match_constraint.py new file mode 100644 index 00000000..09f6f628 --- /dev/null +++ b/foundry/v1/ontologies/models/_string_regex_match_constraint.py @@ -0,0 +1,53 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v1.ontologies.models._string_regex_match_constraint_dict import ( + StringRegexMatchConstraintDict, +) # NOQA + + +class StringRegexMatchConstraint(BaseModel): + """The parameter value must match a predefined regular expression.""" + + regex: StrictStr + """The regular expression configured in the **Ontology Manager**.""" + + configured_failure_message: Optional[StrictStr] = Field( + alias="configuredFailureMessage", default=None + ) + """ + The message indicating that the regular expression was not matched. + This is configured per parameter in the **Ontology Manager**. + """ + + type: Literal["stringRegexMatch"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> StringRegexMatchConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + StringRegexMatchConstraintDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v1/models/_string_regex_match_constraint_dict.py b/foundry/v1/ontologies/models/_string_regex_match_constraint_dict.py similarity index 100% rename from foundry/v1/models/_string_regex_match_constraint_dict.py rename to foundry/v1/ontologies/models/_string_regex_match_constraint_dict.py diff --git a/foundry/v1/ontologies/models/_submission_criteria_evaluation.py b/foundry/v1/ontologies/models/_submission_criteria_evaluation.py new file mode 100644 index 00000000..433bbbf2 --- /dev/null +++ b/foundry/v1/ontologies/models/_submission_criteria_evaluation.py @@ -0,0 +1,54 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v1.ontologies.models._submission_criteria_evaluation_dict import ( + SubmissionCriteriaEvaluationDict, +) # NOQA +from foundry.v1.ontologies.models._validation_result import ValidationResult + + +class SubmissionCriteriaEvaluation(BaseModel): + """ + Contains the status of the **submission criteria**. + **Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. + These are configured in the **Ontology Manager**. + """ + + configured_failure_message: Optional[StrictStr] = Field( + alias="configuredFailureMessage", default=None + ) + """ + The message indicating one of the **submission criteria** was not satisfied. + This is configured per **submission criteria** in the **Ontology Manager**. + """ + + result: ValidationResult + + model_config = {"extra": "allow"} + + def to_dict(self) -> SubmissionCriteriaEvaluationDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + SubmissionCriteriaEvaluationDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v1/ontologies/models/_submission_criteria_evaluation_dict.py b/foundry/v1/ontologies/models/_submission_criteria_evaluation_dict.py new file mode 100644 index 00000000..7f56ea10 --- /dev/null +++ b/foundry/v1/ontologies/models/_submission_criteria_evaluation_dict.py @@ -0,0 +1,40 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._validation_result import ValidationResult + + +class SubmissionCriteriaEvaluationDict(TypedDict): + """ + Contains the status of the **submission criteria**. + **Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. + These are configured in the **Ontology Manager**. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + configuredFailureMessage: NotRequired[StrictStr] + """ + The message indicating one of the **submission criteria** was not satisfied. + This is configured per **submission criteria** in the **Ontology Manager**. + """ + + result: ValidationResult diff --git a/foundry/v1/ontologies/models/_sum_aggregation_dict.py b/foundry/v1/ontologies/models/_sum_aggregation_dict.py new file mode 100644 index 00000000..a4406b47 --- /dev/null +++ b/foundry/v1/ontologies/models/_sum_aggregation_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._aggregation_metric_name import AggregationMetricName +from foundry.v1.ontologies.models._field_name_v1 import FieldNameV1 + + +class SumAggregationDict(TypedDict): + """Computes the sum of values for the provided field.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: FieldNameV1 + + name: NotRequired[AggregationMetricName] + + type: Literal["sum"] diff --git a/foundry/v1/ontologies/models/_unevaluable_constraint.py b/foundry/v1/ontologies/models/_unevaluable_constraint.py new file mode 100644 index 00000000..1e5a5ad8 --- /dev/null +++ b/foundry/v1/ontologies/models/_unevaluable_constraint.py @@ -0,0 +1,40 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v1.ontologies.models._unevaluable_constraint_dict import ( + UnevaluableConstraintDict, +) # NOQA + + +class UnevaluableConstraint(BaseModel): + """ + The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. + This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. + """ + + type: Literal["unevaluable"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> UnevaluableConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(UnevaluableConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_unevaluable_constraint_dict.py b/foundry/v1/ontologies/models/_unevaluable_constraint_dict.py similarity index 100% rename from foundry/v1/models/_unevaluable_constraint_dict.py rename to foundry/v1/ontologies/models/_unevaluable_constraint_dict.py diff --git a/foundry/v1/ontologies/models/_validate_action_response.py b/foundry/v1/ontologies/models/_validate_action_response.py new file mode 100644 index 00000000..db32aaec --- /dev/null +++ b/foundry/v1/ontologies/models/_validate_action_response.py @@ -0,0 +1,51 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v1.ontologies.models._parameter_evaluation_result import ( + ParameterEvaluationResult, +) # NOQA +from foundry.v1.ontologies.models._parameter_id import ParameterId +from foundry.v1.ontologies.models._submission_criteria_evaluation import ( + SubmissionCriteriaEvaluation, +) # NOQA +from foundry.v1.ontologies.models._validate_action_response_dict import ( + ValidateActionResponseDict, +) # NOQA +from foundry.v1.ontologies.models._validation_result import ValidationResult + + +class ValidateActionResponse(BaseModel): + """ValidateActionResponse""" + + result: ValidationResult + + submission_criteria: List[SubmissionCriteriaEvaluation] = Field(alias="submissionCriteria") + + parameters: Dict[ParameterId, ParameterEvaluationResult] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ValidateActionResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ValidateActionResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/ontologies/models/_validate_action_response_dict.py b/foundry/v1/ontologies/models/_validate_action_response_dict.py new file mode 100644 index 00000000..5c899ee5 --- /dev/null +++ b/foundry/v1/ontologies/models/_validate_action_response_dict.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._parameter_evaluation_result_dict import ( + ParameterEvaluationResultDict, +) # NOQA +from foundry.v1.ontologies.models._parameter_id import ParameterId +from foundry.v1.ontologies.models._submission_criteria_evaluation_dict import ( + SubmissionCriteriaEvaluationDict, +) # NOQA +from foundry.v1.ontologies.models._validation_result import ValidationResult + + +class ValidateActionResponseDict(TypedDict): + """ValidateActionResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + result: ValidationResult + + submissionCriteria: List[SubmissionCriteriaEvaluationDict] + + parameters: Dict[ParameterId, ParameterEvaluationResultDict] diff --git a/foundry/v1/models/_validation_result.py b/foundry/v1/ontologies/models/_validation_result.py similarity index 100% rename from foundry/v1/models/_validation_result.py rename to foundry/v1/ontologies/models/_validation_result.py diff --git a/foundry/v1/models/_value_type.py b/foundry/v1/ontologies/models/_value_type.py similarity index 100% rename from foundry/v1/models/_value_type.py rename to foundry/v1/ontologies/models/_value_type.py diff --git a/foundry/v1/ontologies/object_type.py b/foundry/v1/ontologies/object_type.py new file mode 100644 index 00000000..aff41fc8 --- /dev/null +++ b/foundry/v1/ontologies/object_type.py @@ -0,0 +1,340 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v1.core.models._page_size import PageSize +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v1.ontologies.models._link_type_side import LinkTypeSide +from foundry.v1.ontologies.models._list_object_types_response import ListObjectTypesResponse # NOQA +from foundry.v1.ontologies.models._list_outgoing_link_types_response import ( + ListOutgoingLinkTypesResponse, +) # NOQA +from foundry.v1.ontologies.models._object_type import ObjectType +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v1.ontologies.models._ontology_rid import OntologyRid + + +class ObjectTypeClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get( + self, + ontology_rid: OntologyRid, + object_type: ObjectTypeApiName, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ObjectType: + """ + Gets a specific object type with the given API name. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ObjectType + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/objectTypes/{objectType}", + query_params={}, + path_params={ + "ontologyRid": ontology_rid, + "objectType": object_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ObjectType, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get_outgoing_link_type( + self, + ontology_rid: OntologyRid, + object_type: ObjectTypeApiName, + link_type: LinkTypeApiName, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> LinkTypeSide: + """ + Get an outgoing link for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param link_type: linkType + :type link_type: LinkTypeApiName + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: LinkTypeSide + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}", + query_params={}, + path_params={ + "ontologyRid": ontology_rid, + "objectType": object_type, + "linkType": link_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=LinkTypeSide, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + ontology_rid: OntologyRid, + *, + page_size: Optional[PageSize] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[ObjectType]: + """ + Lists the object types for the given Ontology. + + Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are + more results available, at least one result will be present in the + response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[ObjectType] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/objectTypes", + query_params={ + "pageSize": page_size, + }, + path_params={ + "ontologyRid": ontology_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListObjectTypesResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list_outgoing_link_types( + self, + ontology_rid: OntologyRid, + object_type: ObjectTypeApiName, + *, + page_size: Optional[PageSize] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[LinkTypeSide]: + """ + List the outgoing links for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[LinkTypeSide] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes", + query_params={ + "pageSize": page_size, + }, + path_params={ + "ontologyRid": ontology_rid, + "objectType": object_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListOutgoingLinkTypesResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + ontology_rid: OntologyRid, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListObjectTypesResponse: + """ + Lists the object types for the given Ontology. + + Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are + more results available, at least one result will be present in the + response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListObjectTypesResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/objectTypes", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + }, + path_params={ + "ontologyRid": ontology_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListObjectTypesResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page_outgoing_link_types( + self, + ontology_rid: OntologyRid, + object_type: ObjectTypeApiName, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListOutgoingLinkTypesResponse: + """ + List the outgoing links for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListOutgoingLinkTypesResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + }, + path_params={ + "ontologyRid": ontology_rid, + "objectType": object_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListOutgoingLinkTypesResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v1/ontologies/ontology.py b/foundry/v1/ontologies/ontology.py new file mode 100644 index 00000000..747d6345 --- /dev/null +++ b/foundry/v1/ontologies/ontology.py @@ -0,0 +1,118 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v1.ontologies.action_type import ActionTypeClient +from foundry.v1.ontologies.models._list_ontologies_response import ListOntologiesResponse # NOQA +from foundry.v1.ontologies.models._ontology import Ontology +from foundry.v1.ontologies.models._ontology_rid import OntologyRid +from foundry.v1.ontologies.object_type import ObjectTypeClient +from foundry.v1.ontologies.query_type import QueryTypeClient + + +class OntologyClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + self.ActionType = ActionTypeClient(auth=auth, hostname=hostname) + self.ObjectType = ObjectTypeClient(auth=auth, hostname=hostname) + self.QueryType = QueryTypeClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get( + self, + ontology_rid: OntologyRid, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Ontology: + """ + Gets a specific ontology with the given Ontology RID. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Ontology + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}", + query_params={}, + path_params={ + "ontologyRid": ontology_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Ontology, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListOntologiesResponse: + """ + Lists the Ontologies visible to the current user. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListOntologiesResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies", + query_params={}, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListOntologiesResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v1/ontologies/ontology_object.py b/foundry/v1/ontologies/ontology_object.py new file mode 100644 index 00000000..f89a4fd7 --- /dev/null +++ b/foundry/v1/ontologies/ontology_object.py @@ -0,0 +1,639 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import List +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v1.core.models._page_size import PageSize +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._aggregate_objects_response import ( + AggregateObjectsResponse, +) # NOQA +from foundry.v1.ontologies.models._aggregation_dict import AggregationDict +from foundry.v1.ontologies.models._aggregation_group_by_dict import AggregationGroupByDict # NOQA +from foundry.v1.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v1.ontologies.models._list_linked_objects_response import ( + ListLinkedObjectsResponse, +) # NOQA +from foundry.v1.ontologies.models._list_objects_response import ListObjectsResponse +from foundry.v1.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v1.ontologies.models._ontology_object import OntologyObject +from foundry.v1.ontologies.models._ontology_rid import OntologyRid +from foundry.v1.ontologies.models._order_by import OrderBy +from foundry.v1.ontologies.models._property_api_name import PropertyApiName +from foundry.v1.ontologies.models._property_value_escaped_string import ( + PropertyValueEscapedString, +) # NOQA +from foundry.v1.ontologies.models._search_json_query_dict import SearchJsonQueryDict +from foundry.v1.ontologies.models._search_objects_response import SearchObjectsResponse +from foundry.v1.ontologies.models._search_order_by_dict import SearchOrderByDict +from foundry.v1.ontologies.models._selected_property_api_name import SelectedPropertyApiName # NOQA + + +class OntologyObjectClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def aggregate( + self, + ontology_rid: OntologyRid, + object_type: ObjectTypeApiName, + *, + aggregation: List[AggregationDict], + group_by: List[AggregationGroupByDict], + query: Optional[SearchJsonQueryDict] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> AggregateObjectsResponse: + """ + Perform functions on object fields in the specified ontology and object type. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param aggregation: + :type aggregation: List[AggregationDict] + :param group_by: + :type group_by: List[AggregationGroupByDict] + :param query: + :type query: Optional[SearchJsonQueryDict] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: AggregateObjectsResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate", + query_params={}, + path_params={ + "ontologyRid": ontology_rid, + "objectType": object_type, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "aggregation": aggregation, + "query": query, + "groupBy": group_by, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "aggregation": List[AggregationDict], + "query": Optional[SearchJsonQueryDict], + "groupBy": List[AggregationGroupByDict], + }, + ), + response_type=AggregateObjectsResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + ontology_rid: OntologyRid, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + *, + properties: Optional[List[SelectedPropertyApiName]] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> OntologyObject: + """ + Gets a specific object with the given primary key. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param properties: properties + :type properties: Optional[List[SelectedPropertyApiName]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: OntologyObject + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}", + query_params={ + "properties": properties, + }, + path_params={ + "ontologyRid": ontology_rid, + "objectType": object_type, + "primaryKey": primary_key, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=OntologyObject, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get_linked_object( + self, + ontology_rid: OntologyRid, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + link_type: LinkTypeApiName, + linked_object_primary_key: PropertyValueEscapedString, + *, + properties: Optional[List[SelectedPropertyApiName]] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> OntologyObject: + """ + Get a specific linked object that originates from another object. If there is no link between the two objects, + LinkedObjectNotFound is thrown. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param link_type: linkType + :type link_type: LinkTypeApiName + :param linked_object_primary_key: linkedObjectPrimaryKey + :type linked_object_primary_key: PropertyValueEscapedString + :param properties: properties + :type properties: Optional[List[SelectedPropertyApiName]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: OntologyObject + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}", + query_params={ + "properties": properties, + }, + path_params={ + "ontologyRid": ontology_rid, + "objectType": object_type, + "primaryKey": primary_key, + "linkType": link_type, + "linkedObjectPrimaryKey": linked_object_primary_key, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=OntologyObject, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + ontology_rid: OntologyRid, + object_type: ObjectTypeApiName, + *, + order_by: Optional[OrderBy] = None, + page_size: Optional[PageSize] = None, + properties: Optional[List[SelectedPropertyApiName]] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[OntologyObject]: + """ + Lists the objects for the given Ontology and object type. + + This endpoint supports filtering objects. + See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. + + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param order_by: orderBy + :type order_by: Optional[OrderBy] + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param properties: properties + :type properties: Optional[List[SelectedPropertyApiName]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[OntologyObject] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}", + query_params={ + "orderBy": order_by, + "pageSize": page_size, + "properties": properties, + }, + path_params={ + "ontologyRid": ontology_rid, + "objectType": object_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListObjectsResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list_linked_objects( + self, + ontology_rid: OntologyRid, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + link_type: LinkTypeApiName, + *, + order_by: Optional[OrderBy] = None, + page_size: Optional[PageSize] = None, + properties: Optional[List[SelectedPropertyApiName]] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[OntologyObject]: + """ + Lists the linked objects for a specific object and the given link type. + + This endpoint supports filtering objects. + See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. + + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param link_type: linkType + :type link_type: LinkTypeApiName + :param order_by: orderBy + :type order_by: Optional[OrderBy] + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param properties: properties + :type properties: Optional[List[SelectedPropertyApiName]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[OntologyObject] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}", + query_params={ + "orderBy": order_by, + "pageSize": page_size, + "properties": properties, + }, + path_params={ + "ontologyRid": ontology_rid, + "objectType": object_type, + "primaryKey": primary_key, + "linkType": link_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListLinkedObjectsResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + ontology_rid: OntologyRid, + object_type: ObjectTypeApiName, + *, + order_by: Optional[OrderBy] = None, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + properties: Optional[List[SelectedPropertyApiName]] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListObjectsResponse: + """ + Lists the objects for the given Ontology and object type. + + This endpoint supports filtering objects. + See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. + + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param order_by: orderBy + :type order_by: Optional[OrderBy] + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param properties: properties + :type properties: Optional[List[SelectedPropertyApiName]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListObjectsResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}", + query_params={ + "orderBy": order_by, + "pageSize": page_size, + "pageToken": page_token, + "properties": properties, + }, + path_params={ + "ontologyRid": ontology_rid, + "objectType": object_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListObjectsResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page_linked_objects( + self, + ontology_rid: OntologyRid, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + link_type: LinkTypeApiName, + *, + order_by: Optional[OrderBy] = None, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + properties: Optional[List[SelectedPropertyApiName]] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListLinkedObjectsResponse: + """ + Lists the linked objects for a specific object and the given link type. + + This endpoint supports filtering objects. + See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. + + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param link_type: linkType + :type link_type: LinkTypeApiName + :param order_by: orderBy + :type order_by: Optional[OrderBy] + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param properties: properties + :type properties: Optional[List[SelectedPropertyApiName]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListLinkedObjectsResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}", + query_params={ + "orderBy": order_by, + "pageSize": page_size, + "pageToken": page_token, + "properties": properties, + }, + path_params={ + "ontologyRid": ontology_rid, + "objectType": object_type, + "primaryKey": primary_key, + "linkType": link_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListLinkedObjectsResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def search( + self, + ontology_rid: OntologyRid, + object_type: ObjectTypeApiName, + *, + fields: List[PropertyApiName], + query: SearchJsonQueryDict, + order_by: Optional[SearchOrderByDict] = None, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> SearchObjectsResponse: + """ + Search for objects in the specified ontology and object type. The request body is used + to filter objects based on the specified query. The supported queries are: + + | Query type | Description | Supported Types | + |----------|-----------------------------------------------------------------------------------|---------------------------------| + | lt | The provided property is less than the provided value. | number, string, date, timestamp | + | gt | The provided property is greater than the provided value. | number, string, date, timestamp | + | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp | + | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp | + | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp | + | isNull | The provided property is (or is not) null. | all | + | contains | The provided property contains the provided value. | array | + | not | The sub-query does not match. | N/A (applied on a query) | + | and | All the sub-queries match. | N/A (applied on queries) | + | or | At least one of the sub-queries match. | N/A (applied on queries) | + | prefix | The provided property starts with the provided value. | string | + | phrase | The provided property contains the provided value as a substring. | string | + | anyTerm | The provided property contains at least one of the terms separated by whitespace. | string | + | allTerms | The provided property contains all the terms separated by whitespace. | string | | + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param fields: The API names of the object type properties to include in the response. + :type fields: List[PropertyApiName] + :param query: + :type query: SearchJsonQueryDict + :param order_by: + :type order_by: Optional[SearchOrderByDict] + :param page_size: + :type page_size: Optional[PageSize] + :param page_token: + :type page_token: Optional[PageToken] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: SearchObjectsResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v1/ontologies/{ontologyRid}/objects/{objectType}/search", + query_params={}, + path_params={ + "ontologyRid": ontology_rid, + "objectType": object_type, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "query": query, + "orderBy": order_by, + "pageSize": page_size, + "pageToken": page_token, + "fields": fields, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "query": SearchJsonQueryDict, + "orderBy": Optional[SearchOrderByDict], + "pageSize": Optional[PageSize], + "pageToken": Optional[PageToken], + "fields": List[PropertyApiName], + }, + ), + response_type=SearchObjectsResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v1/ontologies/query.py b/foundry/v1/ontologies/query.py new file mode 100644 index 00000000..7a49833f --- /dev/null +++ b/foundry/v1/ontologies/query.py @@ -0,0 +1,95 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v1.ontologies.models._data_value import DataValue +from foundry.v1.ontologies.models._execute_query_response import ExecuteQueryResponse +from foundry.v1.ontologies.models._ontology_rid import OntologyRid +from foundry.v1.ontologies.models._parameter_id import ParameterId +from foundry.v1.ontologies.models._query_api_name import QueryApiName + + +class QueryClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def execute( + self, + ontology_rid: OntologyRid, + query_api_name: QueryApiName, + *, + parameters: Dict[ParameterId, Optional[DataValue]], + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ExecuteQueryResponse: + """ + Executes a Query using the given parameters. Optional parameters do not need to be supplied. + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param query_api_name: queryApiName + :type query_api_name: QueryApiName + :param parameters: + :type parameters: Dict[ParameterId, Optional[DataValue]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ExecuteQueryResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute", + query_params={}, + path_params={ + "ontologyRid": ontology_rid, + "queryApiName": query_api_name, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "parameters": parameters, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "parameters": Dict[ParameterId, Optional[DataValue]], + }, + ), + response_type=ExecuteQueryResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v1/ontologies/query_type.py b/foundry/v1/ontologies/query_type.py new file mode 100644 index 00000000..e82f2fe5 --- /dev/null +++ b/foundry/v1/ontologies/query_type.py @@ -0,0 +1,183 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v1.core.models._page_size import PageSize +from foundry.v1.core.models._page_token import PageToken +from foundry.v1.ontologies.models._list_query_types_response import ListQueryTypesResponse # NOQA +from foundry.v1.ontologies.models._ontology_rid import OntologyRid +from foundry.v1.ontologies.models._query_api_name import QueryApiName +from foundry.v1.ontologies.models._query_type import QueryType + + +class QueryTypeClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get( + self, + ontology_rid: OntologyRid, + query_api_name: QueryApiName, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> QueryType: + """ + Gets a specific query type with the given API name. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param query_api_name: queryApiName + :type query_api_name: QueryApiName + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: QueryType + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/queryTypes/{queryApiName}", + query_params={}, + path_params={ + "ontologyRid": ontology_rid, + "queryApiName": query_api_name, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=QueryType, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + ontology_rid: OntologyRid, + *, + page_size: Optional[PageSize] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[QueryType]: + """ + Lists the query types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[QueryType] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/queryTypes", + query_params={ + "pageSize": page_size, + }, + path_params={ + "ontologyRid": ontology_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListQueryTypesResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + ontology_rid: OntologyRid, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListQueryTypesResponse: + """ + Lists the query types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology_rid: ontologyRid + :type ontology_rid: OntologyRid + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListQueryTypesResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v1/ontologies/{ontologyRid}/queryTypes", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + }, + path_params={ + "ontologyRid": ontology_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListQueryTypesResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/__init__.py b/foundry/v2/__init__.py index facd5ce4..8a5bfcff 100644 --- a/foundry/v2/__init__.py +++ b/foundry/v2/__init__.py @@ -13,8 +13,8 @@ # limitations under the License. -from foundry.v2.foundry_client import FoundryV2Client +from foundry.v2.client import FoundryClient __all__ = [ - "FoundryV2Client", + "FoundryClient", ] diff --git a/foundry/v2/_namespaces/admin/group.py b/foundry/v2/_namespaces/admin/group.py deleted file mode 100644 index d023044a..00000000 --- a/foundry/v2/_namespaces/admin/group.py +++ /dev/null @@ -1,382 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import List -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2._namespaces.admin.group_member import GroupMemberResource -from foundry.v2.models._create_group_request import CreateGroupRequest -from foundry.v2.models._create_group_request_dict import CreateGroupRequestDict -from foundry.v2.models._get_groups_batch_request_element import GetGroupsBatchRequestElement # NOQA -from foundry.v2.models._get_groups_batch_request_element_dict import ( - GetGroupsBatchRequestElementDict, -) # NOQA -from foundry.v2.models._get_groups_batch_response import GetGroupsBatchResponse -from foundry.v2.models._group import Group -from foundry.v2.models._list_groups_response import ListGroupsResponse -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._preview_mode import PreviewMode -from foundry.v2.models._principal_id import PrincipalId -from foundry.v2.models._search_groups_request import SearchGroupsRequest -from foundry.v2.models._search_groups_request_dict import SearchGroupsRequestDict -from foundry.v2.models._search_groups_response import SearchGroupsResponse - - -class GroupResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - self.GroupMember = GroupMemberResource(api_client=api_client) - - @validate_call - @handle_unexpected - def create( - self, - create_group_request: Union[CreateGroupRequest, CreateGroupRequestDict], - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Group: - """ - Creates a new Group. - :param create_group_request: Body of the request - :type create_group_request: Union[CreateGroupRequest, CreateGroupRequestDict] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Group - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = create_group_request - _query_params["preview"] = preview - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/admin/groups", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[CreateGroupRequest, CreateGroupRequestDict], - response_type=Group, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def delete( - self, - group_id: PrincipalId, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> None: - """ - Delete the Group with the specified id. - :param group_id: groupId - :type group_id: PrincipalId - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["groupId"] = group_id - - return self._api_client.call_api( - RequestInfo( - method="DELETE", - resource_path="/v2/admin/groups/{groupId}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=None, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - group_id: PrincipalId, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Group: - """ - Get the Group with the specified id. - :param group_id: groupId - :type group_id: PrincipalId - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Group - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["groupId"] = group_id - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/admin/groups/{groupId}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Group, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get_batch( - self, - body: Union[List[GetGroupsBatchRequestElement], List[GetGroupsBatchRequestElementDict]], - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> GetGroupsBatchResponse: - """ - Execute multiple get requests on Group. - - The maximum batch size for this endpoint is 500. - :param body: Body of the request - :type body: Union[List[GetGroupsBatchRequestElement], List[GetGroupsBatchRequestElementDict]] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: GetGroupsBatchResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = body - _query_params["preview"] = preview - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/admin/groups/getBatch", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[ - List[GetGroupsBatchRequestElement], List[GetGroupsBatchRequestElementDict] - ], - response_type=GetGroupsBatchResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - *, - page_size: Optional[PageSize] = None, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[Group]: - """ - Lists all Groups. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[Group] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["preview"] = preview - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v2/admin/groups", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListGroupsResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListGroupsResponse: - """ - Lists all Groups. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListGroupsResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _query_params["preview"] = preview - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/admin/groups", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListGroupsResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def search( - self, - search_groups_request: Union[SearchGroupsRequest, SearchGroupsRequestDict], - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> SearchGroupsResponse: - """ - - :param search_groups_request: Body of the request - :type search_groups_request: Union[SearchGroupsRequest, SearchGroupsRequestDict] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: SearchGroupsResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = search_groups_request - _query_params["preview"] = preview - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/admin/groups/search", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[SearchGroupsRequest, SearchGroupsRequestDict], - response_type=SearchGroupsResponse, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/admin/group_member.py b/foundry/v2/_namespaces/admin/group_member.py deleted file mode 100644 index 2a8afa3d..00000000 --- a/foundry/v2/_namespaces/admin/group_member.py +++ /dev/null @@ -1,266 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictBool -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._add_group_members_request import AddGroupMembersRequest -from foundry.v2.models._add_group_members_request_dict import AddGroupMembersRequestDict -from foundry.v2.models._group_member import GroupMember -from foundry.v2.models._list_group_members_response import ListGroupMembersResponse -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._preview_mode import PreviewMode -from foundry.v2.models._principal_id import PrincipalId -from foundry.v2.models._remove_group_members_request import RemoveGroupMembersRequest -from foundry.v2.models._remove_group_members_request_dict import ( - RemoveGroupMembersRequestDict, -) # NOQA - - -class GroupMemberResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def add( - self, - group_id: PrincipalId, - add_group_members_request: Union[AddGroupMembersRequest, AddGroupMembersRequestDict], - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> None: - """ - - :param group_id: groupId - :type group_id: PrincipalId - :param add_group_members_request: Body of the request - :type add_group_members_request: Union[AddGroupMembersRequest, AddGroupMembersRequestDict] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = add_group_members_request - _query_params["preview"] = preview - - _path_params["groupId"] = group_id - - _header_params["Content-Type"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/admin/groups/{groupId}/groupMembers/add", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[AddGroupMembersRequest, AddGroupMembersRequestDict], - response_type=None, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - group_id: PrincipalId, - *, - page_size: Optional[PageSize] = None, - preview: Optional[PreviewMode] = None, - transitive: Optional[StrictBool] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[GroupMember]: - """ - Lists all GroupMembers. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param group_id: groupId - :type group_id: PrincipalId - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param preview: preview - :type preview: Optional[PreviewMode] - :param transitive: transitive - :type transitive: Optional[StrictBool] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[GroupMember] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["preview"] = preview - - _query_params["transitive"] = transitive - - _path_params["groupId"] = group_id - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v2/admin/groups/{groupId}/groupMembers", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListGroupMembersResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - group_id: PrincipalId, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - preview: Optional[PreviewMode] = None, - transitive: Optional[StrictBool] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListGroupMembersResponse: - """ - Lists all GroupMembers. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param group_id: groupId - :type group_id: PrincipalId - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param preview: preview - :type preview: Optional[PreviewMode] - :param transitive: transitive - :type transitive: Optional[StrictBool] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListGroupMembersResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _query_params["preview"] = preview - - _query_params["transitive"] = transitive - - _path_params["groupId"] = group_id - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/admin/groups/{groupId}/groupMembers", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListGroupMembersResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def remove( - self, - group_id: PrincipalId, - remove_group_members_request: Union[ - RemoveGroupMembersRequest, RemoveGroupMembersRequestDict - ], - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> None: - """ - - :param group_id: groupId - :type group_id: PrincipalId - :param remove_group_members_request: Body of the request - :type remove_group_members_request: Union[RemoveGroupMembersRequest, RemoveGroupMembersRequestDict] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = remove_group_members_request - _query_params["preview"] = preview - - _path_params["groupId"] = group_id - - _header_params["Content-Type"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/admin/groups/{groupId}/groupMembers/remove", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[RemoveGroupMembersRequest, RemoveGroupMembersRequestDict], - response_type=None, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/admin/group_membership.py b/foundry/v2/_namespaces/admin/group_membership.py deleted file mode 100644 index 3e92a5e2..00000000 --- a/foundry/v2/_namespaces/admin/group_membership.py +++ /dev/null @@ -1,161 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictBool -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._group_membership import GroupMembership -from foundry.v2.models._list_group_memberships_response import ListGroupMembershipsResponse # NOQA -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._preview_mode import PreviewMode -from foundry.v2.models._principal_id import PrincipalId - - -class GroupMembershipResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def list( - self, - user_id: PrincipalId, - *, - page_size: Optional[PageSize] = None, - preview: Optional[PreviewMode] = None, - transitive: Optional[StrictBool] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[GroupMembership]: - """ - Lists all GroupMemberships. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param user_id: userId - :type user_id: PrincipalId - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param preview: preview - :type preview: Optional[PreviewMode] - :param transitive: transitive - :type transitive: Optional[StrictBool] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[GroupMembership] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["preview"] = preview - - _query_params["transitive"] = transitive - - _path_params["userId"] = user_id - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v2/admin/users/{userId}/groupMemberships", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListGroupMembershipsResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - user_id: PrincipalId, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - preview: Optional[PreviewMode] = None, - transitive: Optional[StrictBool] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListGroupMembershipsResponse: - """ - Lists all GroupMemberships. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param user_id: userId - :type user_id: PrincipalId - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param preview: preview - :type preview: Optional[PreviewMode] - :param transitive: transitive - :type transitive: Optional[StrictBool] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListGroupMembershipsResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _query_params["preview"] = preview - - _query_params["transitive"] = transitive - - _path_params["userId"] = user_id - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/admin/users/{userId}/groupMemberships", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListGroupMembershipsResponse, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/admin/user.py b/foundry/v2/_namespaces/admin/user.py deleted file mode 100644 index caf60e9c..00000000 --- a/foundry/v2/_namespaces/admin/user.py +++ /dev/null @@ -1,420 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import List -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2._namespaces.admin.group_membership import GroupMembershipResource -from foundry.v2.models._get_users_batch_request_element import GetUsersBatchRequestElement # NOQA -from foundry.v2.models._get_users_batch_request_element_dict import ( - GetUsersBatchRequestElementDict, -) # NOQA -from foundry.v2.models._get_users_batch_response import GetUsersBatchResponse -from foundry.v2.models._list_users_response import ListUsersResponse -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._preview_mode import PreviewMode -from foundry.v2.models._principal_id import PrincipalId -from foundry.v2.models._search_users_request import SearchUsersRequest -from foundry.v2.models._search_users_request_dict import SearchUsersRequestDict -from foundry.v2.models._search_users_response import SearchUsersResponse -from foundry.v2.models._user import User - - -class UserResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - self.GroupMembership = GroupMembershipResource(api_client=api_client) - - @validate_call - @handle_unexpected - def delete( - self, - user_id: PrincipalId, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> None: - """ - Delete the User with the specified id. - :param user_id: userId - :type user_id: PrincipalId - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["userId"] = user_id - - return self._api_client.call_api( - RequestInfo( - method="DELETE", - resource_path="/v2/admin/users/{userId}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=None, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - user_id: PrincipalId, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> User: - """ - Get the User with the specified id. - :param user_id: userId - :type user_id: PrincipalId - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: User - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["userId"] = user_id - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/admin/users/{userId}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=User, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get_batch( - self, - body: Union[List[GetUsersBatchRequestElement], List[GetUsersBatchRequestElementDict]], - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> GetUsersBatchResponse: - """ - Execute multiple get requests on User. - - The maximum batch size for this endpoint is 500. - :param body: Body of the request - :type body: Union[List[GetUsersBatchRequestElement], List[GetUsersBatchRequestElementDict]] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: GetUsersBatchResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = body - _query_params["preview"] = preview - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/admin/users/getBatch", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[ - List[GetUsersBatchRequestElement], List[GetUsersBatchRequestElementDict] - ], - response_type=GetUsersBatchResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get_current( - self, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> User: - """ - - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: User - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/admin/users/getCurrent", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=User, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - *, - page_size: Optional[PageSize] = None, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[User]: - """ - Lists all Users. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[User] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["preview"] = preview - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v2/admin/users", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListUsersResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListUsersResponse: - """ - Lists all Users. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListUsersResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _query_params["preview"] = preview - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/admin/users", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListUsersResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def profile_picture( - self, - user_id: PrincipalId, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> bytes: - """ - - :param user_id: userId - :type user_id: PrincipalId - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: bytes - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["userId"] = user_id - - _header_params["Accept"] = "application/octet-stream" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/admin/users/{userId}/profilePicture", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=bytes, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def search( - self, - search_users_request: Union[SearchUsersRequest, SearchUsersRequestDict], - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> SearchUsersResponse: - """ - - :param search_users_request: Body of the request - :type search_users_request: Union[SearchUsersRequest, SearchUsersRequestDict] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: SearchUsersResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = search_users_request - _query_params["preview"] = preview - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/admin/users/search", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[SearchUsersRequest, SearchUsersRequestDict], - response_type=SearchUsersResponse, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/datasets/branch.py b/foundry/v2/_namespaces/datasets/branch.py deleted file mode 100644 index 5bab1b0f..00000000 --- a/foundry/v2/_namespaces/datasets/branch.py +++ /dev/null @@ -1,303 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._branch import Branch -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._create_branch_request import CreateBranchRequest -from foundry.v2.models._create_branch_request_dict import CreateBranchRequestDict -from foundry.v2.models._dataset_rid import DatasetRid -from foundry.v2.models._list_branches_response import ListBranchesResponse -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._preview_mode import PreviewMode - - -class BranchResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def create( - self, - dataset_rid: DatasetRid, - create_branch_request: Union[CreateBranchRequest, CreateBranchRequestDict], - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Branch: - """ - Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param create_branch_request: Body of the request - :type create_branch_request: Union[CreateBranchRequest, CreateBranchRequestDict] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Branch - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = create_branch_request - _query_params["preview"] = preview - - _path_params["datasetRid"] = dataset_rid - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/datasets/{datasetRid}/branches", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[CreateBranchRequest, CreateBranchRequestDict], - response_type=Branch, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def delete( - self, - dataset_rid: DatasetRid, - branch_name: BranchName, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> None: - """ - Deletes the Branch with the given BranchName. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param branch_name: branchName - :type branch_name: BranchName - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["datasetRid"] = dataset_rid - - _path_params["branchName"] = branch_name - - return self._api_client.call_api( - RequestInfo( - method="DELETE", - resource_path="/v2/datasets/{datasetRid}/branches/{branchName}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=None, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - dataset_rid: DatasetRid, - branch_name: BranchName, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Branch: - """ - Get a Branch of a Dataset. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param branch_name: branchName - :type branch_name: BranchName - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Branch - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["datasetRid"] = dataset_rid - - _path_params["branchName"] = branch_name - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/datasets/{datasetRid}/branches/{branchName}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Branch, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - dataset_rid: DatasetRid, - *, - page_size: Optional[PageSize] = None, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[Branch]: - """ - Lists the Branches of a Dataset. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[Branch] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["preview"] = preview - - _path_params["datasetRid"] = dataset_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v2/datasets/{datasetRid}/branches", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListBranchesResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - dataset_rid: DatasetRid, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListBranchesResponse: - """ - Lists the Branches of a Dataset. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListBranchesResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _query_params["preview"] = preview - - _path_params["datasetRid"] = dataset_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/datasets/{datasetRid}/branches", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListBranchesResponse, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/datasets/dataset.py b/foundry/v2/_namespaces/datasets/dataset.py deleted file mode 100644 index 11d66cc9..00000000 --- a/foundry/v2/_namespaces/datasets/dataset.py +++ /dev/null @@ -1,221 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import List -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import StrictStr -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2._namespaces.datasets.branch import BranchResource -from foundry.v2._namespaces.datasets.file import FileResource -from foundry.v2._namespaces.datasets.transaction import TransactionResource -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._create_dataset_request import CreateDatasetRequest -from foundry.v2.models._create_dataset_request_dict import CreateDatasetRequestDict -from foundry.v2.models._dataset import Dataset -from foundry.v2.models._dataset_rid import DatasetRid -from foundry.v2.models._preview_mode import PreviewMode -from foundry.v2.models._table_export_format import TableExportFormat -from foundry.v2.models._transaction_rid import TransactionRid - - -class DatasetResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - self.Branch = BranchResource(api_client=api_client) - self.Transaction = TransactionResource(api_client=api_client) - self.File = FileResource(api_client=api_client) - - @validate_call - @handle_unexpected - def create( - self, - create_dataset_request: Union[CreateDatasetRequest, CreateDatasetRequestDict], - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Dataset: - """ - Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset. - - :param create_dataset_request: Body of the request - :type create_dataset_request: Union[CreateDatasetRequest, CreateDatasetRequestDict] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Dataset - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = create_dataset_request - _query_params["preview"] = preview - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/datasets", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[CreateDatasetRequest, CreateDatasetRequestDict], - response_type=Dataset, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - dataset_rid: DatasetRid, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Dataset: - """ - Get the Dataset with the specified rid. - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Dataset - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["datasetRid"] = dataset_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/datasets/{datasetRid}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Dataset, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def read_table( - self, - dataset_rid: DatasetRid, - *, - format: TableExportFormat, - branch_name: Optional[BranchName] = None, - columns: Optional[List[StrictStr]] = None, - end_transaction_rid: Optional[TransactionRid] = None, - preview: Optional[PreviewMode] = None, - row_limit: Optional[StrictInt] = None, - start_transaction_rid: Optional[TransactionRid] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> bytes: - """ - Gets the content of a dataset as a table in the specified format. - - This endpoint currently does not support views (Virtual datasets composed of other datasets). - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param format: format - :type format: TableExportFormat - :param branch_name: branchName - :type branch_name: Optional[BranchName] - :param columns: columns - :type columns: Optional[List[StrictStr]] - :param end_transaction_rid: endTransactionRid - :type end_transaction_rid: Optional[TransactionRid] - :param preview: preview - :type preview: Optional[PreviewMode] - :param row_limit: rowLimit - :type row_limit: Optional[StrictInt] - :param start_transaction_rid: startTransactionRid - :type start_transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: bytes - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["format"] = format - - _query_params["branchName"] = branch_name - - _query_params["columns"] = columns - - _query_params["endTransactionRid"] = end_transaction_rid - - _query_params["preview"] = preview - - _query_params["rowLimit"] = row_limit - - _query_params["startTransactionRid"] = start_transaction_rid - - _path_params["datasetRid"] = dataset_rid - - _header_params["Accept"] = "application/octet-stream" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/datasets/{datasetRid}/readTable", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=bytes, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/datasets/file.py b/foundry/v2/_namespaces/datasets/file.py deleted file mode 100644 index 48b2aa7e..00000000 --- a/foundry/v2/_namespaces/datasets/file.py +++ /dev/null @@ -1,530 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._dataset_rid import DatasetRid -from foundry.v2.models._file import File -from foundry.v2.models._file_path import FilePath -from foundry.v2.models._list_files_response import ListFilesResponse -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._preview_mode import PreviewMode -from foundry.v2.models._transaction_rid import TransactionRid -from foundry.v2.models._transaction_type import TransactionType - - -class FileResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def content( - self, - dataset_rid: DatasetRid, - file_path: FilePath, - *, - branch_name: Optional[BranchName] = None, - end_transaction_rid: Optional[TransactionRid] = None, - preview: Optional[PreviewMode] = None, - start_transaction_rid: Optional[TransactionRid] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> bytes: - """ - Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest - view of the default branch - `master` for most enrollments. - #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - To **get a file's content from a specific Branch** specify the Branch's name as `branchName`. This will - retrieve the content for the most recent version of the file since the latest snapshot transaction, or the - earliest ancestor transaction of the branch if there are no snapshot transactions. - To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier - as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest - snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions. - To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's - resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. - This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the - `endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior - is undefined when the start and end transactions do not belong to the same root-to-leaf path. - To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the - `startTransactionRid` and `endTransactionRid`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param file_path: filePath - :type file_path: FilePath - :param branch_name: branchName - :type branch_name: Optional[BranchName] - :param end_transaction_rid: endTransactionRid - :type end_transaction_rid: Optional[TransactionRid] - :param preview: preview - :type preview: Optional[PreviewMode] - :param start_transaction_rid: startTransactionRid - :type start_transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: bytes - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["branchName"] = branch_name - - _query_params["endTransactionRid"] = end_transaction_rid - - _query_params["preview"] = preview - - _query_params["startTransactionRid"] = start_transaction_rid - - _path_params["datasetRid"] = dataset_rid - - _path_params["filePath"] = file_path - - _header_params["Accept"] = "application/octet-stream" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/datasets/{datasetRid}/files/{filePath}/content", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=bytes, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def delete( - self, - dataset_rid: DatasetRid, - file_path: FilePath, - *, - branch_name: Optional[BranchName] = None, - preview: Optional[PreviewMode] = None, - transaction_rid: Optional[TransactionRid] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> None: - """ - Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default - branch - `master` for most enrollments. The file will still be visible on historical views. - #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - To **delete a File from a specific Branch** specify the Branch's name as `branchName`. A new delete Transaction - will be created and committed on this branch. - To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier - as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a - single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to - open a transaction. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param file_path: filePath - :type file_path: FilePath - :param branch_name: branchName - :type branch_name: Optional[BranchName] - :param preview: preview - :type preview: Optional[PreviewMode] - :param transaction_rid: transactionRid - :type transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["branchName"] = branch_name - - _query_params["preview"] = preview - - _query_params["transactionRid"] = transaction_rid - - _path_params["datasetRid"] = dataset_rid - - _path_params["filePath"] = file_path - - return self._api_client.call_api( - RequestInfo( - method="DELETE", - resource_path="/v2/datasets/{datasetRid}/files/{filePath}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=None, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - dataset_rid: DatasetRid, - file_path: FilePath, - *, - branch_name: Optional[BranchName] = None, - end_transaction_rid: Optional[TransactionRid] = None, - preview: Optional[PreviewMode] = None, - start_transaction_rid: Optional[TransactionRid] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> File: - """ - Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest - view of the default branch - `master` for most enrollments. - #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - To **get a file's metadata from a specific Branch** specify the Branch's name as `branchName`. This will - retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest - ancestor transaction of the branch if there are no snapshot transactions. - To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier - as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot - transaction, or the earliest ancestor transaction if there are no snapshot transactions. - To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's - resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. - This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the - `endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path. - To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the - `startTransactionRid` and `endTransactionRid`. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param file_path: filePath - :type file_path: FilePath - :param branch_name: branchName - :type branch_name: Optional[BranchName] - :param end_transaction_rid: endTransactionRid - :type end_transaction_rid: Optional[TransactionRid] - :param preview: preview - :type preview: Optional[PreviewMode] - :param start_transaction_rid: startTransactionRid - :type start_transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: File - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["branchName"] = branch_name - - _query_params["endTransactionRid"] = end_transaction_rid - - _query_params["preview"] = preview - - _query_params["startTransactionRid"] = start_transaction_rid - - _path_params["datasetRid"] = dataset_rid - - _path_params["filePath"] = file_path - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/datasets/{datasetRid}/files/{filePath}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=File, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - dataset_rid: DatasetRid, - *, - branch_name: Optional[BranchName] = None, - end_transaction_rid: Optional[TransactionRid] = None, - page_size: Optional[PageSize] = None, - preview: Optional[PreviewMode] = None, - start_transaction_rid: Optional[TransactionRid] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[File]: - """ - Lists Files contained in a Dataset. By default files are listed on the latest view of the default - branch - `master` for most enrollments. - #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most - recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the - branch if there are no snapshot transactions. - To **list files on the resolved view of a transaction** specify the Transaction's resource identifier - as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot - transaction, or the earliest ancestor transaction if there are no snapshot transactions. - To **list files on the resolved view of a range of transactions** specify the the start transaction's resource - identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This - will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. - Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when - the start and end transactions do not belong to the same root-to-leaf path. - To **list files on a specific transaction** specify the Transaction's resource identifier as both the - `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that - Transaction. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param branch_name: branchName - :type branch_name: Optional[BranchName] - :param end_transaction_rid: endTransactionRid - :type end_transaction_rid: Optional[TransactionRid] - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param preview: preview - :type preview: Optional[PreviewMode] - :param start_transaction_rid: startTransactionRid - :type start_transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[File] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["branchName"] = branch_name - - _query_params["endTransactionRid"] = end_transaction_rid - - _query_params["pageSize"] = page_size - - _query_params["preview"] = preview - - _query_params["startTransactionRid"] = start_transaction_rid - - _path_params["datasetRid"] = dataset_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v2/datasets/{datasetRid}/files", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListFilesResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - dataset_rid: DatasetRid, - *, - branch_name: Optional[BranchName] = None, - end_transaction_rid: Optional[TransactionRid] = None, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - preview: Optional[PreviewMode] = None, - start_transaction_rid: Optional[TransactionRid] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListFilesResponse: - """ - Lists Files contained in a Dataset. By default files are listed on the latest view of the default - branch - `master` for most enrollments. - #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most - recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the - branch if there are no snapshot transactions. - To **list files on the resolved view of a transaction** specify the Transaction's resource identifier - as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot - transaction, or the earliest ancestor transaction if there are no snapshot transactions. - To **list files on the resolved view of a range of transactions** specify the the start transaction's resource - identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This - will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. - Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when - the start and end transactions do not belong to the same root-to-leaf path. - To **list files on a specific transaction** specify the Transaction's resource identifier as both the - `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that - Transaction. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param branch_name: branchName - :type branch_name: Optional[BranchName] - :param end_transaction_rid: endTransactionRid - :type end_transaction_rid: Optional[TransactionRid] - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param preview: preview - :type preview: Optional[PreviewMode] - :param start_transaction_rid: startTransactionRid - :type start_transaction_rid: Optional[TransactionRid] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListFilesResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["branchName"] = branch_name - - _query_params["endTransactionRid"] = end_transaction_rid - - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _query_params["preview"] = preview - - _query_params["startTransactionRid"] = start_transaction_rid - - _path_params["datasetRid"] = dataset_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/datasets/{datasetRid}/files", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListFilesResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def upload( - self, - dataset_rid: DatasetRid, - file_path: FilePath, - body: bytes, - *, - branch_name: Optional[BranchName] = None, - preview: Optional[PreviewMode] = None, - transaction_rid: Optional[TransactionRid] = None, - transaction_type: Optional[TransactionType] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> File: - """ - Uploads a File to an existing Dataset. - The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. - By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments. - If the file already exists only the most recent version will be visible in the updated view. - #### Advanced Usage - See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. - To **upload a file to a specific Branch** specify the Branch's name as `branchName`. A new transaction will - be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this - default specify `transactionType` in addition to `branchName`. - See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. - To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as - `transactionRid`. This is useful for uploading multiple files in a single transaction. - See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param file_path: filePath - :type file_path: FilePath - :param body: Body of the request - :type body: bytes - :param branch_name: branchName - :type branch_name: Optional[BranchName] - :param preview: preview - :type preview: Optional[PreviewMode] - :param transaction_rid: transactionRid - :type transaction_rid: Optional[TransactionRid] - :param transaction_type: transactionType - :type transaction_type: Optional[TransactionType] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: File - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = body - _query_params["branchName"] = branch_name - - _query_params["preview"] = preview - - _query_params["transactionRid"] = transaction_rid - - _query_params["transactionType"] = transaction_type - - _path_params["datasetRid"] = dataset_rid - - _path_params["filePath"] = file_path - - _header_params["Content-Type"] = "application/octet-stream" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/datasets/{datasetRid}/files/{filePath}/upload", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=bytes, - response_type=File, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/datasets/transaction.py b/foundry/v2/_namespaces/datasets/transaction.py deleted file mode 100644 index 77b29798..00000000 --- a/foundry/v2/_namespaces/datasets/transaction.py +++ /dev/null @@ -1,253 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._create_transaction_request import CreateTransactionRequest -from foundry.v2.models._create_transaction_request_dict import CreateTransactionRequestDict # NOQA -from foundry.v2.models._dataset_rid import DatasetRid -from foundry.v2.models._preview_mode import PreviewMode -from foundry.v2.models._transaction import Transaction -from foundry.v2.models._transaction_rid import TransactionRid - - -class TransactionResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def abort( - self, - dataset_rid: DatasetRid, - transaction_rid: TransactionRid, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Transaction: - """ - Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is - not updated. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param transaction_rid: transactionRid - :type transaction_rid: TransactionRid - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Transaction - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["datasetRid"] = dataset_rid - - _path_params["transactionRid"] = transaction_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/datasets/{datasetRid}/transactions/{transactionRid}/abort", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Transaction, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def commit( - self, - dataset_rid: DatasetRid, - transaction_rid: TransactionRid, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Transaction: - """ - Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is - updated to point to the Transaction. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param transaction_rid: transactionRid - :type transaction_rid: TransactionRid - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Transaction - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["datasetRid"] = dataset_rid - - _path_params["transactionRid"] = transaction_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/datasets/{datasetRid}/transactions/{transactionRid}/commit", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Transaction, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def create( - self, - dataset_rid: DatasetRid, - create_transaction_request: Union[CreateTransactionRequest, CreateTransactionRequestDict], - *, - branch_name: Optional[BranchName] = None, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Transaction: - """ - Creates a Transaction on a Branch of a Dataset. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param create_transaction_request: Body of the request - :type create_transaction_request: Union[CreateTransactionRequest, CreateTransactionRequestDict] - :param branch_name: branchName - :type branch_name: Optional[BranchName] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Transaction - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = create_transaction_request - _query_params["branchName"] = branch_name - - _query_params["preview"] = preview - - _path_params["datasetRid"] = dataset_rid - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/datasets/{datasetRid}/transactions", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[CreateTransactionRequest, CreateTransactionRequestDict], - response_type=Transaction, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - dataset_rid: DatasetRid, - transaction_rid: TransactionRid, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Transaction: - """ - Gets a Transaction of a Dataset. - - :param dataset_rid: datasetRid - :type dataset_rid: DatasetRid - :param transaction_rid: transactionRid - :type transaction_rid: TransactionRid - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Transaction - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["datasetRid"] = dataset_rid - - _path_params["transactionRid"] = transaction_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/datasets/{datasetRid}/transactions/{transactionRid}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Transaction, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/namespaces.py b/foundry/v2/_namespaces/namespaces.py deleted file mode 100644 index 3494488c..00000000 --- a/foundry/v2/_namespaces/namespaces.py +++ /dev/null @@ -1,74 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.api_client import ApiClient -from foundry.v2._namespaces.admin.group import GroupResource -from foundry.v2._namespaces.admin.user import UserResource -from foundry.v2._namespaces.datasets.dataset import DatasetResource -from foundry.v2._namespaces.ontologies.action import ActionResource -from foundry.v2._namespaces.ontologies.attachment import AttachmentResource -from foundry.v2._namespaces.ontologies.attachment_property import AttachmentPropertyResource # NOQA -from foundry.v2._namespaces.ontologies.linked_object import LinkedObjectResource -from foundry.v2._namespaces.ontologies.ontology import OntologyResource -from foundry.v2._namespaces.ontologies.ontology_interface import OntologyInterfaceResource # NOQA -from foundry.v2._namespaces.ontologies.ontology_object import OntologyObjectResource -from foundry.v2._namespaces.ontologies.ontology_object_set import OntologyObjectSetResource # NOQA -from foundry.v2._namespaces.ontologies.query import QueryResource -from foundry.v2._namespaces.ontologies.time_series_property_v2 import ( - TimeSeriesPropertyV2Resource, -) # NOQA -from foundry.v2._namespaces.orchestration.build import BuildResource -from foundry.v2._namespaces.orchestration.schedule import ScheduleResource -from foundry.v2._namespaces.thirdpartyapplications.third_party_application import ( - ThirdPartyApplicationResource, -) # NOQA - - -class Admin: - def __init__(self, api_client: ApiClient): - self.Group = GroupResource(api_client=api_client) - self.User = UserResource(api_client=api_client) - - -class Datasets: - def __init__(self, api_client: ApiClient): - self.Dataset = DatasetResource(api_client=api_client) - - -class Ontologies: - def __init__(self, api_client: ApiClient): - self.Action = ActionResource(api_client=api_client) - self.Attachment = AttachmentResource(api_client=api_client) - self.AttachmentProperty = AttachmentPropertyResource(api_client=api_client) - self.LinkedObject = LinkedObjectResource(api_client=api_client) - self.Ontology = OntologyResource(api_client=api_client) - self.OntologyInterface = OntologyInterfaceResource(api_client=api_client) - self.OntologyObject = OntologyObjectResource(api_client=api_client) - self.OntologyObjectSet = OntologyObjectSetResource(api_client=api_client) - self.Query = QueryResource(api_client=api_client) - self.TimeSeriesPropertyV2 = TimeSeriesPropertyV2Resource(api_client=api_client) - - -class Orchestration: - def __init__(self, api_client: ApiClient): - self.Build = BuildResource(api_client=api_client) - self.Schedule = ScheduleResource(api_client=api_client) - - -class ThirdPartyApplications: - def __init__(self, api_client: ApiClient): - self.ThirdPartyApplication = ThirdPartyApplicationResource(api_client=api_client) diff --git a/foundry/v2/_namespaces/ontologies/action.py b/foundry/v2/_namespaces/ontologies/action.py deleted file mode 100644 index 4cb05c54..00000000 --- a/foundry/v2/_namespaces/ontologies/action.py +++ /dev/null @@ -1,188 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._action_type_api_name import ActionTypeApiName -from foundry.v2.models._apply_action_request_v2 import ApplyActionRequestV2 -from foundry.v2.models._apply_action_request_v2_dict import ApplyActionRequestV2Dict -from foundry.v2.models._artifact_repository_rid import ArtifactRepositoryRid -from foundry.v2.models._batch_apply_action_request_v2 import BatchApplyActionRequestV2 -from foundry.v2.models._batch_apply_action_request_v2_dict import ( - BatchApplyActionRequestV2Dict, -) # NOQA -from foundry.v2.models._batch_apply_action_response_v2 import BatchApplyActionResponseV2 -from foundry.v2.models._ontology_identifier import OntologyIdentifier -from foundry.v2.models._sdk_package_name import SdkPackageName -from foundry.v2.models._sync_apply_action_response_v2 import SyncApplyActionResponseV2 - - -class ActionResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def apply( - self, - ontology: OntologyIdentifier, - action: ActionTypeApiName, - apply_action_request_v2: Union[ApplyActionRequestV2, ApplyActionRequestV2Dict], - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> SyncApplyActionResponseV2: - """ - Applies an action using the given parameters. - - Changes to the Ontology are eventually consistent and may take some time to be visible. - - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by - this endpoint. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read api:ontologies-write`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param action: action - :type action: ActionTypeApiName - :param apply_action_request_v2: Body of the request - :type apply_action_request_v2: Union[ApplyActionRequestV2, ApplyActionRequestV2Dict] - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: SyncApplyActionResponseV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = apply_action_request_v2 - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _path_params["action"] = action - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/actions/{action}/apply", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[ApplyActionRequestV2, ApplyActionRequestV2Dict], - response_type=SyncApplyActionResponseV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def apply_batch( - self, - ontology: OntologyIdentifier, - action: ActionTypeApiName, - batch_apply_action_request_v2: Union[ - BatchApplyActionRequestV2, BatchApplyActionRequestV2Dict - ], - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> BatchApplyActionResponseV2: - """ - Applies multiple actions (of the same Action Type) using the given parameters. - Changes to the Ontology are eventually consistent and may take some time to be visible. - - Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not - call Functions may receive a higher limit. - - Note that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read api:ontologies-write`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param action: action - :type action: ActionTypeApiName - :param batch_apply_action_request_v2: Body of the request - :type batch_apply_action_request_v2: Union[BatchApplyActionRequestV2, BatchApplyActionRequestV2Dict] - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: BatchApplyActionResponseV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = batch_apply_action_request_v2 - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _path_params["action"] = action - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/actions/{action}/applyBatch", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[BatchApplyActionRequestV2, BatchApplyActionRequestV2Dict], - response_type=BatchApplyActionResponseV2, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/ontologies/action_type.py b/foundry/v2/_namespaces/ontologies/action_type.py deleted file mode 100644 index 725dc5a6..00000000 --- a/foundry/v2/_namespaces/ontologies/action_type.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._action_type_api_name import ActionTypeApiName -from foundry.v2.models._action_type_v2 import ActionTypeV2 -from foundry.v2.models._list_action_types_response_v2 import ListActionTypesResponseV2 -from foundry.v2.models._ontology_identifier import OntologyIdentifier -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken - - -class ActionTypeResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def get( - self, - ontology: OntologyIdentifier, - action_type: ActionTypeApiName, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ActionTypeV2: - """ - Gets a specific action type with the given API name. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param action_type: actionType - :type action_type: ActionTypeApiName - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ActionTypeV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["ontology"] = ontology - - _path_params["actionType"] = action_type - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/actionTypes/{actionType}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ActionTypeV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - ontology: OntologyIdentifier, - *, - page_size: Optional[PageSize] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[ActionTypeV2]: - """ - Lists the action types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[ActionTypeV2] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _path_params["ontology"] = ontology - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/actionTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListActionTypesResponseV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - ontology: OntologyIdentifier, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListActionTypesResponseV2: - """ - Lists the action types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListActionTypesResponseV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _path_params["ontology"] = ontology - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/actionTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListActionTypesResponseV2, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/ontologies/attachment.py b/foundry/v2/_namespaces/ontologies/attachment.py deleted file mode 100644 index 9c84c7b8..00000000 --- a/foundry/v2/_namespaces/ontologies/attachment.py +++ /dev/null @@ -1,192 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._attachment_rid import AttachmentRid -from foundry.v2.models._attachment_v2 import AttachmentV2 -from foundry.v2.models._content_length import ContentLength -from foundry.v2.models._content_type import ContentType -from foundry.v2.models._filename import Filename - - -class AttachmentResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def get( - self, - attachment_rid: AttachmentRid, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> AttachmentV2: - """ - Get the metadata of an attachment. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param attachment_rid: attachmentRid - :type attachment_rid: AttachmentRid - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: AttachmentV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["attachmentRid"] = attachment_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/attachments/{attachmentRid}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=AttachmentV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def read( - self, - attachment_rid: AttachmentRid, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> bytes: - """ - Get the content of an attachment. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param attachment_rid: attachmentRid - :type attachment_rid: AttachmentRid - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: bytes - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["attachmentRid"] = attachment_rid - - _header_params["Accept"] = "*/*" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/attachments/{attachmentRid}/content", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=bytes, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def upload( - self, - body: bytes, - *, - content_length: ContentLength, - content_type: ContentType, - filename: Filename, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> AttachmentV2: - """ - Upload an attachment to use in an action. Any attachment which has not been linked to an object via - an action within one hour after upload will be removed. - Previously mapped attachments which are not connected to any object anymore are also removed on - a biweekly basis. - The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-write`. - - :param body: Body of the request - :type body: bytes - :param content_length: Content-Length - :type content_length: ContentLength - :param content_type: Content-Type - :type content_type: ContentType - :param filename: filename - :type filename: Filename - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: AttachmentV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = body - _query_params["filename"] = filename - - _header_params["Content-Length"] = content_length - - _header_params["Content-Type"] = content_type - - _header_params["Content-Type"] = "*/*" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/ontologies/attachments/upload", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=bytes, - response_type=AttachmentV2, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/ontologies/attachment_property.py b/foundry/v2/_namespaces/ontologies/attachment_property.py deleted file mode 100644 index b233d813..00000000 --- a/foundry/v2/_namespaces/ontologies/attachment_property.py +++ /dev/null @@ -1,331 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._artifact_repository_rid import ArtifactRepositoryRid -from foundry.v2.models._attachment_metadata_response import AttachmentMetadataResponse -from foundry.v2.models._attachment_rid import AttachmentRid -from foundry.v2.models._attachment_v2 import AttachmentV2 -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._ontology_identifier import OntologyIdentifier -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value_escaped_string import PropertyValueEscapedString -from foundry.v2.models._sdk_package_name import SdkPackageName - - -class AttachmentPropertyResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def get_attachment( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - property: PropertyApiName, - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> AttachmentMetadataResponse: - """ - Get the metadata of attachments parented to the given object. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param property: property - :type property: PropertyApiName - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: AttachmentMetadataResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _path_params["property"] = property - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=AttachmentMetadataResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get_attachment_by_rid( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - property: PropertyApiName, - attachment_rid: AttachmentRid, - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> AttachmentV2: - """ - Get the metadata of a particular attachment in an attachment list. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param property: property - :type property: PropertyApiName - :param attachment_rid: attachmentRid - :type attachment_rid: AttachmentRid - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: AttachmentV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _path_params["property"] = property - - _path_params["attachmentRid"] = attachment_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=AttachmentV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def read_attachment( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - property: PropertyApiName, - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> bytes: - """ - Get the content of an attachment. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param property: property - :type property: PropertyApiName - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: bytes - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _path_params["property"] = property - - _header_params["Accept"] = "*/*" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=bytes, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def read_attachment_by_rid( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - property: PropertyApiName, - attachment_rid: AttachmentRid, - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> bytes: - """ - Get the content of an attachment by its RID. - - The RID must exist in the attachment array of the property. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param property: property - :type property: PropertyApiName - :param attachment_rid: attachmentRid - :type attachment_rid: AttachmentRid - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: bytes - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _path_params["property"] = property - - _path_params["attachmentRid"] = attachment_rid - - _header_params["Accept"] = "*/*" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=bytes, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/ontologies/linked_object.py b/foundry/v2/_namespaces/ontologies/linked_object.py deleted file mode 100644 index 31fac95e..00000000 --- a/foundry/v2/_namespaces/ontologies/linked_object.py +++ /dev/null @@ -1,339 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import List -from typing import Optional - -from pydantic import Field -from pydantic import StrictBool -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._artifact_repository_rid import ArtifactRepositoryRid -from foundry.v2.models._link_type_api_name import LinkTypeApiName -from foundry.v2.models._list_linked_objects_response_v2 import ListLinkedObjectsResponseV2 # NOQA -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._ontology_identifier import OntologyIdentifier -from foundry.v2.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v2.models._order_by import OrderBy -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._property_value_escaped_string import PropertyValueEscapedString -from foundry.v2.models._sdk_package_name import SdkPackageName -from foundry.v2.models._selected_property_api_name import SelectedPropertyApiName - - -class LinkedObjectResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def get_linked_object( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - link_type: LinkTypeApiName, - linked_object_primary_key: PropertyValueEscapedString, - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - exclude_rid: Optional[StrictBool] = None, - package_name: Optional[SdkPackageName] = None, - select: Optional[List[SelectedPropertyApiName]] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> OntologyObjectV2: - """ - Get a specific linked object that originates from another object. - - If there is no link between the two objects, `LinkedObjectNotFound` is thrown. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param link_type: linkType - :type link_type: LinkTypeApiName - :param linked_object_primary_key: linkedObjectPrimaryKey - :type linked_object_primary_key: PropertyValueEscapedString - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param exclude_rid: excludeRid - :type exclude_rid: Optional[StrictBool] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param select: select - :type select: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: OntologyObjectV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["artifactRepository"] = artifact_repository - - _query_params["excludeRid"] = exclude_rid - - _query_params["packageName"] = package_name - - _query_params["select"] = select - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _path_params["linkType"] = link_type - - _path_params["linkedObjectPrimaryKey"] = linked_object_primary_key - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=OntologyObjectV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list_linked_objects( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - link_type: LinkTypeApiName, - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - exclude_rid: Optional[StrictBool] = None, - order_by: Optional[OrderBy] = None, - package_name: Optional[SdkPackageName] = None, - page_size: Optional[PageSize] = None, - select: Optional[List[SelectedPropertyApiName]] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[OntologyObjectV2]: - """ - Lists the linked objects for a specific object and the given link type. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param link_type: linkType - :type link_type: LinkTypeApiName - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param exclude_rid: excludeRid - :type exclude_rid: Optional[StrictBool] - :param order_by: orderBy - :type order_by: Optional[OrderBy] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param select: select - :type select: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[OntologyObjectV2] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["artifactRepository"] = artifact_repository - - _query_params["excludeRid"] = exclude_rid - - _query_params["orderBy"] = order_by - - _query_params["packageName"] = package_name - - _query_params["pageSize"] = page_size - - _query_params["select"] = select - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _path_params["linkType"] = link_type - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListLinkedObjectsResponseV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page_linked_objects( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - link_type: LinkTypeApiName, - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - exclude_rid: Optional[StrictBool] = None, - order_by: Optional[OrderBy] = None, - package_name: Optional[SdkPackageName] = None, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - select: Optional[List[SelectedPropertyApiName]] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListLinkedObjectsResponseV2: - """ - Lists the linked objects for a specific object and the given link type. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param link_type: linkType - :type link_type: LinkTypeApiName - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param exclude_rid: excludeRid - :type exclude_rid: Optional[StrictBool] - :param order_by: orderBy - :type order_by: Optional[OrderBy] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param select: select - :type select: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListLinkedObjectsResponseV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["artifactRepository"] = artifact_repository - - _query_params["excludeRid"] = exclude_rid - - _query_params["orderBy"] = order_by - - _query_params["packageName"] = package_name - - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _query_params["select"] = select - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _path_params["linkType"] = link_type - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListLinkedObjectsResponseV2, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/ontologies/object_type.py b/foundry/v2/_namespaces/ontologies/object_type.py deleted file mode 100644 index 08b99206..00000000 --- a/foundry/v2/_namespaces/ontologies/object_type.py +++ /dev/null @@ -1,372 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._link_type_api_name import LinkTypeApiName -from foundry.v2.models._link_type_side_v2 import LinkTypeSideV2 -from foundry.v2.models._list_object_types_v2_response import ListObjectTypesV2Response -from foundry.v2.models._list_outgoing_link_types_response_v2 import ( - ListOutgoingLinkTypesResponseV2, -) # NOQA -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._object_type_v2 import ObjectTypeV2 -from foundry.v2.models._ontology_identifier import OntologyIdentifier -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken - - -class ObjectTypeResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def get( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ObjectTypeV2: - """ - Gets a specific object type with the given API name. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ObjectTypeV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objectTypes/{objectType}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ObjectTypeV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get_outgoing_link_type( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - link_type: LinkTypeApiName, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> LinkTypeSideV2: - """ - Get an outgoing link for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param link_type: linkType - :type link_type: LinkTypeApiName - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: LinkTypeSideV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _path_params["linkType"] = link_type - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=LinkTypeSideV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - ontology: OntologyIdentifier, - *, - page_size: Optional[PageSize] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[ObjectTypeV2]: - """ - Lists the object types for the given Ontology. - - Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are - more results available, at least one result will be present in the - response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[ObjectTypeV2] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _path_params["ontology"] = ontology - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objectTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListObjectTypesV2Response, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list_outgoing_link_types( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - *, - page_size: Optional[PageSize] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[LinkTypeSideV2]: - """ - List the outgoing links for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[LinkTypeSideV2] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListOutgoingLinkTypesResponseV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - ontology: OntologyIdentifier, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListObjectTypesV2Response: - """ - Lists the object types for the given Ontology. - - Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are - more results available, at least one result will be present in the - response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListObjectTypesV2Response - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _path_params["ontology"] = ontology - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objectTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListObjectTypesV2Response, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page_outgoing_link_types( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListOutgoingLinkTypesResponseV2: - """ - List the outgoing links for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListOutgoingLinkTypesResponseV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListOutgoingLinkTypesResponseV2, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/ontologies/ontology.py b/foundry/v2/_namespaces/ontologies/ontology.py deleted file mode 100644 index fe64b563..00000000 --- a/foundry/v2/_namespaces/ontologies/ontology.py +++ /dev/null @@ -1,130 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2._namespaces.ontologies.action_type import ActionTypeResource -from foundry.v2._namespaces.ontologies.object_type import ObjectTypeResource -from foundry.v2._namespaces.ontologies.query_type import QueryTypeResource -from foundry.v2.models._ontology_full_metadata import OntologyFullMetadata -from foundry.v2.models._ontology_identifier import OntologyIdentifier -from foundry.v2.models._ontology_v2 import OntologyV2 - - -class OntologyResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - self.ActionType = ActionTypeResource(api_client=api_client) - self.ObjectType = ObjectTypeResource(api_client=api_client) - self.QueryType = QueryTypeResource(api_client=api_client) - - @validate_call - @handle_unexpected - def get( - self, - ontology: OntologyIdentifier, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> OntologyV2: - """ - Gets a specific ontology with the given Ontology RID. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: OntologyV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["ontology"] = ontology - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=OntologyV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get_full_metadata( - self, - ontology: OntologyIdentifier, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> OntologyFullMetadata: - """ - Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: OntologyFullMetadata - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["ontology"] = ontology - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/fullMetadata", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=OntologyFullMetadata, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/ontologies/ontology_interface.py b/foundry/v2/_namespaces/ontologies/ontology_interface.py deleted file mode 100644 index e4fd13af..00000000 --- a/foundry/v2/_namespaces/ontologies/ontology_interface.py +++ /dev/null @@ -1,299 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._aggregate_objects_request_v2 import AggregateObjectsRequestV2 -from foundry.v2.models._aggregate_objects_request_v2_dict import ( - AggregateObjectsRequestV2Dict, -) # NOQA -from foundry.v2.models._aggregate_objects_response_v2 import AggregateObjectsResponseV2 -from foundry.v2.models._interface_type import InterfaceType -from foundry.v2.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v2.models._list_interface_types_response import ListInterfaceTypesResponse -from foundry.v2.models._ontology_identifier import OntologyIdentifier -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._preview_mode import PreviewMode - - -class OntologyInterfaceResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def aggregate( - self, - ontology: OntologyIdentifier, - interface_type: InterfaceTypeApiName, - aggregate_objects_request_v2: Union[ - AggregateObjectsRequestV2, AggregateObjectsRequestV2Dict - ], - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> AggregateObjectsResponseV2: - """ - :::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. - ::: - - Perform functions on object fields in the specified ontology and of the specified interface type. Any - properties specified in the query must be shared property type API names defined on the interface. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param interface_type: interfaceType - :type interface_type: InterfaceTypeApiName - :param aggregate_objects_request_v2: Body of the request - :type aggregate_objects_request_v2: Union[AggregateObjectsRequestV2, AggregateObjectsRequestV2Dict] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: AggregateObjectsResponseV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = aggregate_objects_request_v2 - _query_params["preview"] = preview - - _path_params["ontology"] = ontology - - _path_params["interfaceType"] = interface_type - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[AggregateObjectsRequestV2, AggregateObjectsRequestV2Dict], - response_type=AggregateObjectsResponseV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - ontology: OntologyIdentifier, - interface_type: InterfaceTypeApiName, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> InterfaceType: - """ - :::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. - ::: - - Gets a specific object type with the given API name. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param interface_type: interfaceType - :type interface_type: InterfaceTypeApiName - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: InterfaceType - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["ontology"] = ontology - - _path_params["interfaceType"] = interface_type - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/interfaceTypes/{interfaceType}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=InterfaceType, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - ontology: OntologyIdentifier, - *, - page_size: Optional[PageSize] = None, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[InterfaceType]: - """ - :::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. - ::: - - Lists the interface types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[InterfaceType] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["preview"] = preview - - _path_params["ontology"] = ontology - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/interfaceTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListInterfaceTypesResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - ontology: OntologyIdentifier, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListInterfaceTypesResponse: - """ - :::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. - ::: - - Lists the interface types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListInterfaceTypesResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _query_params["preview"] = preview - - _path_params["ontology"] = ontology - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/interfaceTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListInterfaceTypesResponse, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/ontologies/ontology_object.py b/foundry/v2/_namespaces/ontologies/ontology_object.py deleted file mode 100644 index 51430725..00000000 --- a/foundry/v2/_namespaces/ontologies/ontology_object.py +++ /dev/null @@ -1,521 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import List -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictBool -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._aggregate_objects_request_v2 import AggregateObjectsRequestV2 -from foundry.v2.models._aggregate_objects_request_v2_dict import ( - AggregateObjectsRequestV2Dict, -) # NOQA -from foundry.v2.models._aggregate_objects_response_v2 import AggregateObjectsResponseV2 -from foundry.v2.models._artifact_repository_rid import ArtifactRepositoryRid -from foundry.v2.models._count_objects_response_v2 import CountObjectsResponseV2 -from foundry.v2.models._list_objects_response_v2 import ListObjectsResponseV2 -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._ontology_identifier import OntologyIdentifier -from foundry.v2.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v2.models._order_by import OrderBy -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._property_value_escaped_string import PropertyValueEscapedString -from foundry.v2.models._sdk_package_name import SdkPackageName -from foundry.v2.models._search_objects_request_v2 import SearchObjectsRequestV2 -from foundry.v2.models._search_objects_request_v2_dict import SearchObjectsRequestV2Dict -from foundry.v2.models._search_objects_response_v2 import SearchObjectsResponseV2 -from foundry.v2.models._selected_property_api_name import SelectedPropertyApiName - - -class OntologyObjectResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def aggregate( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - aggregate_objects_request_v2: Union[ - AggregateObjectsRequestV2, AggregateObjectsRequestV2Dict - ], - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> AggregateObjectsResponseV2: - """ - Perform functions on object fields in the specified ontology and object type. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param aggregate_objects_request_v2: Body of the request - :type aggregate_objects_request_v2: Union[AggregateObjectsRequestV2, AggregateObjectsRequestV2Dict] - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: AggregateObjectsResponseV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = aggregate_objects_request_v2 - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/aggregate", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[AggregateObjectsRequestV2, AggregateObjectsRequestV2Dict], - response_type=AggregateObjectsResponseV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def count( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> CountObjectsResponseV2: - """ - Returns a count of the objects of the given object type. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: CountObjectsResponseV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/count", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=CountObjectsResponseV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - exclude_rid: Optional[StrictBool] = None, - package_name: Optional[SdkPackageName] = None, - select: Optional[List[SelectedPropertyApiName]] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> OntologyObjectV2: - """ - Gets a specific object with the given primary key. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param exclude_rid: excludeRid - :type exclude_rid: Optional[StrictBool] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param select: select - :type select: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: OntologyObjectV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["artifactRepository"] = artifact_repository - - _query_params["excludeRid"] = exclude_rid - - _query_params["packageName"] = package_name - - _query_params["select"] = select - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=OntologyObjectV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - exclude_rid: Optional[StrictBool] = None, - order_by: Optional[OrderBy] = None, - package_name: Optional[SdkPackageName] = None, - page_size: Optional[PageSize] = None, - select: Optional[List[SelectedPropertyApiName]] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[OntologyObjectV2]: - """ - Lists the objects for the given Ontology and object type. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param exclude_rid: excludeRid - :type exclude_rid: Optional[StrictBool] - :param order_by: orderBy - :type order_by: Optional[OrderBy] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param select: select - :type select: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[OntologyObjectV2] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["artifactRepository"] = artifact_repository - - _query_params["excludeRid"] = exclude_rid - - _query_params["orderBy"] = order_by - - _query_params["packageName"] = package_name - - _query_params["pageSize"] = page_size - - _query_params["select"] = select - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListObjectsResponseV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - exclude_rid: Optional[StrictBool] = None, - order_by: Optional[OrderBy] = None, - package_name: Optional[SdkPackageName] = None, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - select: Optional[List[SelectedPropertyApiName]] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListObjectsResponseV2: - """ - Lists the objects for the given Ontology and object type. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param exclude_rid: excludeRid - :type exclude_rid: Optional[StrictBool] - :param order_by: orderBy - :type order_by: Optional[OrderBy] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param select: select - :type select: Optional[List[SelectedPropertyApiName]] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListObjectsResponseV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["artifactRepository"] = artifact_repository - - _query_params["excludeRid"] = exclude_rid - - _query_params["orderBy"] = order_by - - _query_params["packageName"] = package_name - - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _query_params["select"] = select - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListObjectsResponseV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def search( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - search_objects_request_v2: Union[SearchObjectsRequestV2, SearchObjectsRequestV2Dict], - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> SearchObjectsResponseV2: - """ - Search for objects in the specified ontology and object type. The request body is used - to filter objects based on the specified query. The supported queries are: - - | Query type | Description | Supported Types | - |-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------| - | lt | The provided property is less than the provided value. | number, string, date, timestamp | - | gt | The provided property is greater than the provided value. | number, string, date, timestamp | - | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp | - | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp | - | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp | - | isNull | The provided property is (or is not) null. | all | - | contains | The provided property contains the provided value. | array | - | not | The sub-query does not match. | N/A (applied on a query) | - | and | All the sub-queries match. | N/A (applied on queries) | - | or | At least one of the sub-queries match. | N/A (applied on queries) | - | startsWith | The provided property starts with the provided value. | string | - | containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string | - | containsAllTermsInOrder | The provided property contains the provided value as a substring. | string | - | containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string | - | containsAllTerms | The provided property contains all the terms separated by whitespace. | string | - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param search_objects_request_v2: Body of the request - :type search_objects_request_v2: Union[SearchObjectsRequestV2, SearchObjectsRequestV2Dict] - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: SearchObjectsResponseV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = search_objects_request_v2 - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/search", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[SearchObjectsRequestV2, SearchObjectsRequestV2Dict], - response_type=SearchObjectsResponseV2, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/ontologies/ontology_object_set.py b/foundry/v2/_namespaces/ontologies/ontology_object_set.py deleted file mode 100644 index 7f495814..00000000 --- a/foundry/v2/_namespaces/ontologies/ontology_object_set.py +++ /dev/null @@ -1,283 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._aggregate_object_set_request_v2 import AggregateObjectSetRequestV2 # NOQA -from foundry.v2.models._aggregate_object_set_request_v2_dict import ( - AggregateObjectSetRequestV2Dict, -) # NOQA -from foundry.v2.models._aggregate_objects_response_v2 import AggregateObjectsResponseV2 -from foundry.v2.models._artifact_repository_rid import ArtifactRepositoryRid -from foundry.v2.models._create_temporary_object_set_request_v2 import ( - CreateTemporaryObjectSetRequestV2, -) # NOQA -from foundry.v2.models._create_temporary_object_set_request_v2_dict import ( - CreateTemporaryObjectSetRequestV2Dict, -) # NOQA -from foundry.v2.models._create_temporary_object_set_response_v2 import ( - CreateTemporaryObjectSetResponseV2, -) # NOQA -from foundry.v2.models._load_object_set_request_v2 import LoadObjectSetRequestV2 -from foundry.v2.models._load_object_set_request_v2_dict import LoadObjectSetRequestV2Dict # NOQA -from foundry.v2.models._load_object_set_response_v2 import LoadObjectSetResponseV2 -from foundry.v2.models._object_set import ObjectSet -from foundry.v2.models._object_set_rid import ObjectSetRid -from foundry.v2.models._ontology_identifier import OntologyIdentifier -from foundry.v2.models._sdk_package_name import SdkPackageName - - -class OntologyObjectSetResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def aggregate( - self, - ontology: OntologyIdentifier, - aggregate_object_set_request_v2: Union[ - AggregateObjectSetRequestV2, AggregateObjectSetRequestV2Dict - ], - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> AggregateObjectsResponseV2: - """ - Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param aggregate_object_set_request_v2: Body of the request - :type aggregate_object_set_request_v2: Union[AggregateObjectSetRequestV2, AggregateObjectSetRequestV2Dict] - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: AggregateObjectsResponseV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = aggregate_object_set_request_v2 - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/objectSets/aggregate", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[AggregateObjectSetRequestV2, AggregateObjectSetRequestV2Dict], - response_type=AggregateObjectsResponseV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def create_temporary( - self, - ontology: OntologyIdentifier, - create_temporary_object_set_request_v2: Union[ - CreateTemporaryObjectSetRequestV2, CreateTemporaryObjectSetRequestV2Dict - ], - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> CreateTemporaryObjectSetResponseV2: - """ - Creates a temporary `ObjectSet` from the given definition. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read api:ontologies-write`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param create_temporary_object_set_request_v2: Body of the request - :type create_temporary_object_set_request_v2: Union[CreateTemporaryObjectSetRequestV2, CreateTemporaryObjectSetRequestV2Dict] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: CreateTemporaryObjectSetResponseV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = create_temporary_object_set_request_v2 - - _path_params["ontology"] = ontology - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/objectSets/createTemporary", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[ - CreateTemporaryObjectSetRequestV2, CreateTemporaryObjectSetRequestV2Dict - ], - response_type=CreateTemporaryObjectSetResponseV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - ontology: OntologyIdentifier, - object_set_rid: ObjectSetRid, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ObjectSet: - """ - Gets the definition of the `ObjectSet` with the given RID. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_set_rid: objectSetRid - :type object_set_rid: ObjectSetRid - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ObjectSet - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["ontology"] = ontology - - _path_params["objectSetRid"] = object_set_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objectSets/{objectSetRid}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ObjectSet, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def load( - self, - ontology: OntologyIdentifier, - load_object_set_request_v2: Union[LoadObjectSetRequestV2, LoadObjectSetRequestV2Dict], - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> LoadObjectSetResponseV2: - """ - Load the ontology objects present in the `ObjectSet` from the provided object set definition. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param load_object_set_request_v2: Body of the request - :type load_object_set_request_v2: Union[LoadObjectSetRequestV2, LoadObjectSetRequestV2Dict] - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: LoadObjectSetResponseV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = load_object_set_request_v2 - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/objectSets/loadObjects", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[LoadObjectSetRequestV2, LoadObjectSetRequestV2Dict], - response_type=LoadObjectSetResponseV2, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/ontologies/query.py b/foundry/v2/_namespaces/ontologies/query.py deleted file mode 100644 index b56e3e8e..00000000 --- a/foundry/v2/_namespaces/ontologies/query.py +++ /dev/null @@ -1,108 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._artifact_repository_rid import ArtifactRepositoryRid -from foundry.v2.models._execute_query_request import ExecuteQueryRequest -from foundry.v2.models._execute_query_request_dict import ExecuteQueryRequestDict -from foundry.v2.models._execute_query_response import ExecuteQueryResponse -from foundry.v2.models._ontology_identifier import OntologyIdentifier -from foundry.v2.models._query_api_name import QueryApiName -from foundry.v2.models._sdk_package_name import SdkPackageName - - -class QueryResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def execute( - self, - ontology: OntologyIdentifier, - query_api_name: QueryApiName, - execute_query_request: Union[ExecuteQueryRequest, ExecuteQueryRequestDict], - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ExecuteQueryResponse: - """ - Executes a Query using the given parameters. - - Optional parameters do not need to be supplied. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param query_api_name: queryApiName - :type query_api_name: QueryApiName - :param execute_query_request: Body of the request - :type execute_query_request: Union[ExecuteQueryRequest, ExecuteQueryRequestDict] - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ExecuteQueryResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = execute_query_request - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _path_params["queryApiName"] = query_api_name - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/queries/{queryApiName}/execute", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[ExecuteQueryRequest, ExecuteQueryRequestDict], - response_type=ExecuteQueryResponse, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/ontologies/query_type.py b/foundry/v2/_namespaces/ontologies/query_type.py deleted file mode 100644 index 4ffa220a..00000000 --- a/foundry/v2/_namespaces/ontologies/query_type.py +++ /dev/null @@ -1,197 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._list_query_types_response_v2 import ListQueryTypesResponseV2 -from foundry.v2.models._ontology_identifier import OntologyIdentifier -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._query_api_name import QueryApiName -from foundry.v2.models._query_type_v2 import QueryTypeV2 - - -class QueryTypeResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def get( - self, - ontology: OntologyIdentifier, - query_api_name: QueryApiName, - *, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> QueryTypeV2: - """ - Gets a specific query type with the given API name. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param query_api_name: queryApiName - :type query_api_name: QueryApiName - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: QueryTypeV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - - _path_params["ontology"] = ontology - - _path_params["queryApiName"] = query_api_name - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/queryTypes/{queryApiName}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=QueryTypeV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - ontology: OntologyIdentifier, - *, - page_size: Optional[PageSize] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[QueryTypeV2]: - """ - Lists the query types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[QueryTypeV2] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _path_params["ontology"] = ontology - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/queryTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListQueryTypesResponseV2, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - ontology: OntologyIdentifier, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListQueryTypesResponseV2: - """ - Lists the query types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListQueryTypesResponseV2 - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _path_params["ontology"] = ontology - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/queryTypes", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListQueryTypesResponseV2, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/ontologies/time_series_property_v2.py b/foundry/v2/_namespaces/ontologies/time_series_property_v2.py deleted file mode 100644 index 1dd9436a..00000000 --- a/foundry/v2/_namespaces/ontologies/time_series_property_v2.py +++ /dev/null @@ -1,262 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._artifact_repository_rid import ArtifactRepositoryRid -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._ontology_identifier import OntologyIdentifier -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value_escaped_string import PropertyValueEscapedString -from foundry.v2.models._sdk_package_name import SdkPackageName -from foundry.v2.models._stream_time_series_points_request import ( - StreamTimeSeriesPointsRequest, -) # NOQA -from foundry.v2.models._stream_time_series_points_request_dict import ( - StreamTimeSeriesPointsRequestDict, -) # NOQA -from foundry.v2.models._time_series_point import TimeSeriesPoint - - -class TimeSeriesPropertyV2Resource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def get_first_point( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - property: PropertyApiName, - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> TimeSeriesPoint: - """ - Get the first point of a time series property. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param property: property - :type property: PropertyApiName - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: TimeSeriesPoint - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _path_params["property"] = property - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=TimeSeriesPoint, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get_last_point( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - property: PropertyApiName, - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> TimeSeriesPoint: - """ - Get the last point of a time series property. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param property: property - :type property: PropertyApiName - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: TimeSeriesPoint - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _path_params["property"] = property - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=TimeSeriesPoint, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def stream_points( - self, - ontology: OntologyIdentifier, - object_type: ObjectTypeApiName, - primary_key: PropertyValueEscapedString, - property: PropertyApiName, - stream_time_series_points_request: Union[ - StreamTimeSeriesPointsRequest, StreamTimeSeriesPointsRequestDict - ], - *, - artifact_repository: Optional[ArtifactRepositoryRid] = None, - package_name: Optional[SdkPackageName] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> bytes: - """ - Stream all of the points of a time series property. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - :param ontology: ontology - :type ontology: OntologyIdentifier - :param object_type: objectType - :type object_type: ObjectTypeApiName - :param primary_key: primaryKey - :type primary_key: PropertyValueEscapedString - :param property: property - :type property: PropertyApiName - :param stream_time_series_points_request: Body of the request - :type stream_time_series_points_request: Union[StreamTimeSeriesPointsRequest, StreamTimeSeriesPointsRequestDict] - :param artifact_repository: artifactRepository - :type artifact_repository: Optional[ArtifactRepositoryRid] - :param package_name: packageName - :type package_name: Optional[SdkPackageName] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: bytes - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = stream_time_series_points_request - _query_params["artifactRepository"] = artifact_repository - - _query_params["packageName"] = package_name - - _path_params["ontology"] = ontology - - _path_params["objectType"] = object_type - - _path_params["primaryKey"] = primary_key - - _path_params["property"] = property - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "*/*" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[StreamTimeSeriesPointsRequest, StreamTimeSeriesPointsRequestDict], - response_type=bytes, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/orchestration/build.py b/foundry/v2/_namespaces/orchestration/build.py deleted file mode 100644 index adb31fc2..00000000 --- a/foundry/v2/_namespaces/orchestration/build.py +++ /dev/null @@ -1,130 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._build import Build -from foundry.v2.models._build_rid import BuildRid -from foundry.v2.models._create_builds_request import CreateBuildsRequest -from foundry.v2.models._create_builds_request_dict import CreateBuildsRequestDict -from foundry.v2.models._preview_mode import PreviewMode - - -class BuildResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def create( - self, - create_builds_request: Union[CreateBuildsRequest, CreateBuildsRequestDict], - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Build: - """ - - :param create_builds_request: Body of the request - :type create_builds_request: Union[CreateBuildsRequest, CreateBuildsRequestDict] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Build - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = create_builds_request - _query_params["preview"] = preview - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/orchestration/builds/create", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[CreateBuildsRequest, CreateBuildsRequestDict], - response_type=Build, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - build_rid: BuildRid, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Build: - """ - Get the Build with the specified rid. - :param build_rid: buildRid - :type build_rid: BuildRid - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Build - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["buildRid"] = build_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/orchestration/builds/{buildRid}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Build, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/orchestration/schedule.py b/foundry/v2/_namespaces/orchestration/schedule.py deleted file mode 100644 index 9b03ec24..00000000 --- a/foundry/v2/_namespaces/orchestration/schedule.py +++ /dev/null @@ -1,214 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._preview_mode import PreviewMode -from foundry.v2.models._schedule import Schedule -from foundry.v2.models._schedule_rid import ScheduleRid -from foundry.v2.models._schedule_run import ScheduleRun - - -class ScheduleResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def get( - self, - schedule_rid: ScheduleRid, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Schedule: - """ - Get the Schedule with the specified rid. - :param schedule_rid: scheduleRid - :type schedule_rid: ScheduleRid - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Schedule - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["scheduleRid"] = schedule_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/orchestration/schedules/{scheduleRid}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Schedule, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def pause( - self, - schedule_rid: ScheduleRid, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> None: - """ - - :param schedule_rid: scheduleRid - :type schedule_rid: ScheduleRid - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["scheduleRid"] = schedule_rid - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/orchestration/schedules/{scheduleRid}/pause", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=None, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def run( - self, - schedule_rid: ScheduleRid, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ScheduleRun: - """ - - :param schedule_rid: scheduleRid - :type schedule_rid: ScheduleRid - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ScheduleRun - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["scheduleRid"] = schedule_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/orchestration/schedules/{scheduleRid}/run", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ScheduleRun, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def unpause( - self, - schedule_rid: ScheduleRid, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> None: - """ - - :param schedule_rid: scheduleRid - :type schedule_rid: ScheduleRid - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["scheduleRid"] = schedule_rid - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/orchestration/schedules/{scheduleRid}/unpause", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=None, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/thirdpartyapplications/third_party_application.py b/foundry/v2/_namespaces/thirdpartyapplications/third_party_application.py deleted file mode 100644 index c4d9dfca..00000000 --- a/foundry/v2/_namespaces/thirdpartyapplications/third_party_application.py +++ /dev/null @@ -1,85 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2._namespaces.thirdpartyapplications.website import WebsiteResource -from foundry.v2.models._preview_mode import PreviewMode -from foundry.v2.models._third_party_application import ThirdPartyApplication -from foundry.v2.models._third_party_application_rid import ThirdPartyApplicationRid - - -class ThirdPartyApplicationResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - self.Website = WebsiteResource(api_client=api_client) - - @validate_call - @handle_unexpected - def get( - self, - third_party_application_rid: ThirdPartyApplicationRid, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ThirdPartyApplication: - """ - Get the ThirdPartyApplication with the specified rid. - :param third_party_application_rid: thirdPartyApplicationRid - :type third_party_application_rid: ThirdPartyApplicationRid - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ThirdPartyApplication - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["thirdPartyApplicationRid"] = third_party_application_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ThirdPartyApplication, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/thirdpartyapplications/version.py b/foundry/v2/_namespaces/thirdpartyapplications/version.py deleted file mode 100644 index 972abba4..00000000 --- a/foundry/v2/_namespaces/thirdpartyapplications/version.py +++ /dev/null @@ -1,304 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._core import ResourceIterator -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2.models._list_versions_response import ListVersionsResponse -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._preview_mode import PreviewMode -from foundry.v2.models._third_party_application_rid import ThirdPartyApplicationRid -from foundry.v2.models._version import Version -from foundry.v2.models._version_version import VersionVersion - - -class VersionResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - @validate_call - @handle_unexpected - def delete( - self, - third_party_application_rid: ThirdPartyApplicationRid, - version_version: VersionVersion, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> None: - """ - Delete the Version with the specified version. - :param third_party_application_rid: thirdPartyApplicationRid - :type third_party_application_rid: ThirdPartyApplicationRid - :param version_version: versionVersion - :type version_version: VersionVersion - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: None - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["thirdPartyApplicationRid"] = third_party_application_rid - - _path_params["versionVersion"] = version_version - - return self._api_client.call_api( - RequestInfo( - method="DELETE", - resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=None, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - third_party_application_rid: ThirdPartyApplicationRid, - version_version: VersionVersion, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Version: - """ - Get the Version with the specified version. - :param third_party_application_rid: thirdPartyApplicationRid - :type third_party_application_rid: ThirdPartyApplicationRid - :param version_version: versionVersion - :type version_version: VersionVersion - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Version - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["thirdPartyApplicationRid"] = third_party_application_rid - - _path_params["versionVersion"] = version_version - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion}", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Version, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def list( - self, - third_party_application_rid: ThirdPartyApplicationRid, - *, - page_size: Optional[PageSize] = None, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ResourceIterator[Version]: - """ - Lists all Versions. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param third_party_application_rid: thirdPartyApplicationRid - :type third_party_application_rid: ThirdPartyApplicationRid - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ResourceIterator[Version] - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["preview"] = preview - - _path_params["thirdPartyApplicationRid"] = third_party_application_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.iterate_api( - RequestInfo( - method="GET", - resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListVersionsResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def page( - self, - third_party_application_rid: ThirdPartyApplicationRid, - *, - page_size: Optional[PageSize] = None, - page_token: Optional[PageToken] = None, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> ListVersionsResponse: - """ - Lists all Versions. - - This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. - :param third_party_application_rid: thirdPartyApplicationRid - :type third_party_application_rid: ThirdPartyApplicationRid - :param page_size: pageSize - :type page_size: Optional[PageSize] - :param page_token: pageToken - :type page_token: Optional[PageToken] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: ListVersionsResponse - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["pageSize"] = page_size - - _query_params["pageToken"] = page_token - - _query_params["preview"] = preview - - _path_params["thirdPartyApplicationRid"] = third_party_application_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=ListVersionsResponse, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def upload( - self, - third_party_application_rid: ThirdPartyApplicationRid, - body: bytes, - *, - version: VersionVersion, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Version: - """ - Upload a new version of the Website. - :param third_party_application_rid: thirdPartyApplicationRid - :type third_party_application_rid: ThirdPartyApplicationRid - :param body: The zip file that contains the contents of your application. For more information, refer to the [documentation](/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. - :type body: bytes - :param version: version - :type version: VersionVersion - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Version - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = body - _query_params["version"] = version - - _query_params["preview"] = preview - - _path_params["thirdPartyApplicationRid"] = third_party_application_rid - - _header_params["Content-Type"] = "application/octet-stream" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/upload", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=bytes, - response_type=Version, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/_namespaces/thirdpartyapplications/website.py b/foundry/v2/_namespaces/thirdpartyapplications/website.py deleted file mode 100644 index 5d50321d..00000000 --- a/foundry/v2/_namespaces/thirdpartyapplications/website.py +++ /dev/null @@ -1,183 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Any -from typing import Dict -from typing import Optional -from typing import Union - -from pydantic import Field -from pydantic import StrictInt -from pydantic import validate_call - -from foundry._errors import handle_unexpected -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo -from foundry.v2._namespaces.thirdpartyapplications.version import VersionResource -from foundry.v2.models._deploy_website_request import DeployWebsiteRequest -from foundry.v2.models._deploy_website_request_dict import DeployWebsiteRequestDict -from foundry.v2.models._preview_mode import PreviewMode -from foundry.v2.models._third_party_application_rid import ThirdPartyApplicationRid -from foundry.v2.models._website import Website - - -class WebsiteResource: - def __init__(self, api_client: ApiClient) -> None: - self._api_client = api_client - - self.Version = VersionResource(api_client=api_client) - - @validate_call - @handle_unexpected - def deploy( - self, - third_party_application_rid: ThirdPartyApplicationRid, - deploy_website_request: Union[DeployWebsiteRequest, DeployWebsiteRequestDict], - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Website: - """ - Deploy a version of the Website. - :param third_party_application_rid: thirdPartyApplicationRid - :type third_party_application_rid: ThirdPartyApplicationRid - :param deploy_website_request: Body of the request - :type deploy_website_request: Union[DeployWebsiteRequest, DeployWebsiteRequestDict] - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Website - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = deploy_website_request - _query_params["preview"] = preview - - _path_params["thirdPartyApplicationRid"] = third_party_application_rid - - _header_params["Content-Type"] = "application/json" - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/deploy", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=Union[DeployWebsiteRequest, DeployWebsiteRequestDict], - response_type=Website, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def get( - self, - third_party_application_rid: ThirdPartyApplicationRid, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Website: - """ - Get the Website. - :param third_party_application_rid: thirdPartyApplicationRid - :type third_party_application_rid: ThirdPartyApplicationRid - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Website - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["thirdPartyApplicationRid"] = third_party_application_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="GET", - resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Website, - request_timeout=request_timeout, - ), - ) - - @validate_call - @handle_unexpected - def undeploy( - self, - third_party_application_rid: ThirdPartyApplicationRid, - *, - preview: Optional[PreviewMode] = None, - request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, - ) -> Website: - """ - Remove the currently deployed version of the Website. - :param third_party_application_rid: thirdPartyApplicationRid - :type third_party_application_rid: ThirdPartyApplicationRid - :param preview: preview - :type preview: Optional[PreviewMode] - :param request_timeout: timeout setting for this request in seconds. - :type request_timeout: Optional[int] - :return: Returns the result object. - :rtype: Website - """ - - _path_params: Dict[str, Any] = {} - _query_params: Dict[str, Any] = {} - _header_params: Dict[str, Any] = {} - _body_params: Any = None - _query_params["preview"] = preview - - _path_params["thirdPartyApplicationRid"] = third_party_application_rid - - _header_params["Accept"] = "application/json" - - return self._api_client.call_api( - RequestInfo( - method="POST", - resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/undeploy", - query_params=_query_params, - path_params=_path_params, - header_params=_header_params, - body=_body_params, - body_type=None, - response_type=Website, - request_timeout=request_timeout, - ), - ) diff --git a/foundry/v2/admin/client.py b/foundry/v2/admin/client.py new file mode 100644 index 00000000..6270e3b6 --- /dev/null +++ b/foundry/v2/admin/client.py @@ -0,0 +1,30 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry._core import Auth +from foundry.v2.admin.group import GroupClient +from foundry.v2.admin.marking import MarkingClient +from foundry.v2.admin.marking_category import MarkingCategoryClient +from foundry.v2.admin.user import UserClient + + +class AdminClient: + def __init__(self, auth: Auth, hostname: str): + self.Group = GroupClient(auth=auth, hostname=hostname) + self.Marking = MarkingClient(auth=auth, hostname=hostname) + self.MarkingCategory = MarkingCategoryClient(auth=auth, hostname=hostname) + self.User = UserClient(auth=auth, hostname=hostname) diff --git a/foundry/v2/admin/group.py b/foundry/v2/admin/group.py new file mode 100644 index 00000000..95b0459b --- /dev/null +++ b/foundry/v2/admin/group.py @@ -0,0 +1,387 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import List +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import StrictStr +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.admin.group_member import GroupMemberClient +from foundry.v2.admin.models._attribute_name import AttributeName +from foundry.v2.admin.models._attribute_values import AttributeValues +from foundry.v2.admin.models._get_groups_batch_request_element_dict import ( + GetGroupsBatchRequestElementDict, +) # NOQA +from foundry.v2.admin.models._get_groups_batch_response import GetGroupsBatchResponse +from foundry.v2.admin.models._group import Group +from foundry.v2.admin.models._group_name import GroupName +from foundry.v2.admin.models._group_search_filter_dict import GroupSearchFilterDict +from foundry.v2.admin.models._list_groups_response import ListGroupsResponse +from foundry.v2.admin.models._search_groups_response import SearchGroupsResponse +from foundry.v2.core.models._organization_rid import OrganizationRid +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.core.models._principal_id import PrincipalId + + +class GroupClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + self.GroupMember = GroupMemberClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def create( + self, + *, + attributes: Dict[AttributeName, AttributeValues], + name: GroupName, + organizations: List[OrganizationRid], + description: Optional[StrictStr] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Group: + """ + Creates a new Group. + :param attributes: A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. + :type attributes: Dict[AttributeName, AttributeValues] + :param name: The name of the Group. + :type name: GroupName + :param organizations: The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed. + :type organizations: List[OrganizationRid] + :param description: A description of the Group. + :type description: Optional[StrictStr] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Group + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/admin/groups", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "name": name, + "organizations": organizations, + "description": description, + "attributes": attributes, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "name": GroupName, + "organizations": List[OrganizationRid], + "description": Optional[StrictStr], + "attributes": Dict[AttributeName, AttributeValues], + }, + ), + response_type=Group, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def delete( + self, + group_id: PrincipalId, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + Delete the Group with the specified id. + :param group_id: groupId + :type group_id: PrincipalId + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="DELETE", + resource_path="/v2/admin/groups/{groupId}", + query_params={ + "preview": preview, + }, + path_params={ + "groupId": group_id, + }, + header_params={}, + body=None, + body_type=None, + response_type=None, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + group_id: PrincipalId, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Group: + """ + Get the Group with the specified id. + :param group_id: groupId + :type group_id: PrincipalId + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Group + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/groups/{groupId}", + query_params={ + "preview": preview, + }, + path_params={ + "groupId": group_id, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Group, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get_batch( + self, + body: List[GetGroupsBatchRequestElementDict], + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> GetGroupsBatchResponse: + """ + Execute multiple get requests on Group. + + The maximum batch size for this endpoint is 500. + :param body: Body of the request + :type body: List[GetGroupsBatchRequestElementDict] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: GetGroupsBatchResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/admin/groups/getBatch", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body=body, + body_type=List[GetGroupsBatchRequestElementDict], + response_type=GetGroupsBatchResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + *, + page_size: Optional[PageSize] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[Group]: + """ + Lists all Groups. + + This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[Group] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/groups", + query_params={ + "pageSize": page_size, + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListGroupsResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListGroupsResponse: + """ + Lists all Groups. + + This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListGroupsResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/groups", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListGroupsResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def search( + self, + *, + where: GroupSearchFilterDict, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> SearchGroupsResponse: + """ + + :param where: + :type where: GroupSearchFilterDict + :param page_size: + :type page_size: Optional[PageSize] + :param page_token: + :type page_token: Optional[PageToken] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: SearchGroupsResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/admin/groups/search", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "where": where, + "pageSize": page_size, + "pageToken": page_token, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "where": GroupSearchFilterDict, + "pageSize": Optional[PageSize], + "pageToken": Optional[PageToken], + }, + ), + response_type=SearchGroupsResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/admin/group_member.py b/foundry/v2/admin/group_member.py new file mode 100644 index 00000000..db8dc897 --- /dev/null +++ b/foundry/v2/admin/group_member.py @@ -0,0 +1,259 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import List +from typing import Optional + +from pydantic import Field +from pydantic import StrictBool +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.admin.models._group_member import GroupMember +from foundry.v2.admin.models._group_membership_expiration import GroupMembershipExpiration # NOQA +from foundry.v2.admin.models._list_group_members_response import ListGroupMembersResponse # NOQA +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.core.models._principal_id import PrincipalId + + +class GroupMemberClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def add( + self, + group_id: PrincipalId, + *, + principal_ids: List[PrincipalId], + expiration: Optional[GroupMembershipExpiration] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + + :param group_id: groupId + :type group_id: PrincipalId + :param principal_ids: + :type principal_ids: List[PrincipalId] + :param expiration: + :type expiration: Optional[GroupMembershipExpiration] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/admin/groups/{groupId}/groupMembers/add", + query_params={ + "preview": preview, + }, + path_params={ + "groupId": group_id, + }, + header_params={ + "Content-Type": "application/json", + }, + body={ + "principalIds": principal_ids, + "expiration": expiration, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "principalIds": List[PrincipalId], + "expiration": Optional[GroupMembershipExpiration], + }, + ), + response_type=None, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + group_id: PrincipalId, + *, + page_size: Optional[PageSize] = None, + preview: Optional[PreviewMode] = None, + transitive: Optional[StrictBool] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[GroupMember]: + """ + Lists all GroupMembers. + + This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + :param group_id: groupId + :type group_id: PrincipalId + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param preview: preview + :type preview: Optional[PreviewMode] + :param transitive: transitive + :type transitive: Optional[StrictBool] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[GroupMember] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/groups/{groupId}/groupMembers", + query_params={ + "pageSize": page_size, + "preview": preview, + "transitive": transitive, + }, + path_params={ + "groupId": group_id, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListGroupMembersResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + group_id: PrincipalId, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + preview: Optional[PreviewMode] = None, + transitive: Optional[StrictBool] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListGroupMembersResponse: + """ + Lists all GroupMembers. + + This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + :param group_id: groupId + :type group_id: PrincipalId + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param preview: preview + :type preview: Optional[PreviewMode] + :param transitive: transitive + :type transitive: Optional[StrictBool] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListGroupMembersResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/groups/{groupId}/groupMembers", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + "preview": preview, + "transitive": transitive, + }, + path_params={ + "groupId": group_id, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListGroupMembersResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def remove( + self, + group_id: PrincipalId, + *, + principal_ids: List[PrincipalId], + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + + :param group_id: groupId + :type group_id: PrincipalId + :param principal_ids: + :type principal_ids: List[PrincipalId] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/admin/groups/{groupId}/groupMembers/remove", + query_params={ + "preview": preview, + }, + path_params={ + "groupId": group_id, + }, + header_params={ + "Content-Type": "application/json", + }, + body={ + "principalIds": principal_ids, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "principalIds": List[PrincipalId], + }, + ), + response_type=None, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/admin/group_membership.py b/foundry/v2/admin/group_membership.py new file mode 100644 index 00000000..441a5264 --- /dev/null +++ b/foundry/v2/admin/group_membership.py @@ -0,0 +1,151 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictBool +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.admin.models._group_membership import GroupMembership +from foundry.v2.admin.models._list_group_memberships_response import ( + ListGroupMembershipsResponse, +) # NOQA +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.core.models._principal_id import PrincipalId + + +class GroupMembershipClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def list( + self, + user_id: PrincipalId, + *, + page_size: Optional[PageSize] = None, + preview: Optional[PreviewMode] = None, + transitive: Optional[StrictBool] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[GroupMembership]: + """ + Lists all GroupMemberships. + + This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + :param user_id: userId + :type user_id: PrincipalId + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param preview: preview + :type preview: Optional[PreviewMode] + :param transitive: transitive + :type transitive: Optional[StrictBool] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[GroupMembership] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/users/{userId}/groupMemberships", + query_params={ + "pageSize": page_size, + "preview": preview, + "transitive": transitive, + }, + path_params={ + "userId": user_id, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListGroupMembershipsResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + user_id: PrincipalId, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + preview: Optional[PreviewMode] = None, + transitive: Optional[StrictBool] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListGroupMembershipsResponse: + """ + Lists all GroupMemberships. + + This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + :param user_id: userId + :type user_id: PrincipalId + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param preview: preview + :type preview: Optional[PreviewMode] + :param transitive: transitive + :type transitive: Optional[StrictBool] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListGroupMembershipsResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/users/{userId}/groupMemberships", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + "preview": preview, + "transitive": transitive, + }, + path_params={ + "userId": user_id, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListGroupMembershipsResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/admin/marking.py b/foundry/v2/admin/marking.py new file mode 100644 index 00000000..dcde83c3 --- /dev/null +++ b/foundry/v2/admin/marking.py @@ -0,0 +1,167 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.admin.models._list_markings_response import ListMarkingsResponse +from foundry.v2.admin.models._marking import Marking +from foundry.v2.core.models._marking_id import MarkingId +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._preview_mode import PreviewMode + + +class MarkingClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get( + self, + marking_id: MarkingId, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Marking: + """ + Get the Marking with the specified id. + :param marking_id: markingId + :type marking_id: MarkingId + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Marking + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/markings/{markingId}", + query_params={ + "preview": preview, + }, + path_params={ + "markingId": marking_id, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Marking, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + *, + page_size: Optional[PageSize] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[Marking]: + """ + Maximum page size 100. + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[Marking] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/markings", + query_params={ + "pageSize": page_size, + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListMarkingsResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListMarkingsResponse: + """ + Maximum page size 100. + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListMarkingsResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/markings", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListMarkingsResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/admin/marking_category.py b/foundry/v2/admin/marking_category.py new file mode 100644 index 00000000..f2ecea32 --- /dev/null +++ b/foundry/v2/admin/marking_category.py @@ -0,0 +1,169 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.admin.models._list_marking_categories_response import ( + ListMarkingCategoriesResponse, +) # NOQA +from foundry.v2.admin.models._marking_category import MarkingCategory +from foundry.v2.admin.models._marking_category_id import MarkingCategoryId +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._preview_mode import PreviewMode + + +class MarkingCategoryClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get( + self, + marking_category_id: MarkingCategoryId, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> MarkingCategory: + """ + Get the MarkingCategory with the specified id. + :param marking_category_id: markingCategoryId + :type marking_category_id: MarkingCategoryId + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: MarkingCategory + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/markingCategories/{markingCategoryId}", + query_params={ + "preview": preview, + }, + path_params={ + "markingCategoryId": marking_category_id, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=MarkingCategory, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + *, + page_size: Optional[PageSize] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[MarkingCategory]: + """ + Maximum page size 100. + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[MarkingCategory] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/markingCategories", + query_params={ + "pageSize": page_size, + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListMarkingCategoriesResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListMarkingCategoriesResponse: + """ + Maximum page size 100. + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListMarkingCategoriesResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/markingCategories", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListMarkingCategoriesResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/admin/models/__init__.py b/foundry/v2/admin/models/__init__.py new file mode 100644 index 00000000..d6c623e2 --- /dev/null +++ b/foundry/v2/admin/models/__init__.py @@ -0,0 +1,138 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from foundry.v2.admin.models._attribute_name import AttributeName +from foundry.v2.admin.models._attribute_value import AttributeValue +from foundry.v2.admin.models._attribute_values import AttributeValues +from foundry.v2.admin.models._get_groups_batch_request_element_dict import ( + GetGroupsBatchRequestElementDict, +) # NOQA +from foundry.v2.admin.models._get_groups_batch_response import GetGroupsBatchResponse +from foundry.v2.admin.models._get_groups_batch_response_dict import ( + GetGroupsBatchResponseDict, +) # NOQA +from foundry.v2.admin.models._get_user_markings_response import GetUserMarkingsResponse +from foundry.v2.admin.models._get_user_markings_response_dict import ( + GetUserMarkingsResponseDict, +) # NOQA +from foundry.v2.admin.models._get_users_batch_request_element_dict import ( + GetUsersBatchRequestElementDict, +) # NOQA +from foundry.v2.admin.models._get_users_batch_response import GetUsersBatchResponse +from foundry.v2.admin.models._get_users_batch_response_dict import GetUsersBatchResponseDict # NOQA +from foundry.v2.admin.models._group import Group +from foundry.v2.admin.models._group_dict import GroupDict +from foundry.v2.admin.models._group_member import GroupMember +from foundry.v2.admin.models._group_member_dict import GroupMemberDict +from foundry.v2.admin.models._group_membership import GroupMembership +from foundry.v2.admin.models._group_membership_dict import GroupMembershipDict +from foundry.v2.admin.models._group_membership_expiration import GroupMembershipExpiration # NOQA +from foundry.v2.admin.models._group_name import GroupName +from foundry.v2.admin.models._group_search_filter_dict import GroupSearchFilterDict +from foundry.v2.admin.models._list_group_members_response import ListGroupMembersResponse # NOQA +from foundry.v2.admin.models._list_group_members_response_dict import ( + ListGroupMembersResponseDict, +) # NOQA +from foundry.v2.admin.models._list_group_memberships_response import ( + ListGroupMembershipsResponse, +) # NOQA +from foundry.v2.admin.models._list_group_memberships_response_dict import ( + ListGroupMembershipsResponseDict, +) # NOQA +from foundry.v2.admin.models._list_groups_response import ListGroupsResponse +from foundry.v2.admin.models._list_groups_response_dict import ListGroupsResponseDict +from foundry.v2.admin.models._list_marking_categories_response import ( + ListMarkingCategoriesResponse, +) # NOQA +from foundry.v2.admin.models._list_marking_categories_response_dict import ( + ListMarkingCategoriesResponseDict, +) # NOQA +from foundry.v2.admin.models._list_markings_response import ListMarkingsResponse +from foundry.v2.admin.models._list_markings_response_dict import ListMarkingsResponseDict # NOQA +from foundry.v2.admin.models._list_users_response import ListUsersResponse +from foundry.v2.admin.models._list_users_response_dict import ListUsersResponseDict +from foundry.v2.admin.models._marking import Marking +from foundry.v2.admin.models._marking_category import MarkingCategory +from foundry.v2.admin.models._marking_category_dict import MarkingCategoryDict +from foundry.v2.admin.models._marking_category_display_name import ( + MarkingCategoryDisplayName, +) # NOQA +from foundry.v2.admin.models._marking_category_id import MarkingCategoryId +from foundry.v2.admin.models._marking_category_type import MarkingCategoryType +from foundry.v2.admin.models._marking_dict import MarkingDict +from foundry.v2.admin.models._marking_display_name import MarkingDisplayName +from foundry.v2.admin.models._marking_type import MarkingType +from foundry.v2.admin.models._principal_filter_type import PrincipalFilterType +from foundry.v2.admin.models._search_groups_response import SearchGroupsResponse +from foundry.v2.admin.models._search_groups_response_dict import SearchGroupsResponseDict # NOQA +from foundry.v2.admin.models._search_users_response import SearchUsersResponse +from foundry.v2.admin.models._search_users_response_dict import SearchUsersResponseDict +from foundry.v2.admin.models._user import User +from foundry.v2.admin.models._user_dict import UserDict +from foundry.v2.admin.models._user_search_filter_dict import UserSearchFilterDict +from foundry.v2.admin.models._user_username import UserUsername + +__all__ = [ + "AttributeName", + "AttributeValue", + "AttributeValues", + "GetGroupsBatchRequestElementDict", + "GetGroupsBatchResponse", + "GetGroupsBatchResponseDict", + "GetUserMarkingsResponse", + "GetUserMarkingsResponseDict", + "GetUsersBatchRequestElementDict", + "GetUsersBatchResponse", + "GetUsersBatchResponseDict", + "Group", + "GroupDict", + "GroupMember", + "GroupMemberDict", + "GroupMembership", + "GroupMembershipDict", + "GroupMembershipExpiration", + "GroupName", + "GroupSearchFilterDict", + "ListGroupMembersResponse", + "ListGroupMembersResponseDict", + "ListGroupMembershipsResponse", + "ListGroupMembershipsResponseDict", + "ListGroupsResponse", + "ListGroupsResponseDict", + "ListMarkingCategoriesResponse", + "ListMarkingCategoriesResponseDict", + "ListMarkingsResponse", + "ListMarkingsResponseDict", + "ListUsersResponse", + "ListUsersResponseDict", + "Marking", + "MarkingCategory", + "MarkingCategoryDict", + "MarkingCategoryDisplayName", + "MarkingCategoryId", + "MarkingCategoryType", + "MarkingDict", + "MarkingDisplayName", + "MarkingType", + "PrincipalFilterType", + "SearchGroupsResponse", + "SearchGroupsResponseDict", + "SearchUsersResponse", + "SearchUsersResponseDict", + "User", + "UserDict", + "UserSearchFilterDict", + "UserUsername", +] diff --git a/foundry/v2/models/_attribute_name.py b/foundry/v2/admin/models/_attribute_name.py similarity index 100% rename from foundry/v2/models/_attribute_name.py rename to foundry/v2/admin/models/_attribute_name.py diff --git a/foundry/v2/models/_attribute_value.py b/foundry/v2/admin/models/_attribute_value.py similarity index 100% rename from foundry/v2/models/_attribute_value.py rename to foundry/v2/admin/models/_attribute_value.py diff --git a/foundry/v2/models/_attribute_values.py b/foundry/v2/admin/models/_attribute_values.py similarity index 91% rename from foundry/v2/models/_attribute_values.py rename to foundry/v2/admin/models/_attribute_values.py index 55f0d0ec..f0445c17 100644 --- a/foundry/v2/models/_attribute_values.py +++ b/foundry/v2/admin/models/_attribute_values.py @@ -17,7 +17,7 @@ from typing import List -from foundry.v2.models._attribute_value import AttributeValue +from foundry.v2.admin.models._attribute_value import AttributeValue AttributeValues = List[AttributeValue] """AttributeValues""" diff --git a/foundry/v2/models/_get_groups_batch_request_element_dict.py b/foundry/v2/admin/models/_get_groups_batch_request_element_dict.py similarity index 93% rename from foundry/v2/models/_get_groups_batch_request_element_dict.py rename to foundry/v2/admin/models/_get_groups_batch_request_element_dict.py index d8933156..43a64560 100644 --- a/foundry/v2/models/_get_groups_batch_request_element_dict.py +++ b/foundry/v2/admin/models/_get_groups_batch_request_element_dict.py @@ -17,7 +17,7 @@ from typing_extensions import TypedDict -from foundry.v2.models._principal_id import PrincipalId +from foundry.v2.core.models._principal_id import PrincipalId class GetGroupsBatchRequestElementDict(TypedDict): diff --git a/foundry/v2/models/_get_groups_batch_response.py b/foundry/v2/admin/models/_get_groups_batch_response.py similarity index 83% rename from foundry/v2/models/_get_groups_batch_response.py rename to foundry/v2/admin/models/_get_groups_batch_response.py index 6f55050a..ee3c09b0 100644 --- a/foundry/v2/models/_get_groups_batch_response.py +++ b/foundry/v2/admin/models/_get_groups_batch_response.py @@ -20,9 +20,11 @@ from pydantic import BaseModel -from foundry.v2.models._get_groups_batch_response_dict import GetGroupsBatchResponseDict -from foundry.v2.models._group import Group -from foundry.v2.models._principal_id import PrincipalId +from foundry.v2.admin.models._get_groups_batch_response_dict import ( + GetGroupsBatchResponseDict, +) # NOQA +from foundry.v2.admin.models._group import Group +from foundry.v2.core.models._principal_id import PrincipalId class GetGroupsBatchResponse(BaseModel): diff --git a/foundry/v2/models/_get_groups_batch_response_dict.py b/foundry/v2/admin/models/_get_groups_batch_response_dict.py similarity index 88% rename from foundry/v2/models/_get_groups_batch_response_dict.py rename to foundry/v2/admin/models/_get_groups_batch_response_dict.py index 721da1f8..845fc670 100644 --- a/foundry/v2/models/_get_groups_batch_response_dict.py +++ b/foundry/v2/admin/models/_get_groups_batch_response_dict.py @@ -19,8 +19,8 @@ from typing_extensions import TypedDict -from foundry.v2.models._group_dict import GroupDict -from foundry.v2.models._principal_id import PrincipalId +from foundry.v2.admin.models._group_dict import GroupDict +from foundry.v2.core.models._principal_id import PrincipalId class GetGroupsBatchResponseDict(TypedDict): diff --git a/foundry/v2/admin/models/_get_user_markings_response.py b/foundry/v2/admin/models/_get_user_markings_response.py new file mode 100644 index 00000000..d8798feb --- /dev/null +++ b/foundry/v2/admin/models/_get_user_markings_response.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.admin.models._get_user_markings_response_dict import ( + GetUserMarkingsResponseDict, +) # NOQA +from foundry.v2.core.models._marking_id import MarkingId + + +class GetUserMarkingsResponse(BaseModel): + """GetUserMarkingsResponse""" + + view: List[MarkingId] + """ + The markings that the user has access to. The user will be able to access resources protected with these + markings. This includes organization markings for organizations in which the user is a guest member. + """ + + model_config = {"extra": "allow"} + + def to_dict(self) -> GetUserMarkingsResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(GetUserMarkingsResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/admin/models/_get_user_markings_response_dict.py b/foundry/v2/admin/models/_get_user_markings_response_dict.py new file mode 100644 index 00000000..5eedf23a --- /dev/null +++ b/foundry/v2/admin/models/_get_user_markings_response_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import TypedDict + +from foundry.v2.core.models._marking_id import MarkingId + + +class GetUserMarkingsResponseDict(TypedDict): + """GetUserMarkingsResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + view: List[MarkingId] + """ + The markings that the user has access to. The user will be able to access resources protected with these + markings. This includes organization markings for organizations in which the user is a guest member. + """ diff --git a/foundry/v2/models/_get_users_batch_request_element_dict.py b/foundry/v2/admin/models/_get_users_batch_request_element_dict.py similarity index 93% rename from foundry/v2/models/_get_users_batch_request_element_dict.py rename to foundry/v2/admin/models/_get_users_batch_request_element_dict.py index f838b7b7..977385c2 100644 --- a/foundry/v2/models/_get_users_batch_request_element_dict.py +++ b/foundry/v2/admin/models/_get_users_batch_request_element_dict.py @@ -17,7 +17,7 @@ from typing_extensions import TypedDict -from foundry.v2.models._principal_id import PrincipalId +from foundry.v2.core.models._principal_id import PrincipalId class GetUsersBatchRequestElementDict(TypedDict): diff --git a/foundry/v2/models/_get_users_batch_response.py b/foundry/v2/admin/models/_get_users_batch_response.py similarity index 84% rename from foundry/v2/models/_get_users_batch_response.py rename to foundry/v2/admin/models/_get_users_batch_response.py index d50ffec5..a2a724b4 100644 --- a/foundry/v2/models/_get_users_batch_response.py +++ b/foundry/v2/admin/models/_get_users_batch_response.py @@ -20,9 +20,9 @@ from pydantic import BaseModel -from foundry.v2.models._get_users_batch_response_dict import GetUsersBatchResponseDict -from foundry.v2.models._principal_id import PrincipalId -from foundry.v2.models._user import User +from foundry.v2.admin.models._get_users_batch_response_dict import GetUsersBatchResponseDict # NOQA +from foundry.v2.admin.models._user import User +from foundry.v2.core.models._principal_id import PrincipalId class GetUsersBatchResponse(BaseModel): diff --git a/foundry/v2/models/_get_users_batch_response_dict.py b/foundry/v2/admin/models/_get_users_batch_response_dict.py similarity index 88% rename from foundry/v2/models/_get_users_batch_response_dict.py rename to foundry/v2/admin/models/_get_users_batch_response_dict.py index bbd89a8f..5924b7bc 100644 --- a/foundry/v2/models/_get_users_batch_response_dict.py +++ b/foundry/v2/admin/models/_get_users_batch_response_dict.py @@ -19,8 +19,8 @@ from typing_extensions import TypedDict -from foundry.v2.models._principal_id import PrincipalId -from foundry.v2.models._user_dict import UserDict +from foundry.v2.admin.models._user_dict import UserDict +from foundry.v2.core.models._principal_id import PrincipalId class GetUsersBatchResponseDict(TypedDict): diff --git a/foundry/v2/models/_group.py b/foundry/v2/admin/models/_group.py similarity index 79% rename from foundry/v2/models/_group.py rename to foundry/v2/admin/models/_group.py index fae6ef30..864caec2 100644 --- a/foundry/v2/models/_group.py +++ b/foundry/v2/admin/models/_group.py @@ -23,13 +23,13 @@ from pydantic import BaseModel from pydantic import StrictStr -from foundry.v2.models._attribute_name import AttributeName -from foundry.v2.models._attribute_values import AttributeValues -from foundry.v2.models._group_dict import GroupDict -from foundry.v2.models._group_name import GroupName -from foundry.v2.models._organization_rid import OrganizationRid -from foundry.v2.models._principal_id import PrincipalId -from foundry.v2.models._realm import Realm +from foundry.v2.admin.models._attribute_name import AttributeName +from foundry.v2.admin.models._attribute_values import AttributeValues +from foundry.v2.admin.models._group_dict import GroupDict +from foundry.v2.admin.models._group_name import GroupName +from foundry.v2.core.models._organization_rid import OrganizationRid +from foundry.v2.core.models._principal_id import PrincipalId +from foundry.v2.core.models._realm import Realm class Group(BaseModel): diff --git a/foundry/v2/models/_group_dict.py b/foundry/v2/admin/models/_group_dict.py similarity index 79% rename from foundry/v2/models/_group_dict.py rename to foundry/v2/admin/models/_group_dict.py index a5bb4c98..4dcf779c 100644 --- a/foundry/v2/models/_group_dict.py +++ b/foundry/v2/admin/models/_group_dict.py @@ -22,12 +22,12 @@ from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v2.models._attribute_name import AttributeName -from foundry.v2.models._attribute_values import AttributeValues -from foundry.v2.models._group_name import GroupName -from foundry.v2.models._organization_rid import OrganizationRid -from foundry.v2.models._principal_id import PrincipalId -from foundry.v2.models._realm import Realm +from foundry.v2.admin.models._attribute_name import AttributeName +from foundry.v2.admin.models._attribute_values import AttributeValues +from foundry.v2.admin.models._group_name import GroupName +from foundry.v2.core.models._organization_rid import OrganizationRid +from foundry.v2.core.models._principal_id import PrincipalId +from foundry.v2.core.models._realm import Realm class GroupDict(TypedDict): diff --git a/foundry/v2/models/_group_member.py b/foundry/v2/admin/models/_group_member.py similarity index 85% rename from foundry/v2/models/_group_member.py rename to foundry/v2/admin/models/_group_member.py index 2e9deec5..8ad2723f 100644 --- a/foundry/v2/models/_group_member.py +++ b/foundry/v2/admin/models/_group_member.py @@ -20,9 +20,9 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._group_member_dict import GroupMemberDict -from foundry.v2.models._principal_id import PrincipalId -from foundry.v2.models._principal_type import PrincipalType +from foundry.v2.admin.models._group_member_dict import GroupMemberDict +from foundry.v2.core.models._principal_id import PrincipalId +from foundry.v2.core.models._principal_type import PrincipalType class GroupMember(BaseModel): diff --git a/foundry/v2/models/_group_member_dict.py b/foundry/v2/admin/models/_group_member_dict.py similarity index 87% rename from foundry/v2/models/_group_member_dict.py rename to foundry/v2/admin/models/_group_member_dict.py index 71b87b65..3186a762 100644 --- a/foundry/v2/models/_group_member_dict.py +++ b/foundry/v2/admin/models/_group_member_dict.py @@ -17,8 +17,8 @@ from typing_extensions import TypedDict -from foundry.v2.models._principal_id import PrincipalId -from foundry.v2.models._principal_type import PrincipalType +from foundry.v2.core.models._principal_id import PrincipalId +from foundry.v2.core.models._principal_type import PrincipalType class GroupMemberDict(TypedDict): diff --git a/foundry/v2/models/_group_membership.py b/foundry/v2/admin/models/_group_membership.py similarity index 88% rename from foundry/v2/models/_group_membership.py rename to foundry/v2/admin/models/_group_membership.py index 9b98fbee..39eed82a 100644 --- a/foundry/v2/models/_group_membership.py +++ b/foundry/v2/admin/models/_group_membership.py @@ -20,8 +20,8 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._group_membership_dict import GroupMembershipDict -from foundry.v2.models._principal_id import PrincipalId +from foundry.v2.admin.models._group_membership_dict import GroupMembershipDict +from foundry.v2.core.models._principal_id import PrincipalId class GroupMembership(BaseModel): diff --git a/foundry/v2/models/_group_membership_dict.py b/foundry/v2/admin/models/_group_membership_dict.py similarity index 93% rename from foundry/v2/models/_group_membership_dict.py rename to foundry/v2/admin/models/_group_membership_dict.py index 26cf3f4c..a0de751e 100644 --- a/foundry/v2/models/_group_membership_dict.py +++ b/foundry/v2/admin/models/_group_membership_dict.py @@ -17,7 +17,7 @@ from typing_extensions import TypedDict -from foundry.v2.models._principal_id import PrincipalId +from foundry.v2.core.models._principal_id import PrincipalId class GroupMembershipDict(TypedDict): diff --git a/foundry/v2/models/_group_membership_expiration.py b/foundry/v2/admin/models/_group_membership_expiration.py similarity index 100% rename from foundry/v2/models/_group_membership_expiration.py rename to foundry/v2/admin/models/_group_membership_expiration.py diff --git a/foundry/v2/models/_group_name.py b/foundry/v2/admin/models/_group_name.py similarity index 100% rename from foundry/v2/models/_group_name.py rename to foundry/v2/admin/models/_group_name.py diff --git a/foundry/v2/models/_group_search_filter_dict.py b/foundry/v2/admin/models/_group_search_filter_dict.py similarity index 91% rename from foundry/v2/models/_group_search_filter_dict.py rename to foundry/v2/admin/models/_group_search_filter_dict.py index cb8ad371..538d1fbf 100644 --- a/foundry/v2/models/_group_search_filter_dict.py +++ b/foundry/v2/admin/models/_group_search_filter_dict.py @@ -18,7 +18,7 @@ from pydantic import StrictStr from typing_extensions import TypedDict -from foundry.v2.models._principal_filter_type import PrincipalFilterType +from foundry.v2.admin.models._principal_filter_type import PrincipalFilterType class GroupSearchFilterDict(TypedDict): diff --git a/foundry/v2/models/_list_group_members_response.py b/foundry/v2/admin/models/_list_group_members_response.py similarity index 84% rename from foundry/v2/models/_list_group_members_response.py rename to foundry/v2/admin/models/_list_group_members_response.py index 20ad3a44..0e31e505 100644 --- a/foundry/v2/models/_list_group_members_response.py +++ b/foundry/v2/admin/models/_list_group_members_response.py @@ -22,9 +22,11 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._group_member import GroupMember -from foundry.v2.models._list_group_members_response_dict import ListGroupMembersResponseDict # NOQA -from foundry.v2.models._page_token import PageToken +from foundry.v2.admin.models._group_member import GroupMember +from foundry.v2.admin.models._list_group_members_response_dict import ( + ListGroupMembersResponseDict, +) # NOQA +from foundry.v2.core.models._page_token import PageToken class ListGroupMembersResponse(BaseModel): diff --git a/foundry/v2/models/_list_group_members_response_dict.py b/foundry/v2/admin/models/_list_group_members_response_dict.py similarity index 88% rename from foundry/v2/models/_list_group_members_response_dict.py rename to foundry/v2/admin/models/_list_group_members_response_dict.py index a4928d45..4abac3bb 100644 --- a/foundry/v2/models/_list_group_members_response_dict.py +++ b/foundry/v2/admin/models/_list_group_members_response_dict.py @@ -20,8 +20,8 @@ from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v2.models._group_member_dict import GroupMemberDict -from foundry.v2.models._page_token import PageToken +from foundry.v2.admin.models._group_member_dict import GroupMemberDict +from foundry.v2.core.models._page_token import PageToken class ListGroupMembersResponseDict(TypedDict): diff --git a/foundry/v2/models/_list_group_memberships_response.py b/foundry/v2/admin/models/_list_group_memberships_response.py similarity index 86% rename from foundry/v2/models/_list_group_memberships_response.py rename to foundry/v2/admin/models/_list_group_memberships_response.py index 3c06e92a..da6bb004 100644 --- a/foundry/v2/models/_list_group_memberships_response.py +++ b/foundry/v2/admin/models/_list_group_memberships_response.py @@ -22,11 +22,11 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._group_membership import GroupMembership -from foundry.v2.models._list_group_memberships_response_dict import ( +from foundry.v2.admin.models._group_membership import GroupMembership +from foundry.v2.admin.models._list_group_memberships_response_dict import ( ListGroupMembershipsResponseDict, ) # NOQA -from foundry.v2.models._page_token import PageToken +from foundry.v2.core.models._page_token import PageToken class ListGroupMembershipsResponse(BaseModel): diff --git a/foundry/v2/models/_list_group_memberships_response_dict.py b/foundry/v2/admin/models/_list_group_memberships_response_dict.py similarity index 87% rename from foundry/v2/models/_list_group_memberships_response_dict.py rename to foundry/v2/admin/models/_list_group_memberships_response_dict.py index 4c8e3262..4a04086b 100644 --- a/foundry/v2/models/_list_group_memberships_response_dict.py +++ b/foundry/v2/admin/models/_list_group_memberships_response_dict.py @@ -20,8 +20,8 @@ from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v2.models._group_membership_dict import GroupMembershipDict -from foundry.v2.models._page_token import PageToken +from foundry.v2.admin.models._group_membership_dict import GroupMembershipDict +from foundry.v2.core.models._page_token import PageToken class ListGroupMembershipsResponseDict(TypedDict): diff --git a/foundry/v2/models/_list_groups_response.py b/foundry/v2/admin/models/_list_groups_response.py similarity index 86% rename from foundry/v2/models/_list_groups_response.py rename to foundry/v2/admin/models/_list_groups_response.py index 79fccf36..48cb3685 100644 --- a/foundry/v2/models/_list_groups_response.py +++ b/foundry/v2/admin/models/_list_groups_response.py @@ -22,9 +22,9 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._group import Group -from foundry.v2.models._list_groups_response_dict import ListGroupsResponseDict -from foundry.v2.models._page_token import PageToken +from foundry.v2.admin.models._group import Group +from foundry.v2.admin.models._list_groups_response_dict import ListGroupsResponseDict +from foundry.v2.core.models._page_token import PageToken class ListGroupsResponse(BaseModel): diff --git a/foundry/v2/models/_list_groups_response_dict.py b/foundry/v2/admin/models/_list_groups_response_dict.py similarity index 89% rename from foundry/v2/models/_list_groups_response_dict.py rename to foundry/v2/admin/models/_list_groups_response_dict.py index e9053dfc..6c8782a7 100644 --- a/foundry/v2/models/_list_groups_response_dict.py +++ b/foundry/v2/admin/models/_list_groups_response_dict.py @@ -20,8 +20,8 @@ from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v2.models._group_dict import GroupDict -from foundry.v2.models._page_token import PageToken +from foundry.v2.admin.models._group_dict import GroupDict +from foundry.v2.core.models._page_token import PageToken class ListGroupsResponseDict(TypedDict): diff --git a/foundry/v2/admin/models/_list_marking_categories_response.py b/foundry/v2/admin/models/_list_marking_categories_response.py new file mode 100644 index 00000000..2ad66d5b --- /dev/null +++ b/foundry/v2/admin/models/_list_marking_categories_response.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.admin.models._list_marking_categories_response_dict import ( + ListMarkingCategoriesResponseDict, +) # NOQA +from foundry.v2.admin.models._marking_category import MarkingCategory +from foundry.v2.core.models._page_token import PageToken + + +class ListMarkingCategoriesResponse(BaseModel): + """ListMarkingCategoriesResponse""" + + data: List[MarkingCategory] + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListMarkingCategoriesResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ListMarkingCategoriesResponseDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/admin/models/_list_marking_categories_response_dict.py b/foundry/v2/admin/models/_list_marking_categories_response_dict.py new file mode 100644 index 00000000..a10e1cfd --- /dev/null +++ b/foundry/v2/admin/models/_list_marking_categories_response_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.admin.models._marking_category_dict import MarkingCategoryDict +from foundry.v2.core.models._page_token import PageToken + + +class ListMarkingCategoriesResponseDict(TypedDict): + """ListMarkingCategoriesResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + data: List[MarkingCategoryDict] + + nextPageToken: NotRequired[PageToken] diff --git a/foundry/v2/admin/models/_list_markings_response.py b/foundry/v2/admin/models/_list_markings_response.py new file mode 100644 index 00000000..0838f9d5 --- /dev/null +++ b/foundry/v2/admin/models/_list_markings_response.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.admin.models._list_markings_response_dict import ListMarkingsResponseDict # NOQA +from foundry.v2.admin.models._marking import Marking +from foundry.v2.core.models._page_token import PageToken + + +class ListMarkingsResponse(BaseModel): + """ListMarkingsResponse""" + + data: List[Marking] + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListMarkingsResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ListMarkingsResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/admin/models/_list_markings_response_dict.py b/foundry/v2/admin/models/_list_markings_response_dict.py new file mode 100644 index 00000000..fed4e3cf --- /dev/null +++ b/foundry/v2/admin/models/_list_markings_response_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.admin.models._marking_dict import MarkingDict +from foundry.v2.core.models._page_token import PageToken + + +class ListMarkingsResponseDict(TypedDict): + """ListMarkingsResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + data: List[MarkingDict] + + nextPageToken: NotRequired[PageToken] diff --git a/foundry/v2/models/_list_users_response.py b/foundry/v2/admin/models/_list_users_response.py similarity index 86% rename from foundry/v2/models/_list_users_response.py rename to foundry/v2/admin/models/_list_users_response.py index e0c74a0e..44f77c47 100644 --- a/foundry/v2/models/_list_users_response.py +++ b/foundry/v2/admin/models/_list_users_response.py @@ -22,9 +22,9 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._list_users_response_dict import ListUsersResponseDict -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._user import User +from foundry.v2.admin.models._list_users_response_dict import ListUsersResponseDict +from foundry.v2.admin.models._user import User +from foundry.v2.core.models._page_token import PageToken class ListUsersResponse(BaseModel): diff --git a/foundry/v2/models/_list_users_response_dict.py b/foundry/v2/admin/models/_list_users_response_dict.py similarity index 89% rename from foundry/v2/models/_list_users_response_dict.py rename to foundry/v2/admin/models/_list_users_response_dict.py index 7009894d..fe4544e3 100644 --- a/foundry/v2/models/_list_users_response_dict.py +++ b/foundry/v2/admin/models/_list_users_response_dict.py @@ -20,8 +20,8 @@ from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._user_dict import UserDict +from foundry.v2.admin.models._user_dict import UserDict +from foundry.v2.core.models._page_token import PageToken class ListUsersResponseDict(TypedDict): diff --git a/foundry/v2/admin/models/_marking.py b/foundry/v2/admin/models/_marking.py new file mode 100644 index 00000000..9c76fa02 --- /dev/null +++ b/foundry/v2/admin/models/_marking.py @@ -0,0 +1,56 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.admin.models._marking_category_id import MarkingCategoryId +from foundry.v2.admin.models._marking_dict import MarkingDict +from foundry.v2.admin.models._marking_display_name import MarkingDisplayName +from foundry.v2.core.models._created_by import CreatedBy +from foundry.v2.core.models._created_time import CreatedTime +from foundry.v2.core.models._marking_id import MarkingId +from foundry.v2.core.models._organization_rid import OrganizationRid + + +class Marking(BaseModel): + """Marking""" + + id: MarkingId + + category_id: MarkingCategoryId = Field(alias="categoryId") + + display_name: MarkingDisplayName = Field(alias="displayName") + + description: Optional[StrictStr] = None + + organization_rid: Optional[OrganizationRid] = Field(alias="organizationRid", default=None) + """If this marking is associated with an Organization, its RID will be populated here.""" + + created_time: CreatedTime = Field(alias="createdTime") + + created_by: Optional[CreatedBy] = Field(alias="createdBy", default=None) + + model_config = {"extra": "allow"} + + def to_dict(self) -> MarkingDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(MarkingDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/admin/models/_marking_category.py b/foundry/v2/admin/models/_marking_category.py new file mode 100644 index 00000000..03fd1ae1 --- /dev/null +++ b/foundry/v2/admin/models/_marking_category.py @@ -0,0 +1,61 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.admin.models._marking_category_dict import MarkingCategoryDict +from foundry.v2.admin.models._marking_category_display_name import ( + MarkingCategoryDisplayName, +) # NOQA +from foundry.v2.admin.models._marking_category_id import MarkingCategoryId +from foundry.v2.admin.models._marking_category_type import MarkingCategoryType +from foundry.v2.admin.models._marking_type import MarkingType +from foundry.v2.core.models._created_by import CreatedBy +from foundry.v2.core.models._created_time import CreatedTime +from foundry.v2.core.models._marking_id import MarkingId + + +class MarkingCategory(BaseModel): + """MarkingCategory""" + + id: MarkingCategoryId + + display_name: MarkingCategoryDisplayName = Field(alias="displayName") + + description: Optional[StrictStr] = None + + category_type: MarkingCategoryType = Field(alias="categoryType") + + marking_type: MarkingType = Field(alias="markingType") + + markings: List[MarkingId] + + created_time: CreatedTime = Field(alias="createdTime") + + created_by: Optional[CreatedBy] = Field(alias="createdBy", default=None) + + model_config = {"extra": "allow"} + + def to_dict(self) -> MarkingCategoryDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(MarkingCategoryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/admin/models/_marking_category_dict.py b/foundry/v2/admin/models/_marking_category_dict.py new file mode 100644 index 00000000..7aedfa73 --- /dev/null +++ b/foundry/v2/admin/models/_marking_category_dict.py @@ -0,0 +1,54 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.admin.models._marking_category_display_name import ( + MarkingCategoryDisplayName, +) # NOQA +from foundry.v2.admin.models._marking_category_id import MarkingCategoryId +from foundry.v2.admin.models._marking_category_type import MarkingCategoryType +from foundry.v2.admin.models._marking_type import MarkingType +from foundry.v2.core.models._created_by import CreatedBy +from foundry.v2.core.models._created_time import CreatedTime +from foundry.v2.core.models._marking_id import MarkingId + + +class MarkingCategoryDict(TypedDict): + """MarkingCategory""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + id: MarkingCategoryId + + displayName: MarkingCategoryDisplayName + + description: NotRequired[StrictStr] + + categoryType: MarkingCategoryType + + markingType: MarkingType + + markings: List[MarkingId] + + createdTime: CreatedTime + + createdBy: NotRequired[CreatedBy] diff --git a/foundry/v2/admin/models/_marking_category_display_name.py b/foundry/v2/admin/models/_marking_category_display_name.py new file mode 100644 index 00000000..40099eb8 --- /dev/null +++ b/foundry/v2/admin/models/_marking_category_display_name.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr + +MarkingCategoryDisplayName = StrictStr +"""MarkingCategoryDisplayName""" diff --git a/foundry/v2/admin/models/_marking_category_id.py b/foundry/v2/admin/models/_marking_category_id.py new file mode 100644 index 00000000..336de22e --- /dev/null +++ b/foundry/v2/admin/models/_marking_category_id.py @@ -0,0 +1,24 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr + +MarkingCategoryId = StrictStr +""" +The ID of a marking category. For user-created categories, this will be a UUID. Markings associated with +Organizations are placed in a category with ID "Organization". +""" diff --git a/foundry/v2/admin/models/_marking_category_type.py b/foundry/v2/admin/models/_marking_category_type.py new file mode 100644 index 00000000..2fb986a6 --- /dev/null +++ b/foundry/v2/admin/models/_marking_category_type.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +MarkingCategoryType = Literal["CONJUNCTIVE", "DISJUNCTIVE"] +"""MarkingCategoryType""" diff --git a/foundry/v2/admin/models/_marking_dict.py b/foundry/v2/admin/models/_marking_dict.py new file mode 100644 index 00000000..bf2e97c9 --- /dev/null +++ b/foundry/v2/admin/models/_marking_dict.py @@ -0,0 +1,48 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.admin.models._marking_category_id import MarkingCategoryId +from foundry.v2.admin.models._marking_display_name import MarkingDisplayName +from foundry.v2.core.models._created_by import CreatedBy +from foundry.v2.core.models._created_time import CreatedTime +from foundry.v2.core.models._marking_id import MarkingId +from foundry.v2.core.models._organization_rid import OrganizationRid + + +class MarkingDict(TypedDict): + """Marking""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + id: MarkingId + + categoryId: MarkingCategoryId + + displayName: MarkingDisplayName + + description: NotRequired[StrictStr] + + organizationRid: NotRequired[OrganizationRid] + """If this marking is associated with an Organization, its RID will be populated here.""" + + createdTime: CreatedTime + + createdBy: NotRequired[CreatedBy] diff --git a/foundry/v2/admin/models/_marking_display_name.py b/foundry/v2/admin/models/_marking_display_name.py new file mode 100644 index 00000000..406b0530 --- /dev/null +++ b/foundry/v2/admin/models/_marking_display_name.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr + +MarkingDisplayName = StrictStr +"""MarkingDisplayName""" diff --git a/foundry/v2/admin/models/_marking_type.py b/foundry/v2/admin/models/_marking_type.py new file mode 100644 index 00000000..a8a95a48 --- /dev/null +++ b/foundry/v2/admin/models/_marking_type.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +MarkingType = Literal["MANDATORY", "CBAC"] +"""MarkingType""" diff --git a/foundry/v2/models/_principal_filter_type.py b/foundry/v2/admin/models/_principal_filter_type.py similarity index 100% rename from foundry/v2/models/_principal_filter_type.py rename to foundry/v2/admin/models/_principal_filter_type.py diff --git a/foundry/v2/models/_search_groups_response.py b/foundry/v2/admin/models/_search_groups_response.py similarity index 85% rename from foundry/v2/models/_search_groups_response.py rename to foundry/v2/admin/models/_search_groups_response.py index 92408834..7a3d56b8 100644 --- a/foundry/v2/models/_search_groups_response.py +++ b/foundry/v2/admin/models/_search_groups_response.py @@ -22,9 +22,9 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._group import Group -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._search_groups_response_dict import SearchGroupsResponseDict +from foundry.v2.admin.models._group import Group +from foundry.v2.admin.models._search_groups_response_dict import SearchGroupsResponseDict # NOQA +from foundry.v2.core.models._page_token import PageToken class SearchGroupsResponse(BaseModel): diff --git a/foundry/v2/models/_search_groups_response_dict.py b/foundry/v2/admin/models/_search_groups_response_dict.py similarity index 89% rename from foundry/v2/models/_search_groups_response_dict.py rename to foundry/v2/admin/models/_search_groups_response_dict.py index 5ee4640c..cf61cb66 100644 --- a/foundry/v2/models/_search_groups_response_dict.py +++ b/foundry/v2/admin/models/_search_groups_response_dict.py @@ -20,8 +20,8 @@ from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v2.models._group_dict import GroupDict -from foundry.v2.models._page_token import PageToken +from foundry.v2.admin.models._group_dict import GroupDict +from foundry.v2.core.models._page_token import PageToken class SearchGroupsResponseDict(TypedDict): diff --git a/foundry/v2/models/_search_users_response.py b/foundry/v2/admin/models/_search_users_response.py similarity index 86% rename from foundry/v2/models/_search_users_response.py rename to foundry/v2/admin/models/_search_users_response.py index 77918d04..b4b822bc 100644 --- a/foundry/v2/models/_search_users_response.py +++ b/foundry/v2/admin/models/_search_users_response.py @@ -22,9 +22,9 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._search_users_response_dict import SearchUsersResponseDict -from foundry.v2.models._user import User +from foundry.v2.admin.models._search_users_response_dict import SearchUsersResponseDict +from foundry.v2.admin.models._user import User +from foundry.v2.core.models._page_token import PageToken class SearchUsersResponse(BaseModel): diff --git a/foundry/v2/models/_search_users_response_dict.py b/foundry/v2/admin/models/_search_users_response_dict.py similarity index 89% rename from foundry/v2/models/_search_users_response_dict.py rename to foundry/v2/admin/models/_search_users_response_dict.py index 933198da..ddb95c0e 100644 --- a/foundry/v2/models/_search_users_response_dict.py +++ b/foundry/v2/admin/models/_search_users_response_dict.py @@ -20,8 +20,8 @@ from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._user_dict import UserDict +from foundry.v2.admin.models._user_dict import UserDict +from foundry.v2.core.models._page_token import PageToken class SearchUsersResponseDict(TypedDict): diff --git a/foundry/v2/models/_user.py b/foundry/v2/admin/models/_user.py similarity index 83% rename from foundry/v2/models/_user.py rename to foundry/v2/admin/models/_user.py index b11e7e24..7ae3bd13 100644 --- a/foundry/v2/models/_user.py +++ b/foundry/v2/admin/models/_user.py @@ -23,13 +23,13 @@ from pydantic import Field from pydantic import StrictStr -from foundry.v2.models._attribute_name import AttributeName -from foundry.v2.models._attribute_values import AttributeValues -from foundry.v2.models._organization_rid import OrganizationRid -from foundry.v2.models._principal_id import PrincipalId -from foundry.v2.models._realm import Realm -from foundry.v2.models._user_dict import UserDict -from foundry.v2.models._user_username import UserUsername +from foundry.v2.admin.models._attribute_name import AttributeName +from foundry.v2.admin.models._attribute_values import AttributeValues +from foundry.v2.admin.models._user_dict import UserDict +from foundry.v2.admin.models._user_username import UserUsername +from foundry.v2.core.models._organization_rid import OrganizationRid +from foundry.v2.core.models._principal_id import PrincipalId +from foundry.v2.core.models._realm import Realm class User(BaseModel): diff --git a/foundry/v2/models/_user_dict.py b/foundry/v2/admin/models/_user_dict.py similarity index 83% rename from foundry/v2/models/_user_dict.py rename to foundry/v2/admin/models/_user_dict.py index 7603d3bd..83ac2a71 100644 --- a/foundry/v2/models/_user_dict.py +++ b/foundry/v2/admin/models/_user_dict.py @@ -21,12 +21,12 @@ from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v2.models._attribute_name import AttributeName -from foundry.v2.models._attribute_values import AttributeValues -from foundry.v2.models._organization_rid import OrganizationRid -from foundry.v2.models._principal_id import PrincipalId -from foundry.v2.models._realm import Realm -from foundry.v2.models._user_username import UserUsername +from foundry.v2.admin.models._attribute_name import AttributeName +from foundry.v2.admin.models._attribute_values import AttributeValues +from foundry.v2.admin.models._user_username import UserUsername +from foundry.v2.core.models._organization_rid import OrganizationRid +from foundry.v2.core.models._principal_id import PrincipalId +from foundry.v2.core.models._realm import Realm class UserDict(TypedDict): diff --git a/foundry/v2/models/_user_search_filter_dict.py b/foundry/v2/admin/models/_user_search_filter_dict.py similarity index 91% rename from foundry/v2/models/_user_search_filter_dict.py rename to foundry/v2/admin/models/_user_search_filter_dict.py index 71714019..3bf103b7 100644 --- a/foundry/v2/models/_user_search_filter_dict.py +++ b/foundry/v2/admin/models/_user_search_filter_dict.py @@ -18,7 +18,7 @@ from pydantic import StrictStr from typing_extensions import TypedDict -from foundry.v2.models._principal_filter_type import PrincipalFilterType +from foundry.v2.admin.models._principal_filter_type import PrincipalFilterType class UserSearchFilterDict(TypedDict): diff --git a/foundry/v2/models/_user_username.py b/foundry/v2/admin/models/_user_username.py similarity index 100% rename from foundry/v2/models/_user_username.py rename to foundry/v2/admin/models/_user_username.py diff --git a/foundry/v2/admin/user.py b/foundry/v2/admin/user.py new file mode 100644 index 00000000..7e5e01e8 --- /dev/null +++ b/foundry/v2/admin/user.py @@ -0,0 +1,439 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import List +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.admin.group_membership import GroupMembershipClient +from foundry.v2.admin.models._get_user_markings_response import GetUserMarkingsResponse +from foundry.v2.admin.models._get_users_batch_request_element_dict import ( + GetUsersBatchRequestElementDict, +) # NOQA +from foundry.v2.admin.models._get_users_batch_response import GetUsersBatchResponse +from foundry.v2.admin.models._list_users_response import ListUsersResponse +from foundry.v2.admin.models._search_users_response import SearchUsersResponse +from foundry.v2.admin.models._user import User +from foundry.v2.admin.models._user_search_filter_dict import UserSearchFilterDict +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.core.models._principal_id import PrincipalId + + +class UserClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + self.GroupMembership = GroupMembershipClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def delete( + self, + user_id: PrincipalId, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + Delete the User with the specified id. + :param user_id: userId + :type user_id: PrincipalId + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="DELETE", + resource_path="/v2/admin/users/{userId}", + query_params={ + "preview": preview, + }, + path_params={ + "userId": user_id, + }, + header_params={}, + body=None, + body_type=None, + response_type=None, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + user_id: PrincipalId, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> User: + """ + Get the User with the specified id. + :param user_id: userId + :type user_id: PrincipalId + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: User + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/users/{userId}", + query_params={ + "preview": preview, + }, + path_params={ + "userId": user_id, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=User, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get_batch( + self, + body: List[GetUsersBatchRequestElementDict], + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> GetUsersBatchResponse: + """ + Execute multiple get requests on User. + + The maximum batch size for this endpoint is 500. + :param body: Body of the request + :type body: List[GetUsersBatchRequestElementDict] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: GetUsersBatchResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/admin/users/getBatch", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body=body, + body_type=List[GetUsersBatchRequestElementDict], + response_type=GetUsersBatchResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get_current( + self, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> User: + """ + + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: User + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/users/getCurrent", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=User, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get_markings( + self, + user_id: PrincipalId, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> GetUserMarkingsResponse: + """ + Retrieve Markings that the user is currently a member of. + :param user_id: userId + :type user_id: PrincipalId + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: GetUserMarkingsResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/users/{userId}/getMarkings", + query_params={ + "preview": preview, + }, + path_params={ + "userId": user_id, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=GetUserMarkingsResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + *, + page_size: Optional[PageSize] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[User]: + """ + Lists all Users. + + This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[User] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/users", + query_params={ + "pageSize": page_size, + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListUsersResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListUsersResponse: + """ + Lists all Users. + + This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListUsersResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/users", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListUsersResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def profile_picture( + self, + user_id: PrincipalId, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> bytes: + """ + + :param user_id: userId + :type user_id: PrincipalId + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: bytes + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/admin/users/{userId}/profilePicture", + query_params={ + "preview": preview, + }, + path_params={ + "userId": user_id, + }, + header_params={ + "Accept": "application/octet-stream", + }, + body=None, + body_type=None, + response_type=bytes, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def search( + self, + *, + where: UserSearchFilterDict, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> SearchUsersResponse: + """ + + :param where: + :type where: UserSearchFilterDict + :param page_size: + :type page_size: Optional[PageSize] + :param page_token: + :type page_token: Optional[PageToken] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: SearchUsersResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/admin/users/search", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "where": where, + "pageSize": page_size, + "pageToken": page_token, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "where": UserSearchFilterDict, + "pageSize": Optional[PageSize], + "pageToken": Optional[PageToken], + }, + ), + response_type=SearchUsersResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/cli.py b/foundry/v2/cli.py index 8ba7b9c5..b003385e 100644 --- a/foundry/v2/cli.py +++ b/foundry/v2/cli.py @@ -19,18 +19,18 @@ import io import json import os +from datetime import datetime from typing import Literal from typing import Optional import click import foundry.v2 -import foundry.v2.models @dataclasses.dataclass class _Context: - obj: foundry.v2.FoundryV2Client + obj: foundry.v2.FoundryClient def get_from_environ(key: str) -> str: @@ -41,11 +41,11 @@ def get_from_environ(key: str) -> str: return value -@click.group() +@click.group() # type: ignore @click.pass_context # type: ignore def cli(ctx: _Context): "An experimental CLI for the Foundry API" - ctx.obj = foundry.v2.FoundryV2Client( + ctx.obj = foundry.v2.FoundryClient( auth=foundry.UserTokenAuth( hostname=get_from_environ("FOUNDRY_HOSTNAME"), token=get_from_environ("FOUNDRY_TOKEN"), @@ -69,7 +69,7 @@ def admin_user(): @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_user_delete( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, user_id: str, preview: Optional[bool], ): @@ -88,7 +88,7 @@ def admin_user_delete( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_user_get( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, user_id: str, preview: Optional[bool], ): @@ -107,7 +107,7 @@ def admin_user_get( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_user_get_batch( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, body: str, preview: Optional[bool], ): @@ -127,7 +127,7 @@ def admin_user_get_batch( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_user_get_current( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, preview: Optional[bool], ): """ """ @@ -137,12 +137,31 @@ def admin_user_get_current( click.echo(repr(result)) +@admin_user.command("get_markings") +@click.argument("user_id", type=str, required=True) +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def admin_user_get_markings( + client: foundry.v2.FoundryClient, + user_id: str, + preview: Optional[bool], +): + """ + Retrieve Markings that the user is currently a member of. + """ + result = client.admin.User.get_markings( + user_id=user_id, + preview=preview, + ) + click.echo(repr(result)) + + @admin_user.command("list") @click.option("--page_size", type=int, required=False, help="""pageSize""") @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_user_list( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, page_size: Optional[int], preview: Optional[bool], ): @@ -164,7 +183,7 @@ def admin_user_list( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_user_page( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, page_size: Optional[int], page_token: Optional[str], preview: Optional[bool], @@ -187,7 +206,7 @@ def admin_user_page( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_user_profile_picture( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, user_id: str, preview: Optional[bool], ): @@ -206,7 +225,7 @@ def admin_user_profile_picture( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_user_search( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, where: str, page_size: Optional[int], page_token: Optional[str], @@ -214,13 +233,9 @@ def admin_user_search( ): """ """ result = client.admin.User.search( - search_users_request=foundry.v2.models.SearchUsersRequest.model_validate( - { - "where": where, - "pageSize": page_size, - "pageToken": page_token, - } - ), + where=json.loads(where), + page_size=page_size, + page_token=page_token, preview=preview, ) click.echo(repr(result)) @@ -238,7 +253,7 @@ def admin_user_group_membership(): @click.option("--transitive", type=bool, required=False, help="""transitive""") @click.pass_obj def admin_user_group_membership_list( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, user_id: str, page_size: Optional[int], preview: Optional[bool], @@ -266,7 +281,7 @@ def admin_user_group_membership_list( @click.option("--transitive", type=bool, required=False, help="""transitive""") @click.pass_obj def admin_user_group_membership_page( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, user_id: str, page_size: Optional[int], page_token: Optional[str], @@ -288,12 +303,148 @@ def admin_user_group_membership_page( click.echo(repr(result)) +@admin.group("marking_category") +def admin_marking_category(): + pass + + +@admin_marking_category.command("get") +@click.argument("marking_category_id", type=str, required=True) +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def admin_marking_category_get( + client: foundry.v2.FoundryClient, + marking_category_id: str, + preview: Optional[bool], +): + """ + Get the MarkingCategory with the specified id. + """ + result = client.admin.MarkingCategory.get( + marking_category_id=marking_category_id, + preview=preview, + ) + click.echo(repr(result)) + + +@admin_marking_category.command("list") +@click.option("--page_size", type=int, required=False, help="""pageSize""") +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def admin_marking_category_list( + client: foundry.v2.FoundryClient, + page_size: Optional[int], + preview: Optional[bool], +): + """ + Maximum page size 100. + """ + result = client.admin.MarkingCategory.list( + page_size=page_size, + preview=preview, + ) + click.echo(repr(result)) + + +@admin_marking_category.command("page") +@click.option("--page_size", type=int, required=False, help="""pageSize""") +@click.option("--page_token", type=str, required=False, help="""pageToken""") +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def admin_marking_category_page( + client: foundry.v2.FoundryClient, + page_size: Optional[int], + page_token: Optional[str], + preview: Optional[bool], +): + """ + Maximum page size 100. + """ + result = client.admin.MarkingCategory.page( + page_size=page_size, + page_token=page_token, + preview=preview, + ) + click.echo(repr(result)) + + +@admin.group("marking") +def admin_marking(): + pass + + +@admin_marking.command("get") +@click.argument("marking_id", type=str, required=True) +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def admin_marking_get( + client: foundry.v2.FoundryClient, + marking_id: str, + preview: Optional[bool], +): + """ + Get the Marking with the specified id. + """ + result = client.admin.Marking.get( + marking_id=marking_id, + preview=preview, + ) + click.echo(repr(result)) + + +@admin_marking.command("list") +@click.option("--page_size", type=int, required=False, help="""pageSize""") +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def admin_marking_list( + client: foundry.v2.FoundryClient, + page_size: Optional[int], + preview: Optional[bool], +): + """ + Maximum page size 100. + """ + result = client.admin.Marking.list( + page_size=page_size, + preview=preview, + ) + click.echo(repr(result)) + + +@admin_marking.command("page") +@click.option("--page_size", type=int, required=False, help="""pageSize""") +@click.option("--page_token", type=str, required=False, help="""pageToken""") +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def admin_marking_page( + client: foundry.v2.FoundryClient, + page_size: Optional[int], + page_token: Optional[str], + preview: Optional[bool], +): + """ + Maximum page size 100. + """ + result = client.admin.Marking.page( + page_size=page_size, + page_token=page_token, + preview=preview, + ) + click.echo(repr(result)) + + @admin.group("group") def admin_group(): pass @admin_group.command("create") +@click.option( + "--attributes", + type=str, + required=True, + help="""A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change.""", +) @click.option("--name", type=str, required=True, help="""The name of the Group.""") @click.option( "--organizations", @@ -303,34 +454,24 @@ def admin_group(): """, ) @click.option("--description", type=str, required=False, help="""A description of the Group.""") -@click.option( - "--attributes", - type=str, - required=True, - help="""A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change.""", -) @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_group_create( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, + attributes: str, name: str, organizations: str, description: Optional[str], - attributes: str, preview: Optional[bool], ): """ Creates a new Group. """ result = client.admin.Group.create( - create_group_request=foundry.v2.models.CreateGroupRequest.model_validate( - { - "name": name, - "organizations": organizations, - "description": description, - "attributes": attributes, - } - ), + attributes=json.loads(attributes), + name=name, + organizations=json.loads(organizations), + description=description, preview=preview, ) click.echo(repr(result)) @@ -341,7 +482,7 @@ def admin_group_create( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_group_delete( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, group_id: str, preview: Optional[bool], ): @@ -360,7 +501,7 @@ def admin_group_delete( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_group_get( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, group_id: str, preview: Optional[bool], ): @@ -379,7 +520,7 @@ def admin_group_get( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_group_get_batch( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, body: str, preview: Optional[bool], ): @@ -400,7 +541,7 @@ def admin_group_get_batch( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_group_list( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, page_size: Optional[int], preview: Optional[bool], ): @@ -422,7 +563,7 @@ def admin_group_list( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_group_page( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, page_size: Optional[int], page_token: Optional[str], preview: Optional[bool], @@ -447,7 +588,7 @@ def admin_group_page( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_group_search( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, where: str, page_size: Optional[int], page_token: Optional[str], @@ -455,13 +596,9 @@ def admin_group_search( ): """ """ result = client.admin.Group.search( - search_groups_request=foundry.v2.models.SearchGroupsRequest.model_validate( - { - "where": where, - "pageSize": page_size, - "pageToken": page_token, - } - ), + where=json.loads(where), + page_size=page_size, + page_token=page_token, preview=preview, ) click.echo(repr(result)) @@ -475,25 +612,21 @@ def admin_group_group_member(): @admin_group_group_member.command("add") @click.argument("group_id", type=str, required=True) @click.option("--principal_ids", type=str, required=True, help="""""") -@click.option("--expiration", type=str, required=False, help="""""") +@click.option("--expiration", type=click.DateTime(), required=False, help="""""") @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_group_group_member_add( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, group_id: str, principal_ids: str, - expiration: Optional[str], + expiration: Optional[datetime], preview: Optional[bool], ): """ """ result = client.admin.Group.GroupMember.add( group_id=group_id, - add_group_members_request=foundry.v2.models.AddGroupMembersRequest.model_validate( - { - "principalIds": principal_ids, - "expiration": expiration, - } - ), + principal_ids=json.loads(principal_ids), + expiration=expiration, preview=preview, ) click.echo(repr(result)) @@ -506,7 +639,7 @@ def admin_group_group_member_add( @click.option("--transitive", type=bool, required=False, help="""transitive""") @click.pass_obj def admin_group_group_member_list( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, group_id: str, page_size: Optional[int], preview: Optional[bool], @@ -534,7 +667,7 @@ def admin_group_group_member_list( @click.option("--transitive", type=bool, required=False, help="""transitive""") @click.pass_obj def admin_group_group_member_page( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, group_id: str, page_size: Optional[int], page_token: Optional[str], @@ -562,7 +695,7 @@ def admin_group_group_member_page( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def admin_group_group_member_remove( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, group_id: str, principal_ids: str, preview: Optional[bool], @@ -570,16 +703,17 @@ def admin_group_group_member_remove( """ """ result = client.admin.Group.GroupMember.remove( group_id=group_id, - remove_group_members_request=foundry.v2.models.RemoveGroupMembersRequest.model_validate( - { - "principalIds": principal_ids, - } - ), + principal_ids=json.loads(principal_ids), preview=preview, ) click.echo(repr(result)) +@cli.group("core") +def core(): + pass + + @cli.group("datasets") def datasets(): pass @@ -591,14 +725,14 @@ def datasets_dataset(): @datasets_dataset.command("create") -@click.option("--parent_folder_rid", type=str, required=True, help="""""") @click.option("--name", type=str, required=True, help="""""") +@click.option("--parent_folder_rid", type=str, required=True, help="""""") @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def datasets_dataset_create( - client: foundry.v2.FoundryV2Client, - parent_folder_rid: str, + client: foundry.v2.FoundryClient, name: str, + parent_folder_rid: str, preview: Optional[bool], ): """ @@ -606,12 +740,8 @@ def datasets_dataset_create( """ result = client.datasets.Dataset.create( - create_dataset_request=foundry.v2.models.CreateDatasetRequest.model_validate( - { - "parentFolderRid": parent_folder_rid, - "name": name, - } - ), + name=name, + parent_folder_rid=parent_folder_rid, preview=preview, ) click.echo(repr(result)) @@ -622,7 +752,7 @@ def datasets_dataset_create( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def datasets_dataset_get( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, preview: Optional[bool], ): @@ -647,7 +777,7 @@ def datasets_dataset_get( @click.option("--start_transaction_rid", type=str, required=False, help="""startTransactionRid""") @click.pass_obj def datasets_dataset_read_table( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, format: Literal["ARROW", "CSV"], branch_name: Optional[str], @@ -690,7 +820,7 @@ def datasets_dataset_file(): @click.option("--start_transaction_rid", type=str, required=False, help="""startTransactionRid""") @click.pass_obj def datasets_dataset_file_content( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, file_path: str, branch_name: Optional[str], @@ -737,7 +867,7 @@ def datasets_dataset_file_content( @click.option("--transaction_rid", type=str, required=False, help="""transactionRid""") @click.pass_obj def datasets_dataset_file_delete( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, file_path: str, branch_name: Optional[str], @@ -776,7 +906,7 @@ def datasets_dataset_file_delete( @click.option("--start_transaction_rid", type=str, required=False, help="""startTransactionRid""") @click.pass_obj def datasets_dataset_file_get( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, file_path: str, branch_name: Optional[str], @@ -823,7 +953,7 @@ def datasets_dataset_file_get( @click.option("--start_transaction_rid", type=str, required=False, help="""startTransactionRid""") @click.pass_obj def datasets_dataset_file_list( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, branch_name: Optional[str], end_transaction_rid: Optional[str], @@ -873,7 +1003,7 @@ def datasets_dataset_file_list( @click.option("--start_transaction_rid", type=str, required=False, help="""startTransactionRid""") @click.pass_obj def datasets_dataset_file_page( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, branch_name: Optional[str], end_transaction_rid: Optional[str], @@ -930,7 +1060,7 @@ def datasets_dataset_file_page( ) @click.pass_obj def datasets_dataset_file_upload( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, file_path: str, body: io.BufferedReader, @@ -978,7 +1108,7 @@ def datasets_dataset_transaction(): @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def datasets_dataset_transaction_abort( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, transaction_rid: str, preview: Optional[bool], @@ -1002,7 +1132,7 @@ def datasets_dataset_transaction_abort( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def datasets_dataset_transaction_commit( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, transaction_rid: str, preview: Optional[bool], @@ -1032,7 +1162,7 @@ def datasets_dataset_transaction_commit( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def datasets_dataset_transaction_create( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, transaction_type: Literal["APPEND", "UPDATE", "SNAPSHOT", "DELETE"], branch_name: Optional[str], @@ -1044,11 +1174,7 @@ def datasets_dataset_transaction_create( """ result = client.datasets.Dataset.Transaction.create( dataset_rid=dataset_rid, - create_transaction_request=foundry.v2.models.CreateTransactionRequest.model_validate( - { - "transactionType": transaction_type, - } - ), + transaction_type=transaction_type, branch_name=branch_name, preview=preview, ) @@ -1061,7 +1187,7 @@ def datasets_dataset_transaction_create( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def datasets_dataset_transaction_get( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, transaction_rid: str, preview: Optional[bool], @@ -1085,16 +1211,16 @@ def datasets_dataset_branch(): @datasets_dataset_branch.command("create") @click.argument("dataset_rid", type=str, required=True) -@click.option("--transaction_rid", type=str, required=False, help="""""") @click.option("--name", type=str, required=True, help="""""") @click.option("--preview", type=bool, required=False, help="""preview""") +@click.option("--transaction_rid", type=str, required=False, help="""""") @click.pass_obj def datasets_dataset_branch_create( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, - transaction_rid: Optional[str], name: str, preview: Optional[bool], + transaction_rid: Optional[str], ): """ Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. @@ -1102,13 +1228,9 @@ def datasets_dataset_branch_create( """ result = client.datasets.Dataset.Branch.create( dataset_rid=dataset_rid, - create_branch_request=foundry.v2.models.CreateBranchRequest.model_validate( - { - "transactionRid": transaction_rid, - "name": name, - } - ), + name=name, preview=preview, + transaction_rid=transaction_rid, ) click.echo(repr(result)) @@ -1119,7 +1241,7 @@ def datasets_dataset_branch_create( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def datasets_dataset_branch_delete( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, branch_name: str, preview: Optional[bool], @@ -1142,7 +1264,7 @@ def datasets_dataset_branch_delete( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def datasets_dataset_branch_get( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, branch_name: str, preview: Optional[bool], @@ -1165,7 +1287,7 @@ def datasets_dataset_branch_get( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def datasets_dataset_branch_list( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, page_size: Optional[int], preview: Optional[bool], @@ -1189,7 +1311,7 @@ def datasets_dataset_branch_list( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def datasets_dataset_branch_page( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, dataset_rid: str, page_size: Optional[int], page_token: Optional[str], @@ -1208,17 +1330,32 @@ def datasets_dataset_branch_page( click.echo(repr(result)) +@cli.group("filesystem") +def filesystem(): + pass + + +@cli.group("geo") +def geo(): + pass + + @cli.group("ontologies") def ontologies(): pass -@ontologies.group("time_series_property_v2") -def ontologies_time_series_property_v2(): +@cli.group("ontologies_v2") +def ontologies_v2(): + pass + + +@ontologies_v2.group("time_series_property_v2") +def ontologies_v2_time_series_property_v2(): pass -@ontologies_time_series_property_v2.command("get_first_point") +@ontologies_v2_time_series_property_v2.command("get_first_point") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.argument("primary_key", type=str, required=True) @@ -1226,8 +1363,8 @@ def ontologies_time_series_property_v2(): @click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") @click.option("--package_name", type=str, required=False, help="""packageName""") @click.pass_obj -def ontologies_time_series_property_v2_get_first_point( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_time_series_property_v2_get_first_point( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -1253,7 +1390,7 @@ def ontologies_time_series_property_v2_get_first_point( click.echo(repr(result)) -@ontologies_time_series_property_v2.command("get_last_point") +@ontologies_v2_time_series_property_v2.command("get_last_point") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.argument("primary_key", type=str, required=True) @@ -1261,8 +1398,8 @@ def ontologies_time_series_property_v2_get_first_point( @click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") @click.option("--package_name", type=str, required=False, help="""packageName""") @click.pass_obj -def ontologies_time_series_property_v2_get_last_point( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_time_series_property_v2_get_last_point( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -1288,24 +1425,24 @@ def ontologies_time_series_property_v2_get_last_point( click.echo(repr(result)) -@ontologies_time_series_property_v2.command("stream_points") +@ontologies_v2_time_series_property_v2.command("stream_points") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.argument("primary_key", type=str, required=True) @click.argument("property", type=str, required=True) -@click.option("--range", type=str, required=False, help="""""") @click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") @click.option("--package_name", type=str, required=False, help="""packageName""") +@click.option("--range", type=str, required=False, help="""""") @click.pass_obj -def ontologies_time_series_property_v2_stream_points( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_time_series_property_v2_stream_points( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, property: str, - range: Optional[str], artifact_repository: Optional[str], package_name: Optional[str], + range: Optional[str], ): """ Stream all of the points of a time series property. @@ -1319,31 +1456,27 @@ def ontologies_time_series_property_v2_stream_points( object_type=object_type, primary_key=primary_key, property=property, - stream_time_series_points_request=foundry.v2.models.StreamTimeSeriesPointsRequest.model_validate( - { - "range": range, - } - ), artifact_repository=artifact_repository, package_name=package_name, + range=None if range is None else json.loads(range), ) click.echo(result) -@ontologies.group("query") -def ontologies_query(): +@ontologies_v2.group("query") +def ontologies_v2_query(): pass -@ontologies_query.command("execute") +@ontologies_v2_query.command("execute") @click.argument("ontology", type=str, required=True) @click.argument("query_api_name", type=str, required=True) @click.option("--parameters", type=str, required=True, help="""""") @click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") @click.option("--package_name", type=str, required=False, help="""packageName""") @click.pass_obj -def ontologies_query_execute( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_query_execute( + client: foundry.v2.FoundryClient, ontology: str, query_api_name: str, parameters: str, @@ -1362,186 +1495,386 @@ def ontologies_query_execute( result = client.ontologies.Query.execute( ontology=ontology, query_api_name=query_api_name, - execute_query_request=foundry.v2.models.ExecuteQueryRequest.model_validate( - { - "parameters": parameters, - } - ), + parameters=json.loads(parameters), artifact_repository=artifact_repository, package_name=package_name, ) click.echo(repr(result)) -@ontologies.group("ontology_object_set") -def ontologies_ontology_object_set(): +@ontologies_v2.group("ontology_v2") +def ontologies_v2_ontology_v2(): pass -@ontologies_ontology_object_set.command("aggregate") +@ontologies_v2_ontology_v2.command("get") @click.argument("ontology", type=str, required=True) -@click.option("--aggregation", type=str, required=True, help="""""") -@click.option("--object_set", type=str, required=True, help="""""") -@click.option("--group_by", type=str, required=True, help="""""") -@click.option( - "--accuracy", - type=click.Choice(["REQUIRE_ACCURATE", "ALLOW_APPROXIMATE"]), - required=False, - help="""""", -) -@click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") -@click.option("--package_name", type=str, required=False, help="""packageName""") @click.pass_obj -def ontologies_ontology_object_set_aggregate( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_v2_get( + client: foundry.v2.FoundryClient, ontology: str, - aggregation: str, - object_set: str, - group_by: str, - accuracy: Optional[Literal["REQUIRE_ACCURATE", "ALLOW_APPROXIMATE"]], - artifact_repository: Optional[str], - package_name: Optional[str], ): """ - Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition. + Gets a specific ontology with the given Ontology RID. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. """ - result = client.ontologies.OntologyObjectSet.aggregate( + result = client.ontologies.Ontology.get( ontology=ontology, - aggregate_object_set_request_v2=foundry.v2.models.AggregateObjectSetRequestV2.model_validate( - { - "aggregation": aggregation, - "objectSet": object_set, - "groupBy": group_by, - "accuracy": accuracy, - } - ), - artifact_repository=artifact_repository, - package_name=package_name, ) click.echo(repr(result)) -@ontologies_ontology_object_set.command("create_temporary") +@ontologies_v2_ontology_v2.command("get_full_metadata") @click.argument("ontology", type=str, required=True) -@click.option("--object_set", type=str, required=True, help="""""") @click.pass_obj -def ontologies_ontology_object_set_create_temporary( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_v2_get_full_metadata( + client: foundry.v2.FoundryClient, ontology: str, - object_set: str, ): """ - Creates a temporary `ObjectSet` from the given definition. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read api:ontologies-write`. + Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces. """ - result = client.ontologies.OntologyObjectSet.create_temporary( + result = client.ontologies.Ontology.get_full_metadata( ontology=ontology, - create_temporary_object_set_request_v2=foundry.v2.models.CreateTemporaryObjectSetRequestV2.model_validate( - { - "objectSet": object_set, - } - ), ) click.echo(repr(result)) -@ontologies_ontology_object_set.command("get") +@ontologies_v2_ontology_v2.group("query_type") +def ontologies_v2_ontology_v2_query_type(): + pass + + +@ontologies_v2_ontology_v2_query_type.command("get") @click.argument("ontology", type=str, required=True) -@click.argument("object_set_rid", type=str, required=True) +@click.argument("query_api_name", type=str, required=True) @click.pass_obj -def ontologies_ontology_object_set_get( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_v2_query_type_get( + client: foundry.v2.FoundryClient, ontology: str, - object_set_rid: str, + query_api_name: str, ): """ - Gets the definition of the `ObjectSet` with the given RID. + Gets a specific query type with the given API name. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. """ - result = client.ontologies.OntologyObjectSet.get( + result = client.ontologies.Ontology.QueryType.get( ontology=ontology, - object_set_rid=object_set_rid, + query_api_name=query_api_name, ) click.echo(repr(result)) -@ontologies_ontology_object_set.command("load") +@ontologies_v2_ontology_v2_query_type.command("list") @click.argument("ontology", type=str, required=True) -@click.option("--object_set", type=str, required=True, help="""""") -@click.option("--order_by", type=str, required=False, help="""""") -@click.option("--select", type=str, required=True, help="""""") -@click.option("--page_token", type=str, required=False, help="""""") -@click.option("--page_size", type=int, required=False, help="""""") -@click.option( - "--exclude_rid", - type=bool, - required=False, - help="""A flag to exclude the retrieval of the `__rid` property. -Setting this to true may improve performance of this endpoint for object types in OSV2. -""", -) -@click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") -@click.option("--package_name", type=str, required=False, help="""packageName""") +@click.option("--page_size", type=int, required=False, help="""pageSize""") @click.pass_obj -def ontologies_ontology_object_set_load( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_v2_query_type_list( + client: foundry.v2.FoundryClient, ontology: str, - object_set: str, - order_by: Optional[str], - select: str, - page_token: Optional[str], page_size: Optional[int], - exclude_rid: Optional[bool], - artifact_repository: Optional[str], - package_name: Optional[str], ): """ - Load the ontology objects present in the `ObjectSet` from the provided object set definition. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + Lists the query types for the given Ontology. - Note that null value properties will not be returned. + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. """ - result = client.ontologies.OntologyObjectSet.load( + result = client.ontologies.Ontology.QueryType.list( ontology=ontology, - load_object_set_request_v2=foundry.v2.models.LoadObjectSetRequestV2.model_validate( - { - "objectSet": object_set, - "orderBy": order_by, - "select": select, - "pageToken": page_token, - "pageSize": page_size, - "excludeRid": exclude_rid, - } - ), - artifact_repository=artifact_repository, - package_name=package_name, + page_size=page_size, ) click.echo(repr(result)) -@ontologies.group("ontology_object") -def ontologies_ontology_object(): - pass +@ontologies_v2_ontology_v2_query_type.command("page") +@click.argument("ontology", type=str, required=True) +@click.option("--page_size", type=int, required=False, help="""pageSize""") +@click.option("--page_token", type=str, required=False, help="""pageToken""") +@click.pass_obj +def ontologies_v2_ontology_v2_query_type_page( + client: foundry.v2.FoundryClient, + ontology: str, + page_size: Optional[int], + page_token: Optional[str], +): + """ + Lists the query types for the given Ontology. + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. -@ontologies_ontology_object.command("aggregate") -@click.argument("ontology", type=str, required=True) + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + """ + result = client.ontologies.Ontology.QueryType.page( + ontology=ontology, + page_size=page_size, + page_token=page_token, + ) + click.echo(repr(result)) + + +@ontologies_v2_ontology_v2.group("object_type_v2") +def ontologies_v2_ontology_v2_object_type_v2(): + pass + + +@ontologies_v2_ontology_v2_object_type_v2.command("get") +@click.argument("ontology", type=str, required=True) +@click.argument("object_type", type=str, required=True) +@click.pass_obj +def ontologies_v2_ontology_v2_object_type_v2_get( + client: foundry.v2.FoundryClient, + ontology: str, + object_type: str, +): + """ + Gets a specific object type with the given API name. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + """ + result = client.ontologies.Ontology.ObjectType.get( + ontology=ontology, + object_type=object_type, + ) + click.echo(repr(result)) + + +@ontologies_v2_ontology_v2_object_type_v2.command("get_outgoing_link_type") +@click.argument("ontology", type=str, required=True) +@click.argument("object_type", type=str, required=True) +@click.argument("link_type", type=str, required=True) +@click.pass_obj +def ontologies_v2_ontology_v2_object_type_v2_get_outgoing_link_type( + client: foundry.v2.FoundryClient, + ontology: str, + object_type: str, + link_type: str, +): + """ + Get an outgoing link for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + """ + result = client.ontologies.Ontology.ObjectType.get_outgoing_link_type( + ontology=ontology, + object_type=object_type, + link_type=link_type, + ) + click.echo(repr(result)) + + +@ontologies_v2_ontology_v2_object_type_v2.command("list") +@click.argument("ontology", type=str, required=True) +@click.option("--page_size", type=int, required=False, help="""pageSize""") +@click.pass_obj +def ontologies_v2_ontology_v2_object_type_v2_list( + client: foundry.v2.FoundryClient, + ontology: str, + page_size: Optional[int], +): + """ + Lists the object types for the given Ontology. + + Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are + more results available, at least one result will be present in the + response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + """ + result = client.ontologies.Ontology.ObjectType.list( + ontology=ontology, + page_size=page_size, + ) + click.echo(repr(result)) + + +@ontologies_v2_ontology_v2_object_type_v2.command("list_outgoing_link_types") +@click.argument("ontology", type=str, required=True) +@click.argument("object_type", type=str, required=True) +@click.option("--page_size", type=int, required=False, help="""pageSize""") +@click.pass_obj +def ontologies_v2_ontology_v2_object_type_v2_list_outgoing_link_types( + client: foundry.v2.FoundryClient, + ontology: str, + object_type: str, + page_size: Optional[int], +): + """ + List the outgoing links for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + """ + result = client.ontologies.Ontology.ObjectType.list_outgoing_link_types( + ontology=ontology, + object_type=object_type, + page_size=page_size, + ) + click.echo(repr(result)) + + +@ontologies_v2_ontology_v2_object_type_v2.command("page") +@click.argument("ontology", type=str, required=True) +@click.option("--page_size", type=int, required=False, help="""pageSize""") +@click.option("--page_token", type=str, required=False, help="""pageToken""") +@click.pass_obj +def ontologies_v2_ontology_v2_object_type_v2_page( + client: foundry.v2.FoundryClient, + ontology: str, + page_size: Optional[int], + page_token: Optional[str], +): + """ + Lists the object types for the given Ontology. + + Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are + more results available, at least one result will be present in the + response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + """ + result = client.ontologies.Ontology.ObjectType.page( + ontology=ontology, + page_size=page_size, + page_token=page_token, + ) + click.echo(repr(result)) + + +@ontologies_v2_ontology_v2_object_type_v2.command("page_outgoing_link_types") +@click.argument("ontology", type=str, required=True) +@click.argument("object_type", type=str, required=True) +@click.option("--page_size", type=int, required=False, help="""pageSize""") +@click.option("--page_token", type=str, required=False, help="""pageToken""") +@click.pass_obj +def ontologies_v2_ontology_v2_object_type_v2_page_outgoing_link_types( + client: foundry.v2.FoundryClient, + ontology: str, + object_type: str, + page_size: Optional[int], + page_token: Optional[str], +): + """ + List the outgoing links for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + """ + result = client.ontologies.Ontology.ObjectType.page_outgoing_link_types( + ontology=ontology, + object_type=object_type, + page_size=page_size, + page_token=page_token, + ) + click.echo(repr(result)) + + +@ontologies_v2_ontology_v2.group("action_type_v2") +def ontologies_v2_ontology_v2_action_type_v2(): + pass + + +@ontologies_v2_ontology_v2_action_type_v2.command("get") +@click.argument("ontology", type=str, required=True) +@click.argument("action_type", type=str, required=True) +@click.pass_obj +def ontologies_v2_ontology_v2_action_type_v2_get( + client: foundry.v2.FoundryClient, + ontology: str, + action_type: str, +): + """ + Gets a specific action type with the given API name. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + """ + result = client.ontologies.Ontology.ActionType.get( + ontology=ontology, + action_type=action_type, + ) + click.echo(repr(result)) + + +@ontologies_v2_ontology_v2_action_type_v2.command("list") +@click.argument("ontology", type=str, required=True) +@click.option("--page_size", type=int, required=False, help="""pageSize""") +@click.pass_obj +def ontologies_v2_ontology_v2_action_type_v2_list( + client: foundry.v2.FoundryClient, + ontology: str, + page_size: Optional[int], +): + """ + Lists the action types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + """ + result = client.ontologies.Ontology.ActionType.list( + ontology=ontology, + page_size=page_size, + ) + click.echo(repr(result)) + + +@ontologies_v2_ontology_v2_action_type_v2.command("page") +@click.argument("ontology", type=str, required=True) +@click.option("--page_size", type=int, required=False, help="""pageSize""") +@click.option("--page_token", type=str, required=False, help="""pageToken""") +@click.pass_obj +def ontologies_v2_ontology_v2_action_type_v2_page( + client: foundry.v2.FoundryClient, + ontology: str, + page_size: Optional[int], + page_token: Optional[str], +): + """ + Lists the action types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + """ + result = client.ontologies.Ontology.ActionType.page( + ontology=ontology, + page_size=page_size, + page_token=page_token, + ) + click.echo(repr(result)) + + +@ontologies_v2.group("ontology_object_v2") +def ontologies_v2_ontology_object_v2(): + pass + + +@ontologies_v2_ontology_object_v2.command("aggregate") +@click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.option("--aggregation", type=str, required=True, help="""""") -@click.option("--where", type=str, required=False, help="""""") @click.option("--group_by", type=str, required=True, help="""""") @click.option( "--accuracy", @@ -1551,17 +1884,18 @@ def ontologies_ontology_object(): ) @click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") @click.option("--package_name", type=str, required=False, help="""packageName""") +@click.option("--where", type=str, required=False, help="""""") @click.pass_obj -def ontologies_ontology_object_aggregate( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_object_v2_aggregate( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, aggregation: str, - where: Optional[str], group_by: str, accuracy: Optional[Literal["REQUIRE_ACCURATE", "ALLOW_APPROXIMATE"]], artifact_repository: Optional[str], package_name: Optional[str], + where: Optional[str], ): """ Perform functions on object fields in the specified ontology and object type. @@ -1572,28 +1906,24 @@ def ontologies_ontology_object_aggregate( result = client.ontologies.OntologyObject.aggregate( ontology=ontology, object_type=object_type, - aggregate_objects_request_v2=foundry.v2.models.AggregateObjectsRequestV2.model_validate( - { - "aggregation": aggregation, - "where": where, - "groupBy": group_by, - "accuracy": accuracy, - } - ), + aggregation=json.loads(aggregation), + group_by=json.loads(group_by), + accuracy=accuracy, artifact_repository=artifact_repository, package_name=package_name, + where=None if where is None else json.loads(where), ) click.echo(repr(result)) -@ontologies_ontology_object.command("count") +@ontologies_v2_ontology_object_v2.command("count") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") @click.option("--package_name", type=str, required=False, help="""packageName""") @click.pass_obj -def ontologies_ontology_object_count( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_object_v2_count( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, artifact_repository: Optional[str], @@ -1614,7 +1944,7 @@ def ontologies_ontology_object_count( click.echo(repr(result)) -@ontologies_ontology_object.command("get") +@ontologies_v2_ontology_object_v2.command("get") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.argument("primary_key", type=str, required=True) @@ -1623,8 +1953,8 @@ def ontologies_ontology_object_count( @click.option("--package_name", type=str, required=False, help="""packageName""") @click.option("--select", type=str, required=False, help="""select""") @click.pass_obj -def ontologies_ontology_object_get( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_object_v2_get( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -1651,7 +1981,7 @@ def ontologies_ontology_object_get( click.echo(repr(result)) -@ontologies_ontology_object.command("list") +@ontologies_v2_ontology_object_v2.command("list") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") @@ -1661,8 +1991,8 @@ def ontologies_ontology_object_get( @click.option("--page_size", type=int, required=False, help="""pageSize""") @click.option("--select", type=str, required=False, help="""select""") @click.pass_obj -def ontologies_ontology_object_list( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_object_v2_list( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, artifact_repository: Optional[str], @@ -1703,7 +2033,7 @@ def ontologies_ontology_object_list( click.echo(repr(result)) -@ontologies_ontology_object.command("page") +@ontologies_v2_ontology_object_v2.command("page") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") @@ -1714,8 +2044,8 @@ def ontologies_ontology_object_list( @click.option("--page_token", type=str, required=False, help="""pageToken""") @click.option("--select", type=str, required=False, help="""select""") @click.pass_obj -def ontologies_ontology_object_page( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_object_v2_page( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, artifact_repository: Optional[str], @@ -1758,13 +2088,9 @@ def ontologies_ontology_object_page( click.echo(repr(result)) -@ontologies_ontology_object.command("search") +@ontologies_v2_ontology_object_v2.command("search") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) -@click.option("--where", type=str, required=False, help="""""") -@click.option("--order_by", type=str, required=False, help="""""") -@click.option("--page_size", type=int, required=False, help="""""") -@click.option("--page_token", type=str, required=False, help="""""") @click.option( "--select", type=str, @@ -1772,6 +2098,7 @@ def ontologies_ontology_object_page( help="""The API names of the object type properties to include in the response. """, ) +@click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") @click.option( "--exclude_rid", type=bool, @@ -1780,21 +2107,24 @@ def ontologies_ontology_object_page( Setting this to true may improve performance of this endpoint for object types in OSV2. """, ) -@click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") +@click.option("--order_by", type=str, required=False, help="""""") @click.option("--package_name", type=str, required=False, help="""packageName""") +@click.option("--page_size", type=int, required=False, help="""""") +@click.option("--page_token", type=str, required=False, help="""""") +@click.option("--where", type=str, required=False, help="""""") @click.pass_obj -def ontologies_ontology_object_search( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_object_v2_search( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, - where: Optional[str], - order_by: Optional[str], - page_size: Optional[int], - page_token: Optional[str], select: str, - exclude_rid: Optional[bool], artifact_repository: Optional[str], + exclude_rid: Optional[bool], + order_by: Optional[str], package_name: Optional[str], + page_size: Optional[int], + page_token: Optional[str], + where: Optional[str], ): """ Search for objects in the specified ontology and object type. The request body is used @@ -1821,503 +2151,269 @@ def ontologies_ontology_object_search( Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. """ - result = client.ontologies.OntologyObject.search( - ontology=ontology, - object_type=object_type, - search_objects_request_v2=foundry.v2.models.SearchObjectsRequestV2.model_validate( - { - "where": where, - "orderBy": order_by, - "pageSize": page_size, - "pageToken": page_token, - "select": select, - "excludeRid": exclude_rid, - } - ), - artifact_repository=artifact_repository, - package_name=package_name, - ) - click.echo(repr(result)) - - -@ontologies.group("ontology_interface") -def ontologies_ontology_interface(): - pass - - -@ontologies_ontology_interface.command("aggregate") -@click.argument("ontology", type=str, required=True) -@click.argument("interface_type", type=str, required=True) -@click.option("--aggregation", type=str, required=True, help="""""") -@click.option("--where", type=str, required=False, help="""""") -@click.option("--group_by", type=str, required=True, help="""""") -@click.option( - "--accuracy", - type=click.Choice(["REQUIRE_ACCURATE", "ALLOW_APPROXIMATE"]), - required=False, - help="""""", -) -@click.option("--preview", type=bool, required=False, help="""preview""") -@click.pass_obj -def ontologies_ontology_interface_aggregate( - client: foundry.v2.FoundryV2Client, - ontology: str, - interface_type: str, - aggregation: str, - where: Optional[str], - group_by: str, - accuracy: Optional[Literal["REQUIRE_ACCURATE", "ALLOW_APPROXIMATE"]], - preview: Optional[bool], -): - """ - :::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. - ::: - - Perform functions on object fields in the specified ontology and of the specified interface type. Any - properties specified in the query must be shared property type API names defined on the interface. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.OntologyInterface.aggregate( - ontology=ontology, - interface_type=interface_type, - aggregate_objects_request_v2=foundry.v2.models.AggregateObjectsRequestV2.model_validate( - { - "aggregation": aggregation, - "where": where, - "groupBy": group_by, - "accuracy": accuracy, - } - ), - preview=preview, - ) - click.echo(repr(result)) - - -@ontologies_ontology_interface.command("get") -@click.argument("ontology", type=str, required=True) -@click.argument("interface_type", type=str, required=True) -@click.option("--preview", type=bool, required=False, help="""preview""") -@click.pass_obj -def ontologies_ontology_interface_get( - client: foundry.v2.FoundryV2Client, - ontology: str, - interface_type: str, - preview: Optional[bool], -): - """ - :::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. - ::: - - Gets a specific object type with the given API name. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.OntologyInterface.get( - ontology=ontology, - interface_type=interface_type, - preview=preview, - ) - click.echo(repr(result)) - - -@ontologies_ontology_interface.command("list") -@click.argument("ontology", type=str, required=True) -@click.option("--page_size", type=int, required=False, help="""pageSize""") -@click.option("--preview", type=bool, required=False, help="""preview""") -@click.pass_obj -def ontologies_ontology_interface_list( - client: foundry.v2.FoundryV2Client, - ontology: str, - page_size: Optional[int], - preview: Optional[bool], -): - """ - :::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. - ::: - - Lists the interface types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.OntologyInterface.list( - ontology=ontology, - page_size=page_size, - preview=preview, - ) - click.echo(repr(result)) - - -@ontologies_ontology_interface.command("page") -@click.argument("ontology", type=str, required=True) -@click.option("--page_size", type=int, required=False, help="""pageSize""") -@click.option("--page_token", type=str, required=False, help="""pageToken""") -@click.option("--preview", type=bool, required=False, help="""preview""") -@click.pass_obj -def ontologies_ontology_interface_page( - client: foundry.v2.FoundryV2Client, - ontology: str, - page_size: Optional[int], - page_token: Optional[str], - preview: Optional[bool], -): - """ - :::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. - ::: - - Lists the interface types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.OntologyInterface.page( - ontology=ontology, - page_size=page_size, - page_token=page_token, - preview=preview, - ) - click.echo(repr(result)) - - -@ontologies.group("ontology") -def ontologies_ontology(): - pass - - -@ontologies_ontology.command("get") -@click.argument("ontology", type=str, required=True) -@click.pass_obj -def ontologies_ontology_get( - client: foundry.v2.FoundryV2Client, - ontology: str, -): - """ - Gets a specific ontology with the given Ontology RID. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.Ontology.get( - ontology=ontology, - ) - click.echo(repr(result)) - - -@ontologies_ontology.command("get_full_metadata") -@click.argument("ontology", type=str, required=True) -@click.pass_obj -def ontologies_ontology_get_full_metadata( - client: foundry.v2.FoundryV2Client, - ontology: str, -): - """ - Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces. - - """ - result = client.ontologies.Ontology.get_full_metadata( - ontology=ontology, - ) - click.echo(repr(result)) - - -@ontologies_ontology.group("query_type") -def ontologies_ontology_query_type(): - pass - - -@ontologies_ontology_query_type.command("get") -@click.argument("ontology", type=str, required=True) -@click.argument("query_api_name", type=str, required=True) -@click.pass_obj -def ontologies_ontology_query_type_get( - client: foundry.v2.FoundryV2Client, - ontology: str, - query_api_name: str, -): - """ - Gets a specific query type with the given API name. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.Ontology.QueryType.get( - ontology=ontology, - query_api_name=query_api_name, - ) - click.echo(repr(result)) - - -@ontologies_ontology_query_type.command("list") -@click.argument("ontology", type=str, required=True) -@click.option("--page_size", type=int, required=False, help="""pageSize""") -@click.pass_obj -def ontologies_ontology_query_type_list( - client: foundry.v2.FoundryV2Client, - ontology: str, - page_size: Optional[int], -): - """ - Lists the query types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.Ontology.QueryType.list( - ontology=ontology, - page_size=page_size, - ) - click.echo(repr(result)) - - -@ontologies_ontology_query_type.command("page") -@click.argument("ontology", type=str, required=True) -@click.option("--page_size", type=int, required=False, help="""pageSize""") -@click.option("--page_token", type=str, required=False, help="""pageToken""") -@click.pass_obj -def ontologies_ontology_query_type_page( - client: foundry.v2.FoundryV2Client, - ontology: str, - page_size: Optional[int], - page_token: Optional[str], -): - """ - Lists the query types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - - """ - result = client.ontologies.Ontology.QueryType.page( + result = client.ontologies.OntologyObject.search( ontology=ontology, + object_type=object_type, + select=json.loads(select), + artifact_repository=artifact_repository, + exclude_rid=exclude_rid, + order_by=None if order_by is None else json.loads(order_by), + package_name=package_name, page_size=page_size, page_token=page_token, + where=None if where is None else json.loads(where), ) click.echo(repr(result)) -@ontologies_ontology.group("object_type") -def ontologies_ontology_object_type(): +@ontologies_v2.group("ontology_object_set") +def ontologies_v2_ontology_object_set(): pass -@ontologies_ontology_object_type.command("get") +@ontologies_v2_ontology_object_set.command("aggregate") @click.argument("ontology", type=str, required=True) -@click.argument("object_type", type=str, required=True) +@click.option("--aggregation", type=str, required=True, help="""""") +@click.option("--group_by", type=str, required=True, help="""""") +@click.option("--object_set", type=str, required=True, help="""""") +@click.option( + "--accuracy", + type=click.Choice(["REQUIRE_ACCURATE", "ALLOW_APPROXIMATE"]), + required=False, + help="""""", +) +@click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") +@click.option("--package_name", type=str, required=False, help="""packageName""") @click.pass_obj -def ontologies_ontology_object_type_get( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_object_set_aggregate( + client: foundry.v2.FoundryClient, ontology: str, - object_type: str, + aggregation: str, + group_by: str, + object_set: str, + accuracy: Optional[Literal["REQUIRE_ACCURATE", "ALLOW_APPROXIMATE"]], + artifact_repository: Optional[str], + package_name: Optional[str], ): """ - Gets a specific object type with the given API name. + Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. """ - result = client.ontologies.Ontology.ObjectType.get( + result = client.ontologies.OntologyObjectSet.aggregate( ontology=ontology, - object_type=object_type, + aggregation=json.loads(aggregation), + group_by=json.loads(group_by), + object_set=json.loads(object_set), + accuracy=accuracy, + artifact_repository=artifact_repository, + package_name=package_name, ) click.echo(repr(result)) -@ontologies_ontology_object_type.command("get_outgoing_link_type") +@ontologies_v2_ontology_object_set.command("create_temporary") @click.argument("ontology", type=str, required=True) -@click.argument("object_type", type=str, required=True) -@click.argument("link_type", type=str, required=True) +@click.option("--object_set", type=str, required=True, help="""""") @click.pass_obj -def ontologies_ontology_object_type_get_outgoing_link_type( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_object_set_create_temporary( + client: foundry.v2.FoundryClient, ontology: str, - object_type: str, - link_type: str, + object_set: str, ): """ - Get an outgoing link for an object type. + Creates a temporary `ObjectSet` from the given definition. Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. + following operation scopes: `api:ontologies-read api:ontologies-write`. """ - result = client.ontologies.Ontology.ObjectType.get_outgoing_link_type( + result = client.ontologies.OntologyObjectSet.create_temporary( ontology=ontology, - object_type=object_type, - link_type=link_type, + object_set=json.loads(object_set), ) click.echo(repr(result)) -@ontologies_ontology_object_type.command("list") +@ontologies_v2_ontology_object_set.command("get") @click.argument("ontology", type=str, required=True) -@click.option("--page_size", type=int, required=False, help="""pageSize""") +@click.argument("object_set_rid", type=str, required=True) @click.pass_obj -def ontologies_ontology_object_type_list( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_object_set_get( + client: foundry.v2.FoundryClient, ontology: str, - page_size: Optional[int], + object_set_rid: str, ): """ - Lists the object types for the given Ontology. - - Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are - more results available, at least one result will be present in the - response. + Gets the definition of the `ObjectSet` with the given RID. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. """ - result = client.ontologies.Ontology.ObjectType.list( - ontology=ontology, - page_size=page_size, - ) - click.echo(repr(result)) - - -@ontologies_ontology_object_type.command("list_outgoing_link_types") -@click.argument("ontology", type=str, required=True) -@click.argument("object_type", type=str, required=True) -@click.option("--page_size", type=int, required=False, help="""pageSize""") -@click.pass_obj -def ontologies_ontology_object_type_list_outgoing_link_types( - client: foundry.v2.FoundryV2Client, - ontology: str, - object_type: str, - page_size: Optional[int], -): - """ - List the outgoing links for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - """ - result = client.ontologies.Ontology.ObjectType.list_outgoing_link_types( + result = client.ontologies.OntologyObjectSet.get( ontology=ontology, - object_type=object_type, - page_size=page_size, + object_set_rid=object_set_rid, ) click.echo(repr(result)) -@ontologies_ontology_object_type.command("page") +@ontologies_v2_ontology_object_set.command("load") @click.argument("ontology", type=str, required=True) -@click.option("--page_size", type=int, required=False, help="""pageSize""") -@click.option("--page_token", type=str, required=False, help="""pageToken""") +@click.option("--object_set", type=str, required=True, help="""""") +@click.option("--select", type=str, required=True, help="""""") +@click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") +@click.option( + "--exclude_rid", + type=bool, + required=False, + help="""A flag to exclude the retrieval of the `__rid` property. +Setting this to true may improve performance of this endpoint for object types in OSV2. +""", +) +@click.option("--order_by", type=str, required=False, help="""""") +@click.option("--package_name", type=str, required=False, help="""packageName""") +@click.option("--page_size", type=int, required=False, help="""""") +@click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj -def ontologies_ontology_object_type_page( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_object_set_load( + client: foundry.v2.FoundryClient, ontology: str, + object_set: str, + select: str, + artifact_repository: Optional[str], + exclude_rid: Optional[bool], + order_by: Optional[str], + package_name: Optional[str], page_size: Optional[int], page_token: Optional[str], ): """ - Lists the object types for the given Ontology. + Load the ontology objects present in the `ObjectSet` from the provided object set definition. - Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are - more results available, at least one result will be present in the - response. + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Note that null value properties will not be returned. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. """ - result = client.ontologies.Ontology.ObjectType.page( + result = client.ontologies.OntologyObjectSet.load( ontology=ontology, + object_set=json.loads(object_set), + select=json.loads(select), + artifact_repository=artifact_repository, + exclude_rid=exclude_rid, + order_by=None if order_by is None else json.loads(order_by), + package_name=package_name, page_size=page_size, page_token=page_token, ) click.echo(repr(result)) -@ontologies_ontology_object_type.command("page_outgoing_link_types") +@ontologies_v2.group("ontology_interface") +def ontologies_v2_ontology_interface(): + pass + + +@ontologies_v2_ontology_interface.command("aggregate") @click.argument("ontology", type=str, required=True) -@click.argument("object_type", type=str, required=True) -@click.option("--page_size", type=int, required=False, help="""pageSize""") -@click.option("--page_token", type=str, required=False, help="""pageToken""") +@click.argument("interface_type", type=str, required=True) +@click.option("--aggregation", type=str, required=True, help="""""") +@click.option("--group_by", type=str, required=True, help="""""") +@click.option( + "--accuracy", + type=click.Choice(["REQUIRE_ACCURATE", "ALLOW_APPROXIMATE"]), + required=False, + help="""""", +) +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.option("--where", type=str, required=False, help="""""") @click.pass_obj -def ontologies_ontology_object_type_page_outgoing_link_types( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_interface_aggregate( + client: foundry.v2.FoundryClient, ontology: str, - object_type: str, - page_size: Optional[int], - page_token: Optional[str], + interface_type: str, + aggregation: str, + group_by: str, + accuracy: Optional[Literal["REQUIRE_ACCURATE", "ALLOW_APPROXIMATE"]], + preview: Optional[bool], + where: Optional[str], ): """ - List the outgoing links for an object type. + :::callout{theme=warning title=Warning} + This endpoint is in preview and may be modified or removed at any time. + To use this endpoint, add `preview=true` to the request query parameters. + ::: - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. + Perform functions on object fields in the specified ontology and of the specified interface type. Any + properties specified in the query must be shared property type API names defined on the interface. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. """ - result = client.ontologies.Ontology.ObjectType.page_outgoing_link_types( + result = client.ontologies.OntologyInterface.aggregate( ontology=ontology, - object_type=object_type, - page_size=page_size, - page_token=page_token, + interface_type=interface_type, + aggregation=json.loads(aggregation), + group_by=json.loads(group_by), + accuracy=accuracy, + preview=preview, + where=None if where is None else json.loads(where), ) click.echo(repr(result)) -@ontologies_ontology.group("action_type") -def ontologies_ontology_action_type(): - pass - - -@ontologies_ontology_action_type.command("get") +@ontologies_v2_ontology_interface.command("get") @click.argument("ontology", type=str, required=True) -@click.argument("action_type", type=str, required=True) +@click.argument("interface_type", type=str, required=True) +@click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj -def ontologies_ontology_action_type_get( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_interface_get( + client: foundry.v2.FoundryClient, ontology: str, - action_type: str, + interface_type: str, + preview: Optional[bool], ): """ - Gets a specific action type with the given API name. + :::callout{theme=warning title=Warning} + This endpoint is in preview and may be modified or removed at any time. + To use this endpoint, add `preview=true` to the request query parameters. + ::: + + Gets a specific object type with the given API name. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. """ - result = client.ontologies.Ontology.ActionType.get( + result = client.ontologies.OntologyInterface.get( ontology=ontology, - action_type=action_type, + interface_type=interface_type, + preview=preview, ) click.echo(repr(result)) -@ontologies_ontology_action_type.command("list") +@ontologies_v2_ontology_interface.command("list") @click.argument("ontology", type=str, required=True) @click.option("--page_size", type=int, required=False, help="""pageSize""") +@click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj -def ontologies_ontology_action_type_list( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_interface_list( + client: foundry.v2.FoundryClient, ontology: str, page_size: Optional[int], + preview: Optional[bool], ): """ - Lists the action types for the given Ontology. + :::callout{theme=warning title=Warning} + This endpoint is in preview and may be modified or removed at any time. + To use this endpoint, add `preview=true` to the request query parameters. + ::: + + Lists the interface types for the given Ontology. Each page may be smaller than the requested page size. However, it is guaranteed that if there are more results available, at least one result will be present in the response. @@ -2325,26 +2421,34 @@ def ontologies_ontology_action_type_list( Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. """ - result = client.ontologies.Ontology.ActionType.list( + result = client.ontologies.OntologyInterface.list( ontology=ontology, page_size=page_size, + preview=preview, ) click.echo(repr(result)) -@ontologies_ontology_action_type.command("page") +@ontologies_v2_ontology_interface.command("page") @click.argument("ontology", type=str, required=True) @click.option("--page_size", type=int, required=False, help="""pageSize""") @click.option("--page_token", type=str, required=False, help="""pageToken""") +@click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj -def ontologies_ontology_action_type_page( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_ontology_interface_page( + client: foundry.v2.FoundryClient, ontology: str, page_size: Optional[int], page_token: Optional[str], + preview: Optional[bool], ): """ - Lists the action types for the given Ontology. + :::callout{theme=warning title=Warning} + This endpoint is in preview and may be modified or removed at any time. + To use this endpoint, add `preview=true` to the request query parameters. + ::: + + Lists the interface types for the given Ontology. Each page may be smaller than the requested page size. However, it is guaranteed that if there are more results available, at least one result will be present in the response. @@ -2352,20 +2456,21 @@ def ontologies_ontology_action_type_page( Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. """ - result = client.ontologies.Ontology.ActionType.page( + result = client.ontologies.OntologyInterface.page( ontology=ontology, page_size=page_size, page_token=page_token, + preview=preview, ) click.echo(repr(result)) -@ontologies.group("linked_object") -def ontologies_linked_object(): +@ontologies_v2.group("linked_object_v2") +def ontologies_v2_linked_object_v2(): pass -@ontologies_linked_object.command("get_linked_object") +@ontologies_v2_linked_object_v2.command("get_linked_object") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.argument("primary_key", type=str, required=True) @@ -2376,8 +2481,8 @@ def ontologies_linked_object(): @click.option("--package_name", type=str, required=False, help="""packageName""") @click.option("--select", type=str, required=False, help="""select""") @click.pass_obj -def ontologies_linked_object_get_linked_object( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_linked_object_v2_get_linked_object( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -2410,7 +2515,7 @@ def ontologies_linked_object_get_linked_object( click.echo(repr(result)) -@ontologies_linked_object.command("list_linked_objects") +@ontologies_v2_linked_object_v2.command("list_linked_objects") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.argument("primary_key", type=str, required=True) @@ -2422,8 +2527,8 @@ def ontologies_linked_object_get_linked_object( @click.option("--page_size", type=int, required=False, help="""pageSize""") @click.option("--select", type=str, required=False, help="""select""") @click.pass_obj -def ontologies_linked_object_list_linked_objects( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_linked_object_v2_list_linked_objects( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -2468,7 +2573,7 @@ def ontologies_linked_object_list_linked_objects( click.echo(repr(result)) -@ontologies_linked_object.command("page_linked_objects") +@ontologies_v2_linked_object_v2.command("page_linked_objects") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.argument("primary_key", type=str, required=True) @@ -2481,8 +2586,8 @@ def ontologies_linked_object_list_linked_objects( @click.option("--page_token", type=str, required=False, help="""pageToken""") @click.option("--select", type=str, required=False, help="""select""") @click.pass_obj -def ontologies_linked_object_page_linked_objects( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_linked_object_v2_page_linked_objects( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -2529,12 +2634,12 @@ def ontologies_linked_object_page_linked_objects( click.echo(repr(result)) -@ontologies.group("attachment_property") -def ontologies_attachment_property(): +@ontologies_v2.group("attachment_property_v2") +def ontologies_v2_attachment_property_v2(): pass -@ontologies_attachment_property.command("get_attachment") +@ontologies_v2_attachment_property_v2.command("get_attachment") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.argument("primary_key", type=str, required=True) @@ -2542,8 +2647,8 @@ def ontologies_attachment_property(): @click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") @click.option("--package_name", type=str, required=False, help="""packageName""") @click.pass_obj -def ontologies_attachment_property_get_attachment( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_attachment_property_v2_get_attachment( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -2569,7 +2674,7 @@ def ontologies_attachment_property_get_attachment( click.echo(repr(result)) -@ontologies_attachment_property.command("get_attachment_by_rid") +@ontologies_v2_attachment_property_v2.command("get_attachment_by_rid") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.argument("primary_key", type=str, required=True) @@ -2578,8 +2683,8 @@ def ontologies_attachment_property_get_attachment( @click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") @click.option("--package_name", type=str, required=False, help="""packageName""") @click.pass_obj -def ontologies_attachment_property_get_attachment_by_rid( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_attachment_property_v2_get_attachment_by_rid( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -2607,7 +2712,7 @@ def ontologies_attachment_property_get_attachment_by_rid( click.echo(repr(result)) -@ontologies_attachment_property.command("read_attachment") +@ontologies_v2_attachment_property_v2.command("read_attachment") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.argument("primary_key", type=str, required=True) @@ -2615,8 +2720,8 @@ def ontologies_attachment_property_get_attachment_by_rid( @click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") @click.option("--package_name", type=str, required=False, help="""packageName""") @click.pass_obj -def ontologies_attachment_property_read_attachment( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_attachment_property_v2_read_attachment( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -2642,7 +2747,7 @@ def ontologies_attachment_property_read_attachment( click.echo(result) -@ontologies_attachment_property.command("read_attachment_by_rid") +@ontologies_v2_attachment_property_v2.command("read_attachment_by_rid") @click.argument("ontology", type=str, required=True) @click.argument("object_type", type=str, required=True) @click.argument("primary_key", type=str, required=True) @@ -2651,8 +2756,8 @@ def ontologies_attachment_property_read_attachment( @click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") @click.option("--package_name", type=str, required=False, help="""packageName""") @click.pass_obj -def ontologies_attachment_property_read_attachment_by_rid( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_attachment_property_v2_read_attachment_by_rid( + client: foundry.v2.FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -2682,36 +2787,16 @@ def ontologies_attachment_property_read_attachment_by_rid( click.echo(result) -@ontologies.group("attachment") -def ontologies_attachment(): +@ontologies_v2.group("attachment") +def ontologies_v2_attachment(): pass -@ontologies_attachment.command("get") +@ontologies_v2_attachment.command("read") @click.argument("attachment_rid", type=str, required=True) @click.pass_obj -def ontologies_attachment_get( - client: foundry.v2.FoundryV2Client, - attachment_rid: str, -): - """ - Get the metadata of an attachment. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - - """ - result = client.ontologies.Attachment.get( - attachment_rid=attachment_rid, - ) - click.echo(repr(result)) - - -@ontologies_attachment.command("read") -@click.argument("attachment_rid", type=str, required=True) -@click.pass_obj -def ontologies_attachment_read( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_attachment_read( + client: foundry.v2.FoundryClient, attachment_rid: str, ): """ @@ -2727,14 +2812,14 @@ def ontologies_attachment_read( click.echo(result) -@ontologies_attachment.command("upload") +@ontologies_v2_attachment.command("upload") @click.argument("body", type=click.File("rb"), required=True) @click.option("--content_length", type=str, required=True, help="""Content-Length""") @click.option("--content_type", type=str, required=True, help="""Content-Type""") @click.option("--filename", type=str, required=True, help="""filename""") @click.pass_obj -def ontologies_attachment_upload( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_attachment_upload( + client: foundry.v2.FoundryClient, body: io.BufferedReader, content_length: str, content_type: str, @@ -2760,26 +2845,26 @@ def ontologies_attachment_upload( click.echo(repr(result)) -@ontologies.group("action") -def ontologies_action(): +@ontologies_v2.group("action") +def ontologies_v2_action(): pass -@ontologies_action.command("apply") +@ontologies_v2_action.command("apply") @click.argument("ontology", type=str, required=True) @click.argument("action", type=str, required=True) -@click.option("--options", type=str, required=False, help="""""") @click.option("--parameters", type=str, required=True, help="""""") @click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") +@click.option("--options", type=str, required=False, help="""""") @click.option("--package_name", type=str, required=False, help="""packageName""") @click.pass_obj -def ontologies_action_apply( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_action_apply( + client: foundry.v2.FoundryClient, ontology: str, action: str, - options: Optional[str], parameters: str, artifact_repository: Optional[str], + options: Optional[str], package_name: Optional[str], ): """ @@ -2797,33 +2882,29 @@ def ontologies_action_apply( result = client.ontologies.Action.apply( ontology=ontology, action=action, - apply_action_request_v2=foundry.v2.models.ApplyActionRequestV2.model_validate( - { - "options": options, - "parameters": parameters, - } - ), + parameters=json.loads(parameters), artifact_repository=artifact_repository, + options=None if options is None else json.loads(options), package_name=package_name, ) click.echo(repr(result)) -@ontologies_action.command("apply_batch") +@ontologies_v2_action.command("apply_batch") @click.argument("ontology", type=str, required=True) @click.argument("action", type=str, required=True) -@click.option("--options", type=str, required=False, help="""""") @click.option("--requests", type=str, required=True, help="""""") @click.option("--artifact_repository", type=str, required=False, help="""artifactRepository""") +@click.option("--options", type=str, required=False, help="""""") @click.option("--package_name", type=str, required=False, help="""packageName""") @click.pass_obj -def ontologies_action_apply_batch( - client: foundry.v2.FoundryV2Client, +def ontologies_v2_action_apply_batch( + client: foundry.v2.FoundryClient, ontology: str, action: str, - options: Optional[str], requests: str, artifact_repository: Optional[str], + options: Optional[str], package_name: Optional[str], ): """ @@ -2842,13 +2923,9 @@ def ontologies_action_apply_batch( result = client.ontologies.Action.apply_batch( ontology=ontology, action=action, - batch_apply_action_request_v2=foundry.v2.models.BatchApplyActionRequestV2.model_validate( - { - "options": options, - "requests": requests, - } - ), + requests=json.loads(requests), artifact_repository=artifact_repository, + options=None if options is None else json.loads(options), package_name=package_name, ) click.echo(repr(result)) @@ -2869,7 +2946,7 @@ def orchestration_schedule(): @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def orchestration_schedule_get( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, schedule_rid: str, preview: Optional[bool], ): @@ -2888,7 +2965,7 @@ def orchestration_schedule_get( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def orchestration_schedule_pause( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, schedule_rid: str, preview: Optional[bool], ): @@ -2905,7 +2982,7 @@ def orchestration_schedule_pause( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def orchestration_schedule_run( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, schedule_rid: str, preview: Optional[bool], ): @@ -2922,7 +2999,7 @@ def orchestration_schedule_run( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def orchestration_schedule_unpause( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, schedule_rid: str, preview: Optional[bool], ): @@ -2940,50 +3017,48 @@ def orchestration_build(): @orchestration_build.command("create") +@click.option("--fallback_branches", type=str, required=True, help="""""") @click.option("--target", type=str, required=True, help="""The targets of the schedule.""") +@click.option("--abort_on_failure", type=bool, required=False, help="""""") @click.option( "--branch_name", type=str, required=False, help="""The target branch the build should run on.""" ) -@click.option("--fallback_branches", type=str, required=True, help="""""") @click.option("--force_build", type=bool, required=False, help="""""") +@click.option("--notifications_enabled", type=bool, required=False, help="""""") +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.option("--retry_backoff_duration", type=str, required=False, help="""""") @click.option( "--retry_count", type=int, required=False, help="""The number of retry attempts for failed jobs.""", ) -@click.option("--retry_backoff_duration", type=str, required=False, help="""""") -@click.option("--abort_on_failure", type=bool, required=False, help="""""") -@click.option("--notifications_enabled", type=bool, required=False, help="""""") -@click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def orchestration_build_create( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, + fallback_branches: str, target: str, + abort_on_failure: Optional[bool], branch_name: Optional[str], - fallback_branches: str, force_build: Optional[bool], - retry_count: Optional[int], - retry_backoff_duration: Optional[str], - abort_on_failure: Optional[bool], notifications_enabled: Optional[bool], preview: Optional[bool], + retry_backoff_duration: Optional[str], + retry_count: Optional[int], ): """ """ result = client.orchestration.Build.create( - create_builds_request=foundry.v2.models.CreateBuildsRequest.model_validate( - { - "target": target, - "branchName": branch_name, - "fallbackBranches": fallback_branches, - "forceBuild": force_build, - "retryCount": retry_count, - "retryBackoffDuration": retry_backoff_duration, - "abortOnFailure": abort_on_failure, - "notificationsEnabled": notifications_enabled, - } - ), + fallback_branches=json.loads(fallback_branches), + target=json.loads(target), + abort_on_failure=abort_on_failure, + branch_name=branch_name, + force_build=force_build, + notifications_enabled=notifications_enabled, preview=preview, + retry_backoff_duration=( + None if retry_backoff_duration is None else json.loads(retry_backoff_duration) + ), + retry_count=retry_count, ) click.echo(repr(result)) @@ -2993,7 +3068,7 @@ def orchestration_build_create( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def orchestration_build_get( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, build_rid: str, preview: Optional[bool], ): @@ -3022,7 +3097,7 @@ def third_party_applications_third_party_application(): @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def third_party_applications_third_party_application_get( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, third_party_application_rid: str, preview: Optional[bool], ): @@ -3047,7 +3122,7 @@ def third_party_applications_third_party_application_website(): @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def third_party_applications_third_party_application_website_deploy( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, third_party_application_rid: str, version: str, preview: Optional[bool], @@ -3057,11 +3132,7 @@ def third_party_applications_third_party_application_website_deploy( """ result = client.third_party_applications.ThirdPartyApplication.Website.deploy( third_party_application_rid=third_party_application_rid, - deploy_website_request=foundry.v2.models.DeployWebsiteRequest.model_validate( - { - "version": version, - } - ), + version=version, preview=preview, ) click.echo(repr(result)) @@ -3072,7 +3143,7 @@ def third_party_applications_third_party_application_website_deploy( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def third_party_applications_third_party_application_website_get( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, third_party_application_rid: str, preview: Optional[bool], ): @@ -3091,7 +3162,7 @@ def third_party_applications_third_party_application_website_get( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def third_party_applications_third_party_application_website_undeploy( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, third_party_application_rid: str, preview: Optional[bool], ): @@ -3116,7 +3187,7 @@ def third_party_applications_third_party_application_website_version(): @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def third_party_applications_third_party_application_website_version_delete( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, third_party_application_rid: str, version_version: str, preview: Optional[bool], @@ -3138,7 +3209,7 @@ def third_party_applications_third_party_application_website_version_delete( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def third_party_applications_third_party_application_website_version_get( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, third_party_application_rid: str, version_version: str, preview: Optional[bool], @@ -3160,7 +3231,7 @@ def third_party_applications_third_party_application_website_version_get( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def third_party_applications_third_party_application_website_version_list( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, third_party_application_rid: str, page_size: Optional[int], preview: Optional[bool], @@ -3185,7 +3256,7 @@ def third_party_applications_third_party_application_website_version_list( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def third_party_applications_third_party_application_website_version_page( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, third_party_application_rid: str, page_size: Optional[int], page_token: Optional[str], @@ -3212,7 +3283,7 @@ def third_party_applications_third_party_application_website_version_page( @click.option("--preview", type=bool, required=False, help="""preview""") @click.pass_obj def third_party_applications_third_party_application_website_version_upload( - client: foundry.v2.FoundryV2Client, + client: foundry.v2.FoundryClient, third_party_application_rid: str, body: io.BufferedReader, version: str, diff --git a/foundry/v2/client.py b/foundry/v2/client.py new file mode 100644 index 00000000..18249123 --- /dev/null +++ b/foundry/v2/client.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from foundry._core import Auth + + +class FoundryClient: + """ + The Foundry V2 API client. + + :param auth: Your auth configuration. + :param hostname: Your Foundry hostname (for example, "myfoundry.palantirfoundry.com"). + """ + + def __init__(self, auth: Auth, hostname: str): + from foundry.v2.admin.client import AdminClient + from foundry.v2.datasets.client import DatasetsClient + from foundry.v2.ontologies.client import OntologiesClient + from foundry.v2.orchestration.client import OrchestrationClient + from foundry.v2.third_party_applications.client import ThirdPartyApplicationsClient # NOQA + + self.admin = AdminClient(auth=auth, hostname=hostname) + self.datasets = DatasetsClient(auth=auth, hostname=hostname) + self.ontologies = OntologiesClient(auth=auth, hostname=hostname) + self.orchestration = OrchestrationClient(auth=auth, hostname=hostname) + self.third_party_applications = ThirdPartyApplicationsClient(auth=auth, hostname=hostname) diff --git a/foundry/v2/core/models/__init__.py b/foundry/v2/core/models/__init__.py new file mode 100644 index 00000000..31bd43b7 --- /dev/null +++ b/foundry/v2/core/models/__init__.py @@ -0,0 +1,154 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from foundry.v2.core.models._attachment_type import AttachmentType +from foundry.v2.core.models._attachment_type_dict import AttachmentTypeDict +from foundry.v2.core.models._boolean_type import BooleanType +from foundry.v2.core.models._boolean_type_dict import BooleanTypeDict +from foundry.v2.core.models._byte_type import ByteType +from foundry.v2.core.models._byte_type_dict import ByteTypeDict +from foundry.v2.core.models._content_length import ContentLength +from foundry.v2.core.models._content_type import ContentType +from foundry.v2.core.models._created_by import CreatedBy +from foundry.v2.core.models._created_time import CreatedTime +from foundry.v2.core.models._date_type import DateType +from foundry.v2.core.models._date_type_dict import DateTypeDict +from foundry.v2.core.models._decimal_type import DecimalType +from foundry.v2.core.models._decimal_type_dict import DecimalTypeDict +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.core.models._distance import Distance +from foundry.v2.core.models._distance_dict import DistanceDict +from foundry.v2.core.models._distance_unit import DistanceUnit +from foundry.v2.core.models._double_type import DoubleType +from foundry.v2.core.models._double_type_dict import DoubleTypeDict +from foundry.v2.core.models._duration import Duration +from foundry.v2.core.models._duration_dict import DurationDict +from foundry.v2.core.models._file_path import FilePath +from foundry.v2.core.models._filename import Filename +from foundry.v2.core.models._float_type import FloatType +from foundry.v2.core.models._float_type_dict import FloatTypeDict +from foundry.v2.core.models._geo_point_type import GeoPointType +from foundry.v2.core.models._geo_point_type_dict import GeoPointTypeDict +from foundry.v2.core.models._geo_shape_type import GeoShapeType +from foundry.v2.core.models._geo_shape_type_dict import GeoShapeTypeDict +from foundry.v2.core.models._integer_type import IntegerType +from foundry.v2.core.models._integer_type_dict import IntegerTypeDict +from foundry.v2.core.models._long_type import LongType +from foundry.v2.core.models._long_type_dict import LongTypeDict +from foundry.v2.core.models._marking_id import MarkingId +from foundry.v2.core.models._marking_type import MarkingType +from foundry.v2.core.models._marking_type_dict import MarkingTypeDict +from foundry.v2.core.models._media_set_rid import MediaSetRid +from foundry.v2.core.models._media_type import MediaType +from foundry.v2.core.models._null_type import NullType +from foundry.v2.core.models._null_type_dict import NullTypeDict +from foundry.v2.core.models._organization_rid import OrganizationRid +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.core.models._principal_id import PrincipalId +from foundry.v2.core.models._principal_type import PrincipalType +from foundry.v2.core.models._realm import Realm +from foundry.v2.core.models._release_status import ReleaseStatus +from foundry.v2.core.models._short_type import ShortType +from foundry.v2.core.models._short_type_dict import ShortTypeDict +from foundry.v2.core.models._size_bytes import SizeBytes +from foundry.v2.core.models._string_type import StringType +from foundry.v2.core.models._string_type_dict import StringTypeDict +from foundry.v2.core.models._struct_field_name import StructFieldName +from foundry.v2.core.models._time_series_item_type import TimeSeriesItemType +from foundry.v2.core.models._time_series_item_type_dict import TimeSeriesItemTypeDict +from foundry.v2.core.models._time_unit import TimeUnit +from foundry.v2.core.models._timeseries_type import TimeseriesType +from foundry.v2.core.models._timeseries_type_dict import TimeseriesTypeDict +from foundry.v2.core.models._timestamp_type import TimestampType +from foundry.v2.core.models._timestamp_type_dict import TimestampTypeDict +from foundry.v2.core.models._total_count import TotalCount +from foundry.v2.core.models._unsupported_type import UnsupportedType +from foundry.v2.core.models._unsupported_type_dict import UnsupportedTypeDict +from foundry.v2.core.models._updated_by import UpdatedBy +from foundry.v2.core.models._updated_time import UpdatedTime +from foundry.v2.core.models._user_id import UserId + +__all__ = [ + "AttachmentType", + "AttachmentTypeDict", + "BooleanType", + "BooleanTypeDict", + "ByteType", + "ByteTypeDict", + "ContentLength", + "ContentType", + "CreatedBy", + "CreatedTime", + "DateType", + "DateTypeDict", + "DecimalType", + "DecimalTypeDict", + "DisplayName", + "Distance", + "DistanceDict", + "DistanceUnit", + "DoubleType", + "DoubleTypeDict", + "Duration", + "DurationDict", + "FilePath", + "Filename", + "FloatType", + "FloatTypeDict", + "GeoPointType", + "GeoPointTypeDict", + "GeoShapeType", + "GeoShapeTypeDict", + "IntegerType", + "IntegerTypeDict", + "LongType", + "LongTypeDict", + "MarkingId", + "MarkingType", + "MarkingTypeDict", + "MediaSetRid", + "MediaType", + "NullType", + "NullTypeDict", + "OrganizationRid", + "PageSize", + "PageToken", + "PreviewMode", + "PrincipalId", + "PrincipalType", + "Realm", + "ReleaseStatus", + "ShortType", + "ShortTypeDict", + "SizeBytes", + "StringType", + "StringTypeDict", + "StructFieldName", + "TimeSeriesItemType", + "TimeSeriesItemTypeDict", + "TimeUnit", + "TimeseriesType", + "TimeseriesTypeDict", + "TimestampType", + "TimestampTypeDict", + "TotalCount", + "UnsupportedType", + "UnsupportedTypeDict", + "UpdatedBy", + "UpdatedTime", + "UserId", +] diff --git a/foundry/v2/core/models/_attachment_type.py b/foundry/v2/core/models/_attachment_type.py new file mode 100644 index 00000000..df48742e --- /dev/null +++ b/foundry/v2/core/models/_attachment_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._attachment_type_dict import AttachmentTypeDict + + +class AttachmentType(BaseModel): + """AttachmentType""" + + type: Literal["attachment"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> AttachmentTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(AttachmentTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_attachment_type_dict.py b/foundry/v2/core/models/_attachment_type_dict.py similarity index 100% rename from foundry/v1/models/_attachment_type_dict.py rename to foundry/v2/core/models/_attachment_type_dict.py diff --git a/foundry/v2/core/models/_boolean_type.py b/foundry/v2/core/models/_boolean_type.py new file mode 100644 index 00000000..5f1ac50f --- /dev/null +++ b/foundry/v2/core/models/_boolean_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._boolean_type_dict import BooleanTypeDict + + +class BooleanType(BaseModel): + """BooleanType""" + + type: Literal["boolean"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> BooleanTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(BooleanTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_boolean_type_dict.py b/foundry/v2/core/models/_boolean_type_dict.py similarity index 100% rename from foundry/v2/models/_boolean_type_dict.py rename to foundry/v2/core/models/_boolean_type_dict.py diff --git a/foundry/v2/core/models/_byte_type.py b/foundry/v2/core/models/_byte_type.py new file mode 100644 index 00000000..69149b81 --- /dev/null +++ b/foundry/v2/core/models/_byte_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._byte_type_dict import ByteTypeDict + + +class ByteType(BaseModel): + """ByteType""" + + type: Literal["byte"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ByteTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ByteTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_byte_type_dict.py b/foundry/v2/core/models/_byte_type_dict.py similarity index 100% rename from foundry/v2/models/_byte_type_dict.py rename to foundry/v2/core/models/_byte_type_dict.py diff --git a/foundry/v1/models/_content_length.py b/foundry/v2/core/models/_content_length.py similarity index 100% rename from foundry/v1/models/_content_length.py rename to foundry/v2/core/models/_content_length.py diff --git a/foundry/v1/models/_content_type.py b/foundry/v2/core/models/_content_type.py similarity index 100% rename from foundry/v1/models/_content_type.py rename to foundry/v2/core/models/_content_type.py diff --git a/foundry/v2/models/_created_by.py b/foundry/v2/core/models/_created_by.py similarity index 89% rename from foundry/v2/models/_created_by.py rename to foundry/v2/core/models/_created_by.py index 5842cf44..f20d2ef0 100644 --- a/foundry/v2/models/_created_by.py +++ b/foundry/v2/core/models/_created_by.py @@ -15,7 +15,7 @@ from __future__ import annotations -from foundry.v2.models._user_id import UserId +from foundry.v2.core.models._principal_id import PrincipalId -CreatedBy = UserId +CreatedBy = PrincipalId """The Foundry user who created this resource""" diff --git a/foundry/v2/models/_created_time.py b/foundry/v2/core/models/_created_time.py similarity index 100% rename from foundry/v2/models/_created_time.py rename to foundry/v2/core/models/_created_time.py diff --git a/foundry/v2/core/models/_date_type.py b/foundry/v2/core/models/_date_type.py new file mode 100644 index 00000000..c2c4a4fc --- /dev/null +++ b/foundry/v2/core/models/_date_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._date_type_dict import DateTypeDict + + +class DateType(BaseModel): + """DateType""" + + type: Literal["date"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> DateTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(DateTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_date_type_dict.py b/foundry/v2/core/models/_date_type_dict.py similarity index 100% rename from foundry/v2/models/_date_type_dict.py rename to foundry/v2/core/models/_date_type_dict.py diff --git a/foundry/v2/core/models/_decimal_type.py b/foundry/v2/core/models/_decimal_type.py new file mode 100644 index 00000000..e7cf2b73 --- /dev/null +++ b/foundry/v2/core/models/_decimal_type.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import StrictInt + +from foundry.v2.core.models._decimal_type_dict import DecimalTypeDict + + +class DecimalType(BaseModel): + """DecimalType""" + + precision: Optional[StrictInt] = None + + scale: Optional[StrictInt] = None + + type: Literal["decimal"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> DecimalTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(DecimalTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_decimal_type_dict.py b/foundry/v2/core/models/_decimal_type_dict.py similarity index 100% rename from foundry/v2/models/_decimal_type_dict.py rename to foundry/v2/core/models/_decimal_type_dict.py diff --git a/foundry/v2/models/_display_name.py b/foundry/v2/core/models/_display_name.py similarity index 100% rename from foundry/v2/models/_display_name.py rename to foundry/v2/core/models/_display_name.py diff --git a/foundry/v2/core/models/_distance.py b/foundry/v2/core/models/_distance.py new file mode 100644 index 00000000..60c38a68 --- /dev/null +++ b/foundry/v2/core/models/_distance.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel +from pydantic import StrictFloat + +from foundry.v2.core.models._distance_dict import DistanceDict +from foundry.v2.core.models._distance_unit import DistanceUnit + + +class Distance(BaseModel): + """A measurement of distance.""" + + value: StrictFloat + + unit: DistanceUnit + + model_config = {"extra": "allow"} + + def to_dict(self) -> DistanceDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(DistanceDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/core/models/_distance_dict.py b/foundry/v2/core/models/_distance_dict.py new file mode 100644 index 00000000..372c3433 --- /dev/null +++ b/foundry/v2/core/models/_distance_dict.py @@ -0,0 +1,31 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictFloat +from typing_extensions import TypedDict + +from foundry.v2.core.models._distance_unit import DistanceUnit + + +class DistanceDict(TypedDict): + """A measurement of distance.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: StrictFloat + + unit: DistanceUnit diff --git a/foundry/v1/models/_distance_unit.py b/foundry/v2/core/models/_distance_unit.py similarity index 100% rename from foundry/v1/models/_distance_unit.py rename to foundry/v2/core/models/_distance_unit.py diff --git a/foundry/v2/core/models/_double_type.py b/foundry/v2/core/models/_double_type.py new file mode 100644 index 00000000..0c6b0044 --- /dev/null +++ b/foundry/v2/core/models/_double_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._double_type_dict import DoubleTypeDict + + +class DoubleType(BaseModel): + """DoubleType""" + + type: Literal["double"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> DoubleTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(DoubleTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_double_type_dict.py b/foundry/v2/core/models/_double_type_dict.py similarity index 100% rename from foundry/v2/models/_double_type_dict.py rename to foundry/v2/core/models/_double_type_dict.py diff --git a/foundry/v2/models/_duration.py b/foundry/v2/core/models/_duration.py similarity index 90% rename from foundry/v2/models/_duration.py rename to foundry/v2/core/models/_duration.py index 2b55cbd5..adb8edc9 100644 --- a/foundry/v2/models/_duration.py +++ b/foundry/v2/core/models/_duration.py @@ -20,8 +20,8 @@ from pydantic import BaseModel from pydantic import StrictInt -from foundry.v2.models._duration_dict import DurationDict -from foundry.v2.models._time_unit import TimeUnit +from foundry.v2.core.models._duration_dict import DurationDict +from foundry.v2.core.models._time_unit import TimeUnit class Duration(BaseModel): diff --git a/foundry/v2/models/_duration_dict.py b/foundry/v2/core/models/_duration_dict.py similarity index 94% rename from foundry/v2/models/_duration_dict.py rename to foundry/v2/core/models/_duration_dict.py index 607026ff..babedf78 100644 --- a/foundry/v2/models/_duration_dict.py +++ b/foundry/v2/core/models/_duration_dict.py @@ -18,7 +18,7 @@ from pydantic import StrictInt from typing_extensions import TypedDict -from foundry.v2.models._time_unit import TimeUnit +from foundry.v2.core.models._time_unit import TimeUnit class DurationDict(TypedDict): diff --git a/foundry/v2/models/_file_path.py b/foundry/v2/core/models/_file_path.py similarity index 100% rename from foundry/v2/models/_file_path.py rename to foundry/v2/core/models/_file_path.py diff --git a/foundry/v1/models/_filename.py b/foundry/v2/core/models/_filename.py similarity index 100% rename from foundry/v1/models/_filename.py rename to foundry/v2/core/models/_filename.py diff --git a/foundry/v2/core/models/_float_type.py b/foundry/v2/core/models/_float_type.py new file mode 100644 index 00000000..add6ecf3 --- /dev/null +++ b/foundry/v2/core/models/_float_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._float_type_dict import FloatTypeDict + + +class FloatType(BaseModel): + """FloatType""" + + type: Literal["float"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> FloatTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(FloatTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_float_type_dict.py b/foundry/v2/core/models/_float_type_dict.py similarity index 100% rename from foundry/v2/models/_float_type_dict.py rename to foundry/v2/core/models/_float_type_dict.py diff --git a/foundry/v2/core/models/_geo_point_type.py b/foundry/v2/core/models/_geo_point_type.py new file mode 100644 index 00000000..c89bc745 --- /dev/null +++ b/foundry/v2/core/models/_geo_point_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._geo_point_type_dict import GeoPointTypeDict + + +class GeoPointType(BaseModel): + """GeoPointType""" + + type: Literal["geopoint"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> GeoPointTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(GeoPointTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_geo_point_type_dict.py b/foundry/v2/core/models/_geo_point_type_dict.py similarity index 100% rename from foundry/v1/models/_geo_point_type_dict.py rename to foundry/v2/core/models/_geo_point_type_dict.py diff --git a/foundry/v2/core/models/_geo_shape_type.py b/foundry/v2/core/models/_geo_shape_type.py new file mode 100644 index 00000000..565990d9 --- /dev/null +++ b/foundry/v2/core/models/_geo_shape_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._geo_shape_type_dict import GeoShapeTypeDict + + +class GeoShapeType(BaseModel): + """GeoShapeType""" + + type: Literal["geoshape"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> GeoShapeTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(GeoShapeTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_geo_shape_type_dict.py b/foundry/v2/core/models/_geo_shape_type_dict.py similarity index 100% rename from foundry/v1/models/_geo_shape_type_dict.py rename to foundry/v2/core/models/_geo_shape_type_dict.py diff --git a/foundry/v2/core/models/_integer_type.py b/foundry/v2/core/models/_integer_type.py new file mode 100644 index 00000000..a2b886bf --- /dev/null +++ b/foundry/v2/core/models/_integer_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._integer_type_dict import IntegerTypeDict + + +class IntegerType(BaseModel): + """IntegerType""" + + type: Literal["integer"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> IntegerTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(IntegerTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_integer_type_dict.py b/foundry/v2/core/models/_integer_type_dict.py similarity index 100% rename from foundry/v2/models/_integer_type_dict.py rename to foundry/v2/core/models/_integer_type_dict.py diff --git a/foundry/v2/core/models/_long_type.py b/foundry/v2/core/models/_long_type.py new file mode 100644 index 00000000..ad8a0a88 --- /dev/null +++ b/foundry/v2/core/models/_long_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._long_type_dict import LongTypeDict + + +class LongType(BaseModel): + """LongType""" + + type: Literal["long"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> LongTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(LongTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_long_type_dict.py b/foundry/v2/core/models/_long_type_dict.py similarity index 100% rename from foundry/v2/models/_long_type_dict.py rename to foundry/v2/core/models/_long_type_dict.py diff --git a/foundry/v2/core/models/_marking_id.py b/foundry/v2/core/models/_marking_id.py new file mode 100644 index 00000000..355f11db --- /dev/null +++ b/foundry/v2/core/models/_marking_id.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry._core.utils import UUID + +MarkingId = UUID +"""The ID of a security marking.""" diff --git a/foundry/v2/core/models/_marking_type.py b/foundry/v2/core/models/_marking_type.py new file mode 100644 index 00000000..d682dea4 --- /dev/null +++ b/foundry/v2/core/models/_marking_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._marking_type_dict import MarkingTypeDict + + +class MarkingType(BaseModel): + """MarkingType""" + + type: Literal["marking"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> MarkingTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(MarkingTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_marking_type_dict.py b/foundry/v2/core/models/_marking_type_dict.py similarity index 100% rename from foundry/v2/models/_marking_type_dict.py rename to foundry/v2/core/models/_marking_type_dict.py diff --git a/foundry/v2/models/_media_set_rid.py b/foundry/v2/core/models/_media_set_rid.py similarity index 100% rename from foundry/v2/models/_media_set_rid.py rename to foundry/v2/core/models/_media_set_rid.py diff --git a/foundry/v1/models/_media_type.py b/foundry/v2/core/models/_media_type.py similarity index 100% rename from foundry/v1/models/_media_type.py rename to foundry/v2/core/models/_media_type.py diff --git a/foundry/v2/core/models/_null_type.py b/foundry/v2/core/models/_null_type.py new file mode 100644 index 00000000..db0bb1fa --- /dev/null +++ b/foundry/v2/core/models/_null_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._null_type_dict import NullTypeDict + + +class NullType(BaseModel): + """NullType""" + + type: Literal["null"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> NullTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(NullTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_null_type_dict.py b/foundry/v2/core/models/_null_type_dict.py similarity index 100% rename from foundry/v1/models/_null_type_dict.py rename to foundry/v2/core/models/_null_type_dict.py diff --git a/foundry/v2/models/_organization_rid.py b/foundry/v2/core/models/_organization_rid.py similarity index 100% rename from foundry/v2/models/_organization_rid.py rename to foundry/v2/core/models/_organization_rid.py diff --git a/foundry/v2/models/_page_size.py b/foundry/v2/core/models/_page_size.py similarity index 100% rename from foundry/v2/models/_page_size.py rename to foundry/v2/core/models/_page_size.py diff --git a/foundry/v2/models/_page_token.py b/foundry/v2/core/models/_page_token.py similarity index 100% rename from foundry/v2/models/_page_token.py rename to foundry/v2/core/models/_page_token.py diff --git a/foundry/v2/models/_preview_mode.py b/foundry/v2/core/models/_preview_mode.py similarity index 100% rename from foundry/v2/models/_preview_mode.py rename to foundry/v2/core/models/_preview_mode.py diff --git a/foundry/v2/models/_principal_id.py b/foundry/v2/core/models/_principal_id.py similarity index 100% rename from foundry/v2/models/_principal_id.py rename to foundry/v2/core/models/_principal_id.py diff --git a/foundry/v2/models/_principal_type.py b/foundry/v2/core/models/_principal_type.py similarity index 100% rename from foundry/v2/models/_principal_type.py rename to foundry/v2/core/models/_principal_type.py diff --git a/foundry/v2/models/_realm.py b/foundry/v2/core/models/_realm.py similarity index 100% rename from foundry/v2/models/_realm.py rename to foundry/v2/core/models/_realm.py diff --git a/foundry/v2/models/_release_status.py b/foundry/v2/core/models/_release_status.py similarity index 100% rename from foundry/v2/models/_release_status.py rename to foundry/v2/core/models/_release_status.py diff --git a/foundry/v2/core/models/_short_type.py b/foundry/v2/core/models/_short_type.py new file mode 100644 index 00000000..f1c08bd4 --- /dev/null +++ b/foundry/v2/core/models/_short_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._short_type_dict import ShortTypeDict + + +class ShortType(BaseModel): + """ShortType""" + + type: Literal["short"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ShortTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ShortTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_short_type_dict.py b/foundry/v2/core/models/_short_type_dict.py similarity index 100% rename from foundry/v2/models/_short_type_dict.py rename to foundry/v2/core/models/_short_type_dict.py diff --git a/foundry/v1/models/_size_bytes.py b/foundry/v2/core/models/_size_bytes.py similarity index 100% rename from foundry/v1/models/_size_bytes.py rename to foundry/v2/core/models/_size_bytes.py diff --git a/foundry/v2/core/models/_string_type.py b/foundry/v2/core/models/_string_type.py new file mode 100644 index 00000000..a60fce44 --- /dev/null +++ b/foundry/v2/core/models/_string_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._string_type_dict import StringTypeDict + + +class StringType(BaseModel): + """StringType""" + + type: Literal["string"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> StringTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(StringTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_string_type_dict.py b/foundry/v2/core/models/_string_type_dict.py similarity index 100% rename from foundry/v2/models/_string_type_dict.py rename to foundry/v2/core/models/_string_type_dict.py diff --git a/foundry/v2/models/_struct_field_name.py b/foundry/v2/core/models/_struct_field_name.py similarity index 100% rename from foundry/v2/models/_struct_field_name.py rename to foundry/v2/core/models/_struct_field_name.py diff --git a/foundry/v2/core/models/_time_series_item_type.py b/foundry/v2/core/models/_time_series_item_type.py new file mode 100644 index 00000000..281db785 --- /dev/null +++ b/foundry/v2/core/models/_time_series_item_type.py @@ -0,0 +1,27 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.core.models._double_type import DoubleType +from foundry.v2.core.models._string_type import StringType + +TimeSeriesItemType = Annotated[Union[StringType, DoubleType], Field(discriminator="type")] +"""A union of the types supported by time series properties.""" diff --git a/foundry/v2/core/models/_time_series_item_type_dict.py b/foundry/v2/core/models/_time_series_item_type_dict.py new file mode 100644 index 00000000..232e0dcc --- /dev/null +++ b/foundry/v2/core/models/_time_series_item_type_dict.py @@ -0,0 +1,29 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.core.models._double_type_dict import DoubleTypeDict +from foundry.v2.core.models._string_type_dict import StringTypeDict + +TimeSeriesItemTypeDict = Annotated[ + Union[StringTypeDict, DoubleTypeDict], Field(discriminator="type") +] +"""A union of the types supported by time series properties.""" diff --git a/foundry/v2/models/_time_unit.py b/foundry/v2/core/models/_time_unit.py similarity index 100% rename from foundry/v2/models/_time_unit.py rename to foundry/v2/core/models/_time_unit.py diff --git a/foundry/v2/core/models/_timeseries_type.py b/foundry/v2/core/models/_timeseries_type.py new file mode 100644 index 00000000..06f42792 --- /dev/null +++ b/foundry/v2/core/models/_timeseries_type.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._time_series_item_type import TimeSeriesItemType +from foundry.v2.core.models._timeseries_type_dict import TimeseriesTypeDict + + +class TimeseriesType(BaseModel): + """TimeseriesType""" + + item_type: TimeSeriesItemType = Field(alias="itemType") + + type: Literal["timeseries"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> TimeseriesTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(TimeseriesTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/core/models/_timeseries_type_dict.py b/foundry/v2/core/models/_timeseries_type_dict.py new file mode 100644 index 00000000..d2d48240 --- /dev/null +++ b/foundry/v2/core/models/_timeseries_type_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.core.models._time_series_item_type_dict import TimeSeriesItemTypeDict + + +class TimeseriesTypeDict(TypedDict): + """TimeseriesType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + itemType: TimeSeriesItemTypeDict + + type: Literal["timeseries"] diff --git a/foundry/v2/core/models/_timestamp_type.py b/foundry/v2/core/models/_timestamp_type.py new file mode 100644 index 00000000..16c1dd6f --- /dev/null +++ b/foundry/v2/core/models/_timestamp_type.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._timestamp_type_dict import TimestampTypeDict + + +class TimestampType(BaseModel): + """TimestampType""" + + type: Literal["timestamp"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> TimestampTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(TimestampTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_timestamp_type_dict.py b/foundry/v2/core/models/_timestamp_type_dict.py similarity index 100% rename from foundry/v2/models/_timestamp_type_dict.py rename to foundry/v2/core/models/_timestamp_type_dict.py diff --git a/foundry/v2/models/_total_count.py b/foundry/v2/core/models/_total_count.py similarity index 100% rename from foundry/v2/models/_total_count.py rename to foundry/v2/core/models/_total_count.py diff --git a/foundry/v2/core/models/_unsupported_type.py b/foundry/v2/core/models/_unsupported_type.py new file mode 100644 index 00000000..77b47d5f --- /dev/null +++ b/foundry/v2/core/models/_unsupported_type.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.core.models._unsupported_type_dict import UnsupportedTypeDict + + +class UnsupportedType(BaseModel): + """UnsupportedType""" + + unsupported_type: StrictStr = Field(alias="unsupportedType") + + type: Literal["unsupported"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> UnsupportedTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(UnsupportedTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_unsupported_type_dict.py b/foundry/v2/core/models/_unsupported_type_dict.py similarity index 100% rename from foundry/v2/models/_unsupported_type_dict.py rename to foundry/v2/core/models/_unsupported_type_dict.py diff --git a/foundry/v2/models/_updated_by.py b/foundry/v2/core/models/_updated_by.py similarity index 93% rename from foundry/v2/models/_updated_by.py rename to foundry/v2/core/models/_updated_by.py index 08b7c31d..55d87e89 100644 --- a/foundry/v2/models/_updated_by.py +++ b/foundry/v2/core/models/_updated_by.py @@ -15,7 +15,7 @@ from __future__ import annotations -from foundry.v2.models._user_id import UserId +from foundry.v2.core.models._user_id import UserId UpdatedBy = UserId """The Foundry user who last updated this resource""" diff --git a/foundry/v2/models/_updated_time.py b/foundry/v2/core/models/_updated_time.py similarity index 100% rename from foundry/v2/models/_updated_time.py rename to foundry/v2/core/models/_updated_time.py diff --git a/foundry/v1/models/_user_id.py b/foundry/v2/core/models/_user_id.py similarity index 100% rename from foundry/v1/models/_user_id.py rename to foundry/v2/core/models/_user_id.py diff --git a/foundry/v2/datasets/branch.py b/foundry/v2/datasets/branch.py new file mode 100644 index 00000000..bc356427 --- /dev/null +++ b/foundry/v2/datasets/branch.py @@ -0,0 +1,289 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.datasets.models._branch import Branch +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._dataset_rid import DatasetRid +from foundry.v2.datasets.models._list_branches_response import ListBranchesResponse +from foundry.v2.datasets.models._transaction_rid import TransactionRid + + +class BranchClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def create( + self, + dataset_rid: DatasetRid, + *, + name: BranchName, + preview: Optional[PreviewMode] = None, + transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Branch: + """ + Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param name: + :type name: BranchName + :param preview: preview + :type preview: Optional[PreviewMode] + :param transaction_rid: + :type transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Branch + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/datasets/{datasetRid}/branches", + query_params={ + "preview": preview, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "transactionRid": transaction_rid, + "name": name, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "transactionRid": Optional[TransactionRid], + "name": BranchName, + }, + ), + response_type=Branch, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def delete( + self, + dataset_rid: DatasetRid, + branch_name: BranchName, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + Deletes the Branch with the given BranchName. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param branch_name: branchName + :type branch_name: BranchName + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="DELETE", + resource_path="/v2/datasets/{datasetRid}/branches/{branchName}", + query_params={ + "preview": preview, + }, + path_params={ + "datasetRid": dataset_rid, + "branchName": branch_name, + }, + header_params={}, + body=None, + body_type=None, + response_type=None, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + dataset_rid: DatasetRid, + branch_name: BranchName, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Branch: + """ + Get a Branch of a Dataset. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param branch_name: branchName + :type branch_name: BranchName + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Branch + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/datasets/{datasetRid}/branches/{branchName}", + query_params={ + "preview": preview, + }, + path_params={ + "datasetRid": dataset_rid, + "branchName": branch_name, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Branch, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + dataset_rid: DatasetRid, + *, + page_size: Optional[PageSize] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[Branch]: + """ + Lists the Branches of a Dataset. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[Branch] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/datasets/{datasetRid}/branches", + query_params={ + "pageSize": page_size, + "preview": preview, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListBranchesResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + dataset_rid: DatasetRid, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListBranchesResponse: + """ + Lists the Branches of a Dataset. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListBranchesResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/datasets/{datasetRid}/branches", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + "preview": preview, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListBranchesResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/datasets/client.py b/foundry/v2/datasets/client.py new file mode 100644 index 00000000..0b145700 --- /dev/null +++ b/foundry/v2/datasets/client.py @@ -0,0 +1,24 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry._core import Auth +from foundry.v2.datasets.dataset import DatasetClient + + +class DatasetsClient: + def __init__(self, auth: Auth, hostname: str): + self.Dataset = DatasetClient(auth=auth, hostname=hostname) diff --git a/foundry/v2/datasets/dataset.py b/foundry/v2/datasets/dataset.py new file mode 100644 index 00000000..aeb35d72 --- /dev/null +++ b/foundry/v2/datasets/dataset.py @@ -0,0 +1,215 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import List +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import StrictStr +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.datasets.branch import BranchClient +from foundry.v2.datasets.file import FileClient +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._dataset import Dataset +from foundry.v2.datasets.models._dataset_name import DatasetName +from foundry.v2.datasets.models._dataset_rid import DatasetRid +from foundry.v2.datasets.models._table_export_format import TableExportFormat +from foundry.v2.datasets.models._transaction_rid import TransactionRid +from foundry.v2.datasets.transaction import TransactionClient +from foundry.v2.filesystem.models._folder_rid import FolderRid + + +class DatasetClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + self.Branch = BranchClient(auth=auth, hostname=hostname) + self.Transaction = TransactionClient(auth=auth, hostname=hostname) + self.File = FileClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def create( + self, + *, + name: DatasetName, + parent_folder_rid: FolderRid, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Dataset: + """ + Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset. + + :param name: + :type name: DatasetName + :param parent_folder_rid: + :type parent_folder_rid: FolderRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Dataset + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/datasets", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "parentFolderRid": parent_folder_rid, + "name": name, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "parentFolderRid": FolderRid, + "name": DatasetName, + }, + ), + response_type=Dataset, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + dataset_rid: DatasetRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Dataset: + """ + Get the Dataset with the specified rid. + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Dataset + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/datasets/{datasetRid}", + query_params={ + "preview": preview, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Dataset, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def read_table( + self, + dataset_rid: DatasetRid, + *, + format: TableExportFormat, + branch_name: Optional[BranchName] = None, + columns: Optional[List[StrictStr]] = None, + end_transaction_rid: Optional[TransactionRid] = None, + preview: Optional[PreviewMode] = None, + row_limit: Optional[StrictInt] = None, + start_transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> bytes: + """ + Gets the content of a dataset as a table in the specified format. + + This endpoint currently does not support views (Virtual datasets composed of other datasets). + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param format: format + :type format: TableExportFormat + :param branch_name: branchName + :type branch_name: Optional[BranchName] + :param columns: columns + :type columns: Optional[List[StrictStr]] + :param end_transaction_rid: endTransactionRid + :type end_transaction_rid: Optional[TransactionRid] + :param preview: preview + :type preview: Optional[PreviewMode] + :param row_limit: rowLimit + :type row_limit: Optional[StrictInt] + :param start_transaction_rid: startTransactionRid + :type start_transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: bytes + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/datasets/{datasetRid}/readTable", + query_params={ + "format": format, + "branchName": branch_name, + "columns": columns, + "endTransactionRid": end_transaction_rid, + "preview": preview, + "rowLimit": row_limit, + "startTransactionRid": start_transaction_rid, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Accept": "application/octet-stream", + }, + body=None, + body_type=None, + response_type=bytes, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/datasets/file.py b/foundry/v2/datasets/file.py new file mode 100644 index 00000000..b043a073 --- /dev/null +++ b/foundry/v2/datasets/file.py @@ -0,0 +1,482 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.core.models._file_path import FilePath +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._dataset_rid import DatasetRid +from foundry.v2.datasets.models._file import File +from foundry.v2.datasets.models._list_files_response import ListFilesResponse +from foundry.v2.datasets.models._transaction_rid import TransactionRid +from foundry.v2.datasets.models._transaction_type import TransactionType + + +class FileClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def content( + self, + dataset_rid: DatasetRid, + file_path: FilePath, + *, + branch_name: Optional[BranchName] = None, + end_transaction_rid: Optional[TransactionRid] = None, + preview: Optional[PreviewMode] = None, + start_transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> bytes: + """ + Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest + view of the default branch - `master` for most enrollments. + #### Advanced Usage + See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + To **get a file's content from a specific Branch** specify the Branch's name as `branchName`. This will + retrieve the content for the most recent version of the file since the latest snapshot transaction, or the + earliest ancestor transaction of the branch if there are no snapshot transactions. + To **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier + as `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest + snapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions. + To **get a file's content from the resolved view of a range of transactions** specify the the start transaction's + resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. + This will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the + `endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior + is undefined when the start and end transactions do not belong to the same root-to-leaf path. + To **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the + `startTransactionRid` and `endTransactionRid`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param file_path: filePath + :type file_path: FilePath + :param branch_name: branchName + :type branch_name: Optional[BranchName] + :param end_transaction_rid: endTransactionRid + :type end_transaction_rid: Optional[TransactionRid] + :param preview: preview + :type preview: Optional[PreviewMode] + :param start_transaction_rid: startTransactionRid + :type start_transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: bytes + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/datasets/{datasetRid}/files/{filePath}/content", + query_params={ + "branchName": branch_name, + "endTransactionRid": end_transaction_rid, + "preview": preview, + "startTransactionRid": start_transaction_rid, + }, + path_params={ + "datasetRid": dataset_rid, + "filePath": file_path, + }, + header_params={ + "Accept": "application/octet-stream", + }, + body=None, + body_type=None, + response_type=bytes, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def delete( + self, + dataset_rid: DatasetRid, + file_path: FilePath, + *, + branch_name: Optional[BranchName] = None, + preview: Optional[PreviewMode] = None, + transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default + branch - `master` for most enrollments. The file will still be visible on historical views. + #### Advanced Usage + See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + To **delete a File from a specific Branch** specify the Branch's name as `branchName`. A new delete Transaction + will be created and committed on this branch. + To **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier + as `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a + single transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to + open a transaction. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param file_path: filePath + :type file_path: FilePath + :param branch_name: branchName + :type branch_name: Optional[BranchName] + :param preview: preview + :type preview: Optional[PreviewMode] + :param transaction_rid: transactionRid + :type transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="DELETE", + resource_path="/v2/datasets/{datasetRid}/files/{filePath}", + query_params={ + "branchName": branch_name, + "preview": preview, + "transactionRid": transaction_rid, + }, + path_params={ + "datasetRid": dataset_rid, + "filePath": file_path, + }, + header_params={}, + body=None, + body_type=None, + response_type=None, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + dataset_rid: DatasetRid, + file_path: FilePath, + *, + branch_name: Optional[BranchName] = None, + end_transaction_rid: Optional[TransactionRid] = None, + preview: Optional[PreviewMode] = None, + start_transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> File: + """ + Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest + view of the default branch - `master` for most enrollments. + #### Advanced Usage + See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + To **get a file's metadata from a specific Branch** specify the Branch's name as `branchName`. This will + retrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest + ancestor transaction of the branch if there are no snapshot transactions. + To **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier + as `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot + transaction, or the earliest ancestor transaction if there are no snapshot transactions. + To **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's + resource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. + This will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the + `endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path. + To **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the + `startTransactionRid` and `endTransactionRid`. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param file_path: filePath + :type file_path: FilePath + :param branch_name: branchName + :type branch_name: Optional[BranchName] + :param end_transaction_rid: endTransactionRid + :type end_transaction_rid: Optional[TransactionRid] + :param preview: preview + :type preview: Optional[PreviewMode] + :param start_transaction_rid: startTransactionRid + :type start_transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: File + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/datasets/{datasetRid}/files/{filePath}", + query_params={ + "branchName": branch_name, + "endTransactionRid": end_transaction_rid, + "preview": preview, + "startTransactionRid": start_transaction_rid, + }, + path_params={ + "datasetRid": dataset_rid, + "filePath": file_path, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=File, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + dataset_rid: DatasetRid, + *, + branch_name: Optional[BranchName] = None, + end_transaction_rid: Optional[TransactionRid] = None, + page_size: Optional[PageSize] = None, + preview: Optional[PreviewMode] = None, + start_transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[File]: + """ + Lists Files contained in a Dataset. By default files are listed on the latest view of the default + branch - `master` for most enrollments. + #### Advanced Usage + See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most + recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the + branch if there are no snapshot transactions. + To **list files on the resolved view of a transaction** specify the Transaction's resource identifier + as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot + transaction, or the earliest ancestor transaction if there are no snapshot transactions. + To **list files on the resolved view of a range of transactions** specify the the start transaction's resource + identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This + will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. + Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when + the start and end transactions do not belong to the same root-to-leaf path. + To **list files on a specific transaction** specify the Transaction's resource identifier as both the + `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that + Transaction. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param branch_name: branchName + :type branch_name: Optional[BranchName] + :param end_transaction_rid: endTransactionRid + :type end_transaction_rid: Optional[TransactionRid] + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param preview: preview + :type preview: Optional[PreviewMode] + :param start_transaction_rid: startTransactionRid + :type start_transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[File] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/datasets/{datasetRid}/files", + query_params={ + "branchName": branch_name, + "endTransactionRid": end_transaction_rid, + "pageSize": page_size, + "preview": preview, + "startTransactionRid": start_transaction_rid, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListFilesResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + dataset_rid: DatasetRid, + *, + branch_name: Optional[BranchName] = None, + end_transaction_rid: Optional[TransactionRid] = None, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + preview: Optional[PreviewMode] = None, + start_transaction_rid: Optional[TransactionRid] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListFilesResponse: + """ + Lists Files contained in a Dataset. By default files are listed on the latest view of the default + branch - `master` for most enrollments. + #### Advanced Usage + See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + To **list files on a specific Branch** specify the Branch's name as `branchName`. This will include the most + recent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the + branch if there are no snapshot transactions. + To **list files on the resolved view of a transaction** specify the Transaction's resource identifier + as `endTransactionRid`. This will include the most recent version of all files since the latest snapshot + transaction, or the earliest ancestor transaction if there are no snapshot transactions. + To **list files on the resolved view of a range of transactions** specify the the start transaction's resource + identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This + will include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`. + Note that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when + the start and end transactions do not belong to the same root-to-leaf path. + To **list files on a specific transaction** specify the Transaction's resource identifier as both the + `startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that + Transaction. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param branch_name: branchName + :type branch_name: Optional[BranchName] + :param end_transaction_rid: endTransactionRid + :type end_transaction_rid: Optional[TransactionRid] + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param preview: preview + :type preview: Optional[PreviewMode] + :param start_transaction_rid: startTransactionRid + :type start_transaction_rid: Optional[TransactionRid] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListFilesResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/datasets/{datasetRid}/files", + query_params={ + "branchName": branch_name, + "endTransactionRid": end_transaction_rid, + "pageSize": page_size, + "pageToken": page_token, + "preview": preview, + "startTransactionRid": start_transaction_rid, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListFilesResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def upload( + self, + dataset_rid: DatasetRid, + file_path: FilePath, + body: bytes, + *, + branch_name: Optional[BranchName] = None, + preview: Optional[PreviewMode] = None, + transaction_rid: Optional[TransactionRid] = None, + transaction_type: Optional[TransactionType] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> File: + """ + Uploads a File to an existing Dataset. + The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. + By default the file is uploaded to a new transaction on the default branch - `master` for most enrollments. + If the file already exists only the most recent version will be visible in the updated view. + #### Advanced Usage + See [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. + To **upload a file to a specific Branch** specify the Branch's name as `branchName`. A new transaction will + be created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this + default specify `transactionType` in addition to `branchName`. + See [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch. + To **upload a file on a manually opened transaction** specify the Transaction's resource identifier as + `transactionRid`. This is useful for uploading multiple files in a single transaction. + See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param file_path: filePath + :type file_path: FilePath + :param body: Body of the request + :type body: bytes + :param branch_name: branchName + :type branch_name: Optional[BranchName] + :param preview: preview + :type preview: Optional[PreviewMode] + :param transaction_rid: transactionRid + :type transaction_rid: Optional[TransactionRid] + :param transaction_type: transactionType + :type transaction_type: Optional[TransactionType] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: File + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/datasets/{datasetRid}/files/{filePath}/upload", + query_params={ + "branchName": branch_name, + "preview": preview, + "transactionRid": transaction_rid, + "transactionType": transaction_type, + }, + path_params={ + "datasetRid": dataset_rid, + "filePath": file_path, + }, + header_params={ + "Content-Type": "application/octet-stream", + "Accept": "application/json", + }, + body=body, + body_type=bytes, + response_type=File, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/datasets/models/__init__.py b/foundry/v2/datasets/models/__init__.py new file mode 100644 index 00000000..43c15053 --- /dev/null +++ b/foundry/v2/datasets/models/__init__.py @@ -0,0 +1,60 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from foundry.v2.datasets.models._branch import Branch +from foundry.v2.datasets.models._branch_dict import BranchDict +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._dataset import Dataset +from foundry.v2.datasets.models._dataset_dict import DatasetDict +from foundry.v2.datasets.models._dataset_name import DatasetName +from foundry.v2.datasets.models._dataset_rid import DatasetRid +from foundry.v2.datasets.models._file import File +from foundry.v2.datasets.models._file_dict import FileDict +from foundry.v2.datasets.models._file_updated_time import FileUpdatedTime +from foundry.v2.datasets.models._list_branches_response import ListBranchesResponse +from foundry.v2.datasets.models._list_branches_response_dict import ListBranchesResponseDict # NOQA +from foundry.v2.datasets.models._list_files_response import ListFilesResponse +from foundry.v2.datasets.models._list_files_response_dict import ListFilesResponseDict +from foundry.v2.datasets.models._table_export_format import TableExportFormat +from foundry.v2.datasets.models._transaction import Transaction +from foundry.v2.datasets.models._transaction_created_time import TransactionCreatedTime +from foundry.v2.datasets.models._transaction_dict import TransactionDict +from foundry.v2.datasets.models._transaction_rid import TransactionRid +from foundry.v2.datasets.models._transaction_status import TransactionStatus +from foundry.v2.datasets.models._transaction_type import TransactionType + +__all__ = [ + "Branch", + "BranchDict", + "BranchName", + "Dataset", + "DatasetDict", + "DatasetName", + "DatasetRid", + "File", + "FileDict", + "FileUpdatedTime", + "ListBranchesResponse", + "ListBranchesResponseDict", + "ListFilesResponse", + "ListFilesResponseDict", + "TableExportFormat", + "Transaction", + "TransactionCreatedTime", + "TransactionDict", + "TransactionRid", + "TransactionStatus", + "TransactionType", +] diff --git a/foundry/v2/datasets/models/_branch.py b/foundry/v2/datasets/models/_branch.py new file mode 100644 index 00000000..ab695d45 --- /dev/null +++ b/foundry/v2/datasets/models/_branch.py @@ -0,0 +1,40 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.datasets.models._branch_dict import BranchDict +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._transaction_rid import TransactionRid + + +class Branch(BaseModel): + """Branch""" + + name: BranchName + + transaction_rid: Optional[TransactionRid] = Field(alias="transactionRid", default=None) + + model_config = {"extra": "allow"} + + def to_dict(self) -> BranchDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(BranchDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/datasets/models/_branch_dict.py b/foundry/v2/datasets/models/_branch_dict.py new file mode 100644 index 00000000..66b3a8fe --- /dev/null +++ b/foundry/v2/datasets/models/_branch_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._transaction_rid import TransactionRid + + +class BranchDict(TypedDict): + """Branch""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + name: BranchName + + transactionRid: NotRequired[TransactionRid] diff --git a/foundry/v2/models/_branch_name.py b/foundry/v2/datasets/models/_branch_name.py similarity index 100% rename from foundry/v2/models/_branch_name.py rename to foundry/v2/datasets/models/_branch_name.py diff --git a/foundry/v2/datasets/models/_dataset.py b/foundry/v2/datasets/models/_dataset.py new file mode 100644 index 00000000..80d54c9b --- /dev/null +++ b/foundry/v2/datasets/models/_dataset.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.datasets.models._dataset_dict import DatasetDict +from foundry.v2.datasets.models._dataset_name import DatasetName +from foundry.v2.datasets.models._dataset_rid import DatasetRid +from foundry.v2.filesystem.models._folder_rid import FolderRid + + +class Dataset(BaseModel): + """Dataset""" + + rid: DatasetRid + + name: DatasetName + + parent_folder_rid: FolderRid = Field(alias="parentFolderRid") + + model_config = {"extra": "allow"} + + def to_dict(self) -> DatasetDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(DatasetDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/datasets/models/_dataset_dict.py b/foundry/v2/datasets/models/_dataset_dict.py new file mode 100644 index 00000000..952d5c96 --- /dev/null +++ b/foundry/v2/datasets/models/_dataset_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import TypedDict + +from foundry.v2.datasets.models._dataset_name import DatasetName +from foundry.v2.datasets.models._dataset_rid import DatasetRid +from foundry.v2.filesystem.models._folder_rid import FolderRid + + +class DatasetDict(TypedDict): + """Dataset""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + rid: DatasetRid + + name: DatasetName + + parentFolderRid: FolderRid diff --git a/foundry/v2/models/_dataset_name.py b/foundry/v2/datasets/models/_dataset_name.py similarity index 100% rename from foundry/v2/models/_dataset_name.py rename to foundry/v2/datasets/models/_dataset_name.py diff --git a/foundry/v2/models/_dataset_rid.py b/foundry/v2/datasets/models/_dataset_rid.py similarity index 100% rename from foundry/v2/models/_dataset_rid.py rename to foundry/v2/datasets/models/_dataset_rid.py diff --git a/foundry/v2/datasets/models/_file.py b/foundry/v2/datasets/models/_file.py new file mode 100644 index 00000000..56f29159 --- /dev/null +++ b/foundry/v2/datasets/models/_file.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.core.models._file_path import FilePath +from foundry.v2.datasets.models._file_dict import FileDict +from foundry.v2.datasets.models._file_updated_time import FileUpdatedTime +from foundry.v2.datasets.models._transaction_rid import TransactionRid + + +class File(BaseModel): + """File""" + + path: FilePath + + transaction_rid: TransactionRid = Field(alias="transactionRid") + + size_bytes: Optional[StrictStr] = Field(alias="sizeBytes", default=None) + + updated_time: FileUpdatedTime = Field(alias="updatedTime") + + model_config = {"extra": "allow"} + + def to_dict(self) -> FileDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(FileDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/datasets/models/_file_dict.py b/foundry/v2/datasets/models/_file_dict.py new file mode 100644 index 00000000..dbef6222 --- /dev/null +++ b/foundry/v2/datasets/models/_file_dict.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._file_path import FilePath +from foundry.v2.datasets.models._file_updated_time import FileUpdatedTime +from foundry.v2.datasets.models._transaction_rid import TransactionRid + + +class FileDict(TypedDict): + """File""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + path: FilePath + + transactionRid: TransactionRid + + sizeBytes: NotRequired[StrictStr] + + updatedTime: FileUpdatedTime diff --git a/foundry/v2/models/_file_updated_time.py b/foundry/v2/datasets/models/_file_updated_time.py similarity index 100% rename from foundry/v2/models/_file_updated_time.py rename to foundry/v2/datasets/models/_file_updated_time.py diff --git a/foundry/v2/datasets/models/_list_branches_response.py b/foundry/v2/datasets/models/_list_branches_response.py new file mode 100644 index 00000000..ea4fa771 --- /dev/null +++ b/foundry/v2/datasets/models/_list_branches_response.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.datasets.models._branch import Branch +from foundry.v2.datasets.models._list_branches_response_dict import ListBranchesResponseDict # NOQA + + +class ListBranchesResponse(BaseModel): + """ListBranchesResponse""" + + data: List[Branch] + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListBranchesResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ListBranchesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/datasets/models/_list_branches_response_dict.py b/foundry/v2/datasets/models/_list_branches_response_dict.py new file mode 100644 index 00000000..5ac52fea --- /dev/null +++ b/foundry/v2/datasets/models/_list_branches_response_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.datasets.models._branch_dict import BranchDict + + +class ListBranchesResponseDict(TypedDict): + """ListBranchesResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + data: List[BranchDict] + + nextPageToken: NotRequired[PageToken] diff --git a/foundry/v2/datasets/models/_list_files_response.py b/foundry/v2/datasets/models/_list_files_response.py new file mode 100644 index 00000000..93abc90f --- /dev/null +++ b/foundry/v2/datasets/models/_list_files_response.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.datasets.models._file import File +from foundry.v2.datasets.models._list_files_response_dict import ListFilesResponseDict + + +class ListFilesResponse(BaseModel): + """ListFilesResponse""" + + data: List[File] + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListFilesResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ListFilesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/datasets/models/_list_files_response_dict.py b/foundry/v2/datasets/models/_list_files_response_dict.py new file mode 100644 index 00000000..eeb46788 --- /dev/null +++ b/foundry/v2/datasets/models/_list_files_response_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.datasets.models._file_dict import FileDict + + +class ListFilesResponseDict(TypedDict): + """ListFilesResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + data: List[FileDict] + + nextPageToken: NotRequired[PageToken] diff --git a/foundry/v2/models/_table_export_format.py b/foundry/v2/datasets/models/_table_export_format.py similarity index 100% rename from foundry/v2/models/_table_export_format.py rename to foundry/v2/datasets/models/_table_export_format.py diff --git a/foundry/v2/datasets/models/_transaction.py b/foundry/v2/datasets/models/_transaction.py new file mode 100644 index 00000000..ff7c234e --- /dev/null +++ b/foundry/v2/datasets/models/_transaction.py @@ -0,0 +1,51 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from datetime import datetime +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.datasets.models._transaction_created_time import TransactionCreatedTime +from foundry.v2.datasets.models._transaction_dict import TransactionDict +from foundry.v2.datasets.models._transaction_rid import TransactionRid +from foundry.v2.datasets.models._transaction_status import TransactionStatus +from foundry.v2.datasets.models._transaction_type import TransactionType + + +class Transaction(BaseModel): + """Transaction""" + + rid: TransactionRid + + transaction_type: TransactionType = Field(alias="transactionType") + + status: TransactionStatus + + created_time: TransactionCreatedTime = Field(alias="createdTime") + """The timestamp when the transaction was created, in ISO 8601 timestamp format.""" + + closed_time: Optional[datetime] = Field(alias="closedTime", default=None) + """The timestamp when the transaction was closed, in ISO 8601 timestamp format.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> TransactionDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(TransactionDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_transaction_created_time.py b/foundry/v2/datasets/models/_transaction_created_time.py similarity index 100% rename from foundry/v2/models/_transaction_created_time.py rename to foundry/v2/datasets/models/_transaction_created_time.py diff --git a/foundry/v2/datasets/models/_transaction_dict.py b/foundry/v2/datasets/models/_transaction_dict.py new file mode 100644 index 00000000..eb78550d --- /dev/null +++ b/foundry/v2/datasets/models/_transaction_dict.py @@ -0,0 +1,44 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from datetime import datetime + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.datasets.models._transaction_created_time import TransactionCreatedTime +from foundry.v2.datasets.models._transaction_rid import TransactionRid +from foundry.v2.datasets.models._transaction_status import TransactionStatus +from foundry.v2.datasets.models._transaction_type import TransactionType + + +class TransactionDict(TypedDict): + """Transaction""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + rid: TransactionRid + + transactionType: TransactionType + + status: TransactionStatus + + createdTime: TransactionCreatedTime + """The timestamp when the transaction was created, in ISO 8601 timestamp format.""" + + closedTime: NotRequired[datetime] + """The timestamp when the transaction was closed, in ISO 8601 timestamp format.""" diff --git a/foundry/v2/models/_transaction_rid.py b/foundry/v2/datasets/models/_transaction_rid.py similarity index 100% rename from foundry/v2/models/_transaction_rid.py rename to foundry/v2/datasets/models/_transaction_rid.py diff --git a/foundry/v2/models/_transaction_status.py b/foundry/v2/datasets/models/_transaction_status.py similarity index 100% rename from foundry/v2/models/_transaction_status.py rename to foundry/v2/datasets/models/_transaction_status.py diff --git a/foundry/v2/models/_transaction_type.py b/foundry/v2/datasets/models/_transaction_type.py similarity index 100% rename from foundry/v2/models/_transaction_type.py rename to foundry/v2/datasets/models/_transaction_type.py diff --git a/foundry/v2/datasets/transaction.py b/foundry/v2/datasets/transaction.py new file mode 100644 index 00000000..5e8ba7e0 --- /dev/null +++ b/foundry/v2/datasets/transaction.py @@ -0,0 +1,239 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._dataset_rid import DatasetRid +from foundry.v2.datasets.models._transaction import Transaction +from foundry.v2.datasets.models._transaction_rid import TransactionRid +from foundry.v2.datasets.models._transaction_type import TransactionType + + +class TransactionClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def abort( + self, + dataset_rid: DatasetRid, + transaction_rid: TransactionRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Transaction: + """ + Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is + not updated. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param transaction_rid: transactionRid + :type transaction_rid: TransactionRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Transaction + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/datasets/{datasetRid}/transactions/{transactionRid}/abort", + query_params={ + "preview": preview, + }, + path_params={ + "datasetRid": dataset_rid, + "transactionRid": transaction_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Transaction, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def commit( + self, + dataset_rid: DatasetRid, + transaction_rid: TransactionRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Transaction: + """ + Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is + updated to point to the Transaction. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param transaction_rid: transactionRid + :type transaction_rid: TransactionRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Transaction + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/datasets/{datasetRid}/transactions/{transactionRid}/commit", + query_params={ + "preview": preview, + }, + path_params={ + "datasetRid": dataset_rid, + "transactionRid": transaction_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Transaction, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def create( + self, + dataset_rid: DatasetRid, + *, + transaction_type: TransactionType, + branch_name: Optional[BranchName] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Transaction: + """ + Creates a Transaction on a Branch of a Dataset. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param transaction_type: + :type transaction_type: TransactionType + :param branch_name: branchName + :type branch_name: Optional[BranchName] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Transaction + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/datasets/{datasetRid}/transactions", + query_params={ + "branchName": branch_name, + "preview": preview, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "transactionType": transaction_type, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "transactionType": TransactionType, + }, + ), + response_type=Transaction, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + dataset_rid: DatasetRid, + transaction_rid: TransactionRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Transaction: + """ + Gets a Transaction of a Dataset. + + :param dataset_rid: datasetRid + :type dataset_rid: DatasetRid + :param transaction_rid: transactionRid + :type transaction_rid: TransactionRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Transaction + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/datasets/{datasetRid}/transactions/{transactionRid}", + query_params={ + "preview": preview, + }, + path_params={ + "datasetRid": dataset_rid, + "transactionRid": transaction_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Transaction, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/filesystem/models/__init__.py b/foundry/v2/filesystem/models/__init__.py new file mode 100644 index 00000000..77c7df49 --- /dev/null +++ b/foundry/v2/filesystem/models/__init__.py @@ -0,0 +1,22 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from foundry.v2.filesystem.models._folder_rid import FolderRid +from foundry.v2.filesystem.models._project_rid import ProjectRid + +__all__ = [ + "FolderRid", + "ProjectRid", +] diff --git a/foundry/v2/models/_folder_rid.py b/foundry/v2/filesystem/models/_folder_rid.py similarity index 100% rename from foundry/v2/models/_folder_rid.py rename to foundry/v2/filesystem/models/_folder_rid.py diff --git a/foundry/v2/models/_project_rid.py b/foundry/v2/filesystem/models/_project_rid.py similarity index 100% rename from foundry/v2/models/_project_rid.py rename to foundry/v2/filesystem/models/_project_rid.py diff --git a/foundry/v2/foundry_client.py b/foundry/v2/foundry_client.py deleted file mode 100644 index 3f2b5986..00000000 --- a/foundry/v2/foundry_client.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from foundry._core.auth_utils import Auth -from foundry._errors.environment_not_configured import EnvironmentNotConfigured -from foundry.api_client import ApiClient - - -class FoundryV2Client: - """ - The Foundry V2 API client. - - :param auth: Your auth configuration. - :param hostname: Your Foundry hostname (for example, "myfoundry.palantirfoundry.com"). - """ - - def __init__(self, auth: Auth, hostname: str): - from foundry.v2._namespaces.namespaces import Admin - from foundry.v2._namespaces.namespaces import Datasets - from foundry.v2._namespaces.namespaces import Ontologies - from foundry.v2._namespaces.namespaces import Orchestration - from foundry.v2._namespaces.namespaces import ThirdPartyApplications - - api_client = ApiClient(auth=auth, hostname=hostname) - self.admin = Admin(api_client=api_client) - self.datasets = Datasets(api_client=api_client) - self.ontologies = Ontologies(api_client=api_client) - self.orchestration = Orchestration(api_client=api_client) - self.third_party_applications = ThirdPartyApplications(api_client=api_client) diff --git a/foundry/v2/geo/models/__init__.py b/foundry/v2/geo/models/__init__.py new file mode 100644 index 00000000..c6b676f0 --- /dev/null +++ b/foundry/v2/geo/models/__init__.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from foundry.v2.geo.models._b_box import BBox +from foundry.v2.geo.models._coordinate import Coordinate +from foundry.v2.geo.models._geo_point import GeoPoint +from foundry.v2.geo.models._geo_point_dict import GeoPointDict +from foundry.v2.geo.models._linear_ring import LinearRing +from foundry.v2.geo.models._polygon import Polygon +from foundry.v2.geo.models._polygon_dict import PolygonDict +from foundry.v2.geo.models._position import Position + +__all__ = [ + "BBox", + "Coordinate", + "GeoPoint", + "GeoPointDict", + "LinearRing", + "Polygon", + "PolygonDict", + "Position", +] diff --git a/foundry/v2/geo/models/_b_box.py b/foundry/v2/geo/models/_b_box.py new file mode 100644 index 00000000..abbae08d --- /dev/null +++ b/foundry/v2/geo/models/_b_box.py @@ -0,0 +1,31 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from foundry.v2.geo.models._coordinate import Coordinate + +BBox = List[Coordinate] +""" +A GeoJSON object MAY have a member named "bbox" to include +information on the coordinate range for its Geometries, Features, or +FeatureCollections. The value of the bbox member MUST be an array of +length 2*n where n is the number of dimensions represented in the +contained geometries, with all axes of the most southwesterly point +followed by all axes of the more northeasterly point. The axes order +of a bbox follows the axes order of geometries. +""" diff --git a/foundry/v1/models/_coordinate.py b/foundry/v2/geo/models/_coordinate.py similarity index 100% rename from foundry/v1/models/_coordinate.py rename to foundry/v2/geo/models/_coordinate.py diff --git a/foundry/v2/geo/models/_geo_point.py b/foundry/v2/geo/models/_geo_point.py new file mode 100644 index 00000000..f6f3fae7 --- /dev/null +++ b/foundry/v2/geo/models/_geo_point.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.geo.models._b_box import BBox +from foundry.v2.geo.models._geo_point_dict import GeoPointDict +from foundry.v2.geo.models._position import Position + + +class GeoPoint(BaseModel): + """GeoPoint""" + + coordinates: Position + + bbox: Optional[BBox] = None + + type: Literal["Point"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> GeoPointDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(GeoPointDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/geo/models/_geo_point_dict.py b/foundry/v2/geo/models/_geo_point_dict.py new file mode 100644 index 00000000..88991e05 --- /dev/null +++ b/foundry/v2/geo/models/_geo_point_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.geo.models._b_box import BBox +from foundry.v2.geo.models._position import Position + + +class GeoPointDict(TypedDict): + """GeoPoint""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + coordinates: Position + + bbox: NotRequired[BBox] + + type: Literal["Point"] diff --git a/foundry/v2/geo/models/_linear_ring.py b/foundry/v2/geo/models/_linear_ring.py new file mode 100644 index 00000000..2e493efa --- /dev/null +++ b/foundry/v2/geo/models/_linear_ring.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from foundry.v2.geo.models._position import Position + +LinearRing = List[Position] +""" +A linear ring is a closed LineString with four or more positions. + +The first and last positions are equivalent, and they MUST contain +identical values; their representation SHOULD also be identical. + +A linear ring is the boundary of a surface or the boundary of a hole in +a surface. + +A linear ring MUST follow the right-hand rule with respect to the area +it bounds, i.e., exterior rings are counterclockwise, and holes are +clockwise. +""" diff --git a/foundry/v2/geo/models/_polygon.py b/foundry/v2/geo/models/_polygon.py new file mode 100644 index 00000000..ccce256e --- /dev/null +++ b/foundry/v2/geo/models/_polygon.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.geo.models._b_box import BBox +from foundry.v2.geo.models._linear_ring import LinearRing +from foundry.v2.geo.models._polygon_dict import PolygonDict + + +class Polygon(BaseModel): + """Polygon""" + + coordinates: List[LinearRing] + + bbox: Optional[BBox] = None + + type: Literal["Polygon"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> PolygonDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(PolygonDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/geo/models/_polygon_dict.py b/foundry/v2/geo/models/_polygon_dict.py new file mode 100644 index 00000000..0c8a0e55 --- /dev/null +++ b/foundry/v2/geo/models/_polygon_dict.py @@ -0,0 +1,37 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.geo.models._b_box import BBox +from foundry.v2.geo.models._linear_ring import LinearRing + + +class PolygonDict(TypedDict): + """Polygon""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + coordinates: List[LinearRing] + + bbox: NotRequired[BBox] + + type: Literal["Polygon"] diff --git a/foundry/v2/geo/models/_position.py b/foundry/v2/geo/models/_position.py new file mode 100644 index 00000000..dc63ae3d --- /dev/null +++ b/foundry/v2/geo/models/_position.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from foundry.v2.geo.models._coordinate import Coordinate + +Position = List[Coordinate] +""" +GeoJSon fundamental geometry construct. + +A position is an array of numbers. There MUST be two or more elements. +The first two elements are longitude and latitude, precisely in that order and using decimal numbers. +Altitude or elevation MAY be included as an optional third element. + +Implementations SHOULD NOT extend positions beyond three elements +because the semantics of extra elements are unspecified and ambiguous. +Historically, some implementations have used a fourth element to carry +a linear referencing measure (sometimes denoted as "M") or a numerical +timestamp, but in most situations a parser will not be able to properly +interpret these values. The interpretation and meaning of additional +elements is beyond the scope of this specification, and additional +elements MAY be ignored by parsers. +""" diff --git a/foundry/v2/models/__init__.py b/foundry/v2/models/__init__.py deleted file mode 100644 index 6a6d867f..00000000 --- a/foundry/v2/models/__init__.py +++ /dev/null @@ -1,1946 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from foundry.v2.models._abort_on_failure import AbortOnFailure -from foundry.v2.models._absolute_time_range import AbsoluteTimeRange -from foundry.v2.models._absolute_time_range_dict import AbsoluteTimeRangeDict -from foundry.v2.models._action import Action -from foundry.v2.models._action_dict import ActionDict -from foundry.v2.models._action_mode import ActionMode -from foundry.v2.models._action_parameter_type import ActionParameterArrayType -from foundry.v2.models._action_parameter_type import ActionParameterType -from foundry.v2.models._action_parameter_type_dict import ActionParameterArrayTypeDict -from foundry.v2.models._action_parameter_type_dict import ActionParameterTypeDict -from foundry.v2.models._action_parameter_v2 import ActionParameterV2 -from foundry.v2.models._action_parameter_v2_dict import ActionParameterV2Dict -from foundry.v2.models._action_results import ActionResults -from foundry.v2.models._action_results_dict import ActionResultsDict -from foundry.v2.models._action_rid import ActionRid -from foundry.v2.models._action_type import ActionType -from foundry.v2.models._action_type_api_name import ActionTypeApiName -from foundry.v2.models._action_type_dict import ActionTypeDict -from foundry.v2.models._action_type_rid import ActionTypeRid -from foundry.v2.models._action_type_v2 import ActionTypeV2 -from foundry.v2.models._action_type_v2_dict import ActionTypeV2Dict -from foundry.v2.models._add_group_members_request import AddGroupMembersRequest -from foundry.v2.models._add_group_members_request_dict import AddGroupMembersRequestDict -from foundry.v2.models._add_link import AddLink -from foundry.v2.models._add_link_dict import AddLinkDict -from foundry.v2.models._add_object import AddObject -from foundry.v2.models._add_object_dict import AddObjectDict -from foundry.v2.models._aggregate_object_set_request_v2 import AggregateObjectSetRequestV2 # NOQA -from foundry.v2.models._aggregate_object_set_request_v2_dict import ( - AggregateObjectSetRequestV2Dict, -) # NOQA -from foundry.v2.models._aggregate_objects_request import AggregateObjectsRequest -from foundry.v2.models._aggregate_objects_request_dict import AggregateObjectsRequestDict # NOQA -from foundry.v2.models._aggregate_objects_request_v2 import AggregateObjectsRequestV2 -from foundry.v2.models._aggregate_objects_request_v2_dict import ( - AggregateObjectsRequestV2Dict, -) # NOQA -from foundry.v2.models._aggregate_objects_response import AggregateObjectsResponse -from foundry.v2.models._aggregate_objects_response_dict import AggregateObjectsResponseDict # NOQA -from foundry.v2.models._aggregate_objects_response_item import AggregateObjectsResponseItem # NOQA -from foundry.v2.models._aggregate_objects_response_item_dict import ( - AggregateObjectsResponseItemDict, -) # NOQA -from foundry.v2.models._aggregate_objects_response_item_v2 import ( - AggregateObjectsResponseItemV2, -) # NOQA -from foundry.v2.models._aggregate_objects_response_item_v2_dict import ( - AggregateObjectsResponseItemV2Dict, -) # NOQA -from foundry.v2.models._aggregate_objects_response_v2 import AggregateObjectsResponseV2 -from foundry.v2.models._aggregate_objects_response_v2_dict import ( - AggregateObjectsResponseV2Dict, -) # NOQA -from foundry.v2.models._aggregation import Aggregation -from foundry.v2.models._aggregation_accuracy import AggregationAccuracy -from foundry.v2.models._aggregation_accuracy_request import AggregationAccuracyRequest -from foundry.v2.models._aggregation_dict import AggregationDict -from foundry.v2.models._aggregation_duration_grouping import AggregationDurationGrouping -from foundry.v2.models._aggregation_duration_grouping_dict import ( - AggregationDurationGroupingDict, -) # NOQA -from foundry.v2.models._aggregation_duration_grouping_v2 import ( - AggregationDurationGroupingV2, -) # NOQA -from foundry.v2.models._aggregation_duration_grouping_v2_dict import ( - AggregationDurationGroupingV2Dict, -) # NOQA -from foundry.v2.models._aggregation_exact_grouping import AggregationExactGrouping -from foundry.v2.models._aggregation_exact_grouping_dict import AggregationExactGroupingDict # NOQA -from foundry.v2.models._aggregation_exact_grouping_v2 import AggregationExactGroupingV2 -from foundry.v2.models._aggregation_exact_grouping_v2_dict import ( - AggregationExactGroupingV2Dict, -) # NOQA -from foundry.v2.models._aggregation_fixed_width_grouping import ( - AggregationFixedWidthGrouping, -) # NOQA -from foundry.v2.models._aggregation_fixed_width_grouping_dict import ( - AggregationFixedWidthGroupingDict, -) # NOQA -from foundry.v2.models._aggregation_fixed_width_grouping_v2 import ( - AggregationFixedWidthGroupingV2, -) # NOQA -from foundry.v2.models._aggregation_fixed_width_grouping_v2_dict import ( - AggregationFixedWidthGroupingV2Dict, -) # NOQA -from foundry.v2.models._aggregation_group_by import AggregationGroupBy -from foundry.v2.models._aggregation_group_by_dict import AggregationGroupByDict -from foundry.v2.models._aggregation_group_by_v2 import AggregationGroupByV2 -from foundry.v2.models._aggregation_group_by_v2_dict import AggregationGroupByV2Dict -from foundry.v2.models._aggregation_group_key import AggregationGroupKey -from foundry.v2.models._aggregation_group_key_v2 import AggregationGroupKeyV2 -from foundry.v2.models._aggregation_group_value import AggregationGroupValue -from foundry.v2.models._aggregation_group_value_v2 import AggregationGroupValueV2 -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._aggregation_metric_result import AggregationMetricResult -from foundry.v2.models._aggregation_metric_result_dict import AggregationMetricResultDict # NOQA -from foundry.v2.models._aggregation_metric_result_v2 import AggregationMetricResultV2 -from foundry.v2.models._aggregation_metric_result_v2_dict import ( - AggregationMetricResultV2Dict, -) # NOQA -from foundry.v2.models._aggregation_object_type_grouping import ( - AggregationObjectTypeGrouping, -) # NOQA -from foundry.v2.models._aggregation_object_type_grouping_dict import ( - AggregationObjectTypeGroupingDict, -) # NOQA -from foundry.v2.models._aggregation_order_by import AggregationOrderBy -from foundry.v2.models._aggregation_order_by_dict import AggregationOrderByDict -from foundry.v2.models._aggregation_range import AggregationRange -from foundry.v2.models._aggregation_range_dict import AggregationRangeDict -from foundry.v2.models._aggregation_range_v2 import AggregationRangeV2 -from foundry.v2.models._aggregation_range_v2_dict import AggregationRangeV2Dict -from foundry.v2.models._aggregation_ranges_grouping import AggregationRangesGrouping -from foundry.v2.models._aggregation_ranges_grouping_dict import ( - AggregationRangesGroupingDict, -) # NOQA -from foundry.v2.models._aggregation_ranges_grouping_v2 import AggregationRangesGroupingV2 # NOQA -from foundry.v2.models._aggregation_ranges_grouping_v2_dict import ( - AggregationRangesGroupingV2Dict, -) # NOQA -from foundry.v2.models._aggregation_v2 import AggregationV2 -from foundry.v2.models._aggregation_v2_dict import AggregationV2Dict -from foundry.v2.models._all_terms_query import AllTermsQuery -from foundry.v2.models._all_terms_query_dict import AllTermsQueryDict -from foundry.v2.models._any_term_query import AnyTermQuery -from foundry.v2.models._any_term_query_dict import AnyTermQueryDict -from foundry.v2.models._any_type import AnyType -from foundry.v2.models._any_type_dict import AnyTypeDict -from foundry.v2.models._api_definition import ApiDefinition -from foundry.v2.models._api_definition_deprecated import ApiDefinitionDeprecated -from foundry.v2.models._api_definition_dict import ApiDefinitionDict -from foundry.v2.models._api_definition_name import ApiDefinitionName -from foundry.v2.models._api_definition_rid import ApiDefinitionRid -from foundry.v2.models._apply_action_mode import ApplyActionMode -from foundry.v2.models._apply_action_request import ApplyActionRequest -from foundry.v2.models._apply_action_request_dict import ApplyActionRequestDict -from foundry.v2.models._apply_action_request_options import ApplyActionRequestOptions -from foundry.v2.models._apply_action_request_options_dict import ( - ApplyActionRequestOptionsDict, -) # NOQA -from foundry.v2.models._apply_action_request_v2 import ApplyActionRequestV2 -from foundry.v2.models._apply_action_request_v2_dict import ApplyActionRequestV2Dict -from foundry.v2.models._apply_action_response import ApplyActionResponse -from foundry.v2.models._apply_action_response_dict import ApplyActionResponseDict -from foundry.v2.models._approximate_distinct_aggregation import ( - ApproximateDistinctAggregation, -) # NOQA -from foundry.v2.models._approximate_distinct_aggregation_dict import ( - ApproximateDistinctAggregationDict, -) # NOQA -from foundry.v2.models._approximate_distinct_aggregation_v2 import ( - ApproximateDistinctAggregationV2, -) # NOQA -from foundry.v2.models._approximate_distinct_aggregation_v2_dict import ( - ApproximateDistinctAggregationV2Dict, -) # NOQA -from foundry.v2.models._approximate_percentile_aggregation_v2 import ( - ApproximatePercentileAggregationV2, -) # NOQA -from foundry.v2.models._approximate_percentile_aggregation_v2_dict import ( - ApproximatePercentileAggregationV2Dict, -) # NOQA -from foundry.v2.models._archive_file_format import ArchiveFileFormat -from foundry.v2.models._arg import Arg -from foundry.v2.models._arg_dict import ArgDict -from foundry.v2.models._array_size_constraint import ArraySizeConstraint -from foundry.v2.models._array_size_constraint_dict import ArraySizeConstraintDict -from foundry.v2.models._artifact_repository_rid import ArtifactRepositoryRid -from foundry.v2.models._async_action_status import AsyncActionStatus -from foundry.v2.models._async_apply_action_operation_response_v2 import ( - AsyncApplyActionOperationResponseV2, -) # NOQA -from foundry.v2.models._async_apply_action_operation_response_v2_dict import ( - AsyncApplyActionOperationResponseV2Dict, -) # NOQA -from foundry.v2.models._async_apply_action_request import AsyncApplyActionRequest -from foundry.v2.models._async_apply_action_request_dict import AsyncApplyActionRequestDict # NOQA -from foundry.v2.models._async_apply_action_request_v2 import AsyncApplyActionRequestV2 -from foundry.v2.models._async_apply_action_request_v2_dict import ( - AsyncApplyActionRequestV2Dict, -) # NOQA -from foundry.v2.models._async_apply_action_response import AsyncApplyActionResponse -from foundry.v2.models._async_apply_action_response_dict import AsyncApplyActionResponseDict # NOQA -from foundry.v2.models._async_apply_action_response_v2 import AsyncApplyActionResponseV2 -from foundry.v2.models._async_apply_action_response_v2_dict import ( - AsyncApplyActionResponseV2Dict, -) # NOQA -from foundry.v2.models._attachment import Attachment -from foundry.v2.models._attachment_dict import AttachmentDict -from foundry.v2.models._attachment_metadata_response import AttachmentMetadataResponse -from foundry.v2.models._attachment_metadata_response_dict import ( - AttachmentMetadataResponseDict, -) # NOQA -from foundry.v2.models._attachment_property import AttachmentProperty -from foundry.v2.models._attachment_property_dict import AttachmentPropertyDict -from foundry.v2.models._attachment_rid import AttachmentRid -from foundry.v2.models._attachment_type import AttachmentType -from foundry.v2.models._attachment_type_dict import AttachmentTypeDict -from foundry.v2.models._attachment_v2 import AttachmentV2 -from foundry.v2.models._attachment_v2_dict import AttachmentV2Dict -from foundry.v2.models._attribute_name import AttributeName -from foundry.v2.models._attribute_value import AttributeValue -from foundry.v2.models._attribute_values import AttributeValues -from foundry.v2.models._avg_aggregation import AvgAggregation -from foundry.v2.models._avg_aggregation_dict import AvgAggregationDict -from foundry.v2.models._avg_aggregation_v2 import AvgAggregationV2 -from foundry.v2.models._avg_aggregation_v2_dict import AvgAggregationV2Dict -from foundry.v2.models._b_box import BBox -from foundry.v2.models._batch_apply_action_request import BatchApplyActionRequest -from foundry.v2.models._batch_apply_action_request_dict import BatchApplyActionRequestDict # NOQA -from foundry.v2.models._batch_apply_action_request_item import BatchApplyActionRequestItem # NOQA -from foundry.v2.models._batch_apply_action_request_item_dict import ( - BatchApplyActionRequestItemDict, -) # NOQA -from foundry.v2.models._batch_apply_action_request_options import ( - BatchApplyActionRequestOptions, -) # NOQA -from foundry.v2.models._batch_apply_action_request_options_dict import ( - BatchApplyActionRequestOptionsDict, -) # NOQA -from foundry.v2.models._batch_apply_action_request_v2 import BatchApplyActionRequestV2 -from foundry.v2.models._batch_apply_action_request_v2_dict import ( - BatchApplyActionRequestV2Dict, -) # NOQA -from foundry.v2.models._batch_apply_action_response import BatchApplyActionResponse -from foundry.v2.models._batch_apply_action_response_dict import BatchApplyActionResponseDict # NOQA -from foundry.v2.models._batch_apply_action_response_v2 import BatchApplyActionResponseV2 -from foundry.v2.models._batch_apply_action_response_v2_dict import ( - BatchApplyActionResponseV2Dict, -) # NOQA -from foundry.v2.models._binary_type import BinaryType -from foundry.v2.models._binary_type_dict import BinaryTypeDict -from foundry.v2.models._blueprint_icon import BlueprintIcon -from foundry.v2.models._blueprint_icon_dict import BlueprintIconDict -from foundry.v2.models._boolean_type import BooleanType -from foundry.v2.models._boolean_type_dict import BooleanTypeDict -from foundry.v2.models._bounding_box_value import BoundingBoxValue -from foundry.v2.models._bounding_box_value_dict import BoundingBoxValueDict -from foundry.v2.models._branch import Branch -from foundry.v2.models._branch_dict import BranchDict -from foundry.v2.models._branch_id import BranchId -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._build import Build -from foundry.v2.models._build_dict import BuildDict -from foundry.v2.models._build_rid import BuildRid -from foundry.v2.models._build_status import BuildStatus -from foundry.v2.models._build_target import BuildTarget -from foundry.v2.models._build_target_dict import BuildTargetDict -from foundry.v2.models._byte_type import ByteType -from foundry.v2.models._byte_type_dict import ByteTypeDict -from foundry.v2.models._center_point import CenterPoint -from foundry.v2.models._center_point_dict import CenterPointDict -from foundry.v2.models._center_point_types import CenterPointTypes -from foundry.v2.models._center_point_types_dict import CenterPointTypesDict -from foundry.v2.models._connecting_target import ConnectingTarget -from foundry.v2.models._connecting_target_dict import ConnectingTargetDict -from foundry.v2.models._contains_all_terms_in_order_prefix_last_term import ( - ContainsAllTermsInOrderPrefixLastTerm, -) # NOQA -from foundry.v2.models._contains_all_terms_in_order_prefix_last_term_dict import ( - ContainsAllTermsInOrderPrefixLastTermDict, -) # NOQA -from foundry.v2.models._contains_all_terms_in_order_query import ( - ContainsAllTermsInOrderQuery, -) # NOQA -from foundry.v2.models._contains_all_terms_in_order_query_dict import ( - ContainsAllTermsInOrderQueryDict, -) # NOQA -from foundry.v2.models._contains_all_terms_query import ContainsAllTermsQuery -from foundry.v2.models._contains_all_terms_query_dict import ContainsAllTermsQueryDict -from foundry.v2.models._contains_any_term_query import ContainsAnyTermQuery -from foundry.v2.models._contains_any_term_query_dict import ContainsAnyTermQueryDict -from foundry.v2.models._contains_query import ContainsQuery -from foundry.v2.models._contains_query_dict import ContainsQueryDict -from foundry.v2.models._contains_query_v2 import ContainsQueryV2 -from foundry.v2.models._contains_query_v2_dict import ContainsQueryV2Dict -from foundry.v2.models._content_length import ContentLength -from foundry.v2.models._content_type import ContentType -from foundry.v2.models._coordinate import Coordinate -from foundry.v2.models._count_aggregation import CountAggregation -from foundry.v2.models._count_aggregation_dict import CountAggregationDict -from foundry.v2.models._count_aggregation_v2 import CountAggregationV2 -from foundry.v2.models._count_aggregation_v2_dict import CountAggregationV2Dict -from foundry.v2.models._count_objects_response_v2 import CountObjectsResponseV2 -from foundry.v2.models._count_objects_response_v2_dict import CountObjectsResponseV2Dict -from foundry.v2.models._create_branch_request import CreateBranchRequest -from foundry.v2.models._create_branch_request_dict import CreateBranchRequestDict -from foundry.v2.models._create_builds_request import CreateBuildsRequest -from foundry.v2.models._create_builds_request_dict import CreateBuildsRequestDict -from foundry.v2.models._create_dataset_request import CreateDatasetRequest -from foundry.v2.models._create_dataset_request_dict import CreateDatasetRequestDict -from foundry.v2.models._create_group_request import CreateGroupRequest -from foundry.v2.models._create_group_request_dict import CreateGroupRequestDict -from foundry.v2.models._create_link_rule import CreateLinkRule -from foundry.v2.models._create_link_rule_dict import CreateLinkRuleDict -from foundry.v2.models._create_object_rule import CreateObjectRule -from foundry.v2.models._create_object_rule_dict import CreateObjectRuleDict -from foundry.v2.models._create_temporary_object_set_request_v2 import ( - CreateTemporaryObjectSetRequestV2, -) # NOQA -from foundry.v2.models._create_temporary_object_set_request_v2_dict import ( - CreateTemporaryObjectSetRequestV2Dict, -) # NOQA -from foundry.v2.models._create_temporary_object_set_response_v2 import ( - CreateTemporaryObjectSetResponseV2, -) # NOQA -from foundry.v2.models._create_temporary_object_set_response_v2_dict import ( - CreateTemporaryObjectSetResponseV2Dict, -) # NOQA -from foundry.v2.models._create_transaction_request import CreateTransactionRequest -from foundry.v2.models._create_transaction_request_dict import CreateTransactionRequestDict # NOQA -from foundry.v2.models._created_by import CreatedBy -from foundry.v2.models._created_time import CreatedTime -from foundry.v2.models._cron_expression import CronExpression -from foundry.v2.models._custom_type_id import CustomTypeId -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._dataset import Dataset -from foundry.v2.models._dataset_dict import DatasetDict -from foundry.v2.models._dataset_name import DatasetName -from foundry.v2.models._dataset_rid import DatasetRid -from foundry.v2.models._dataset_updated_trigger import DatasetUpdatedTrigger -from foundry.v2.models._dataset_updated_trigger_dict import DatasetUpdatedTriggerDict -from foundry.v2.models._date_type import DateType -from foundry.v2.models._date_type_dict import DateTypeDict -from foundry.v2.models._decimal_type import DecimalType -from foundry.v2.models._decimal_type_dict import DecimalTypeDict -from foundry.v2.models._delete_link_rule import DeleteLinkRule -from foundry.v2.models._delete_link_rule_dict import DeleteLinkRuleDict -from foundry.v2.models._delete_object_rule import DeleteObjectRule -from foundry.v2.models._delete_object_rule_dict import DeleteObjectRuleDict -from foundry.v2.models._deploy_website_request import DeployWebsiteRequest -from foundry.v2.models._deploy_website_request_dict import DeployWebsiteRequestDict -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._distance import Distance -from foundry.v2.models._distance_dict import DistanceDict -from foundry.v2.models._distance_unit import DistanceUnit -from foundry.v2.models._does_not_intersect_bounding_box_query import ( - DoesNotIntersectBoundingBoxQuery, -) # NOQA -from foundry.v2.models._does_not_intersect_bounding_box_query_dict import ( - DoesNotIntersectBoundingBoxQueryDict, -) # NOQA -from foundry.v2.models._does_not_intersect_polygon_query import DoesNotIntersectPolygonQuery # NOQA -from foundry.v2.models._does_not_intersect_polygon_query_dict import ( - DoesNotIntersectPolygonQueryDict, -) # NOQA -from foundry.v2.models._double_type import DoubleType -from foundry.v2.models._double_type_dict import DoubleTypeDict -from foundry.v2.models._duration import Duration -from foundry.v2.models._duration_dict import DurationDict -from foundry.v2.models._equals_query import EqualsQuery -from foundry.v2.models._equals_query_dict import EqualsQueryDict -from foundry.v2.models._equals_query_v2 import EqualsQueryV2 -from foundry.v2.models._equals_query_v2_dict import EqualsQueryV2Dict -from foundry.v2.models._error import Error -from foundry.v2.models._error_dict import ErrorDict -from foundry.v2.models._error_name import ErrorName -from foundry.v2.models._exact_distinct_aggregation_v2 import ExactDistinctAggregationV2 -from foundry.v2.models._exact_distinct_aggregation_v2_dict import ( - ExactDistinctAggregationV2Dict, -) # NOQA -from foundry.v2.models._execute_query_request import ExecuteQueryRequest -from foundry.v2.models._execute_query_request_dict import ExecuteQueryRequestDict -from foundry.v2.models._execute_query_response import ExecuteQueryResponse -from foundry.v2.models._execute_query_response_dict import ExecuteQueryResponseDict -from foundry.v2.models._fallback_branches import FallbackBranches -from foundry.v2.models._feature import Feature -from foundry.v2.models._feature_collection import FeatureCollection -from foundry.v2.models._feature_collection_dict import FeatureCollectionDict -from foundry.v2.models._feature_collection_types import FeatureCollectionTypes -from foundry.v2.models._feature_collection_types_dict import FeatureCollectionTypesDict -from foundry.v2.models._feature_dict import FeatureDict -from foundry.v2.models._feature_property_key import FeaturePropertyKey -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._file import File -from foundry.v2.models._file_dict import FileDict -from foundry.v2.models._file_path import FilePath -from foundry.v2.models._file_updated_time import FileUpdatedTime -from foundry.v2.models._filename import Filename -from foundry.v2.models._filesystem_resource import FilesystemResource -from foundry.v2.models._filesystem_resource_dict import FilesystemResourceDict -from foundry.v2.models._filter_value import FilterValue -from foundry.v2.models._float_type import FloatType -from foundry.v2.models._float_type_dict import FloatTypeDict -from foundry.v2.models._folder import Folder -from foundry.v2.models._folder_dict import FolderDict -from foundry.v2.models._folder_rid import FolderRid -from foundry.v2.models._force_build import ForceBuild -from foundry.v2.models._function_rid import FunctionRid -from foundry.v2.models._function_version import FunctionVersion -from foundry.v2.models._fuzzy import Fuzzy -from foundry.v2.models._fuzzy_v2 import FuzzyV2 -from foundry.v2.models._geo_json_object import GeoJsonObject -from foundry.v2.models._geo_json_object_dict import GeoJsonObjectDict -from foundry.v2.models._geo_point import GeoPoint -from foundry.v2.models._geo_point_dict import GeoPointDict -from foundry.v2.models._geo_point_type import GeoPointType -from foundry.v2.models._geo_point_type_dict import GeoPointTypeDict -from foundry.v2.models._geo_shape_type import GeoShapeType -from foundry.v2.models._geo_shape_type_dict import GeoShapeTypeDict -from foundry.v2.models._geometry import Geometry -from foundry.v2.models._geometry import GeometryCollection -from foundry.v2.models._geometry_dict import GeometryCollectionDict -from foundry.v2.models._geometry_dict import GeometryDict -from foundry.v2.models._geotime_series_value import GeotimeSeriesValue -from foundry.v2.models._geotime_series_value_dict import GeotimeSeriesValueDict -from foundry.v2.models._get_groups_batch_request_element import GetGroupsBatchRequestElement # NOQA -from foundry.v2.models._get_groups_batch_request_element_dict import ( - GetGroupsBatchRequestElementDict, -) # NOQA -from foundry.v2.models._get_groups_batch_response import GetGroupsBatchResponse -from foundry.v2.models._get_groups_batch_response_dict import GetGroupsBatchResponseDict -from foundry.v2.models._get_users_batch_request_element import GetUsersBatchRequestElement # NOQA -from foundry.v2.models._get_users_batch_request_element_dict import ( - GetUsersBatchRequestElementDict, -) # NOQA -from foundry.v2.models._get_users_batch_response import GetUsersBatchResponse -from foundry.v2.models._get_users_batch_response_dict import GetUsersBatchResponseDict -from foundry.v2.models._group import Group -from foundry.v2.models._group_dict import GroupDict -from foundry.v2.models._group_member import GroupMember -from foundry.v2.models._group_member_constraint import GroupMemberConstraint -from foundry.v2.models._group_member_constraint_dict import GroupMemberConstraintDict -from foundry.v2.models._group_member_dict import GroupMemberDict -from foundry.v2.models._group_membership import GroupMembership -from foundry.v2.models._group_membership_dict import GroupMembershipDict -from foundry.v2.models._group_membership_expiration import GroupMembershipExpiration -from foundry.v2.models._group_name import GroupName -from foundry.v2.models._group_search_filter import GroupSearchFilter -from foundry.v2.models._group_search_filter_dict import GroupSearchFilterDict -from foundry.v2.models._gt_query import GtQuery -from foundry.v2.models._gt_query_dict import GtQueryDict -from foundry.v2.models._gt_query_v2 import GtQueryV2 -from foundry.v2.models._gt_query_v2_dict import GtQueryV2Dict -from foundry.v2.models._gte_query import GteQuery -from foundry.v2.models._gte_query_dict import GteQueryDict -from foundry.v2.models._gte_query_v2 import GteQueryV2 -from foundry.v2.models._gte_query_v2_dict import GteQueryV2Dict -from foundry.v2.models._icon import Icon -from foundry.v2.models._icon_dict import IconDict -from foundry.v2.models._integer_type import IntegerType -from foundry.v2.models._integer_type_dict import IntegerTypeDict -from foundry.v2.models._interface_link_type import InterfaceLinkType -from foundry.v2.models._interface_link_type_api_name import InterfaceLinkTypeApiName -from foundry.v2.models._interface_link_type_cardinality import InterfaceLinkTypeCardinality # NOQA -from foundry.v2.models._interface_link_type_dict import InterfaceLinkTypeDict -from foundry.v2.models._interface_link_type_linked_entity_api_name import ( - InterfaceLinkTypeLinkedEntityApiName, -) # NOQA -from foundry.v2.models._interface_link_type_linked_entity_api_name_dict import ( - InterfaceLinkTypeLinkedEntityApiNameDict, -) # NOQA -from foundry.v2.models._interface_link_type_rid import InterfaceLinkTypeRid -from foundry.v2.models._interface_type import InterfaceType -from foundry.v2.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v2.models._interface_type_dict import InterfaceTypeDict -from foundry.v2.models._interface_type_rid import InterfaceTypeRid -from foundry.v2.models._intersects_bounding_box_query import IntersectsBoundingBoxQuery -from foundry.v2.models._intersects_bounding_box_query_dict import ( - IntersectsBoundingBoxQueryDict, -) # NOQA -from foundry.v2.models._intersects_polygon_query import IntersectsPolygonQuery -from foundry.v2.models._intersects_polygon_query_dict import IntersectsPolygonQueryDict -from foundry.v2.models._ir_version import IrVersion -from foundry.v2.models._is_null_query import IsNullQuery -from foundry.v2.models._is_null_query_dict import IsNullQueryDict -from foundry.v2.models._is_null_query_v2 import IsNullQueryV2 -from foundry.v2.models._is_null_query_v2_dict import IsNullQueryV2Dict -from foundry.v2.models._job_succeeded_trigger import JobSucceededTrigger -from foundry.v2.models._job_succeeded_trigger_dict import JobSucceededTriggerDict -from foundry.v2.models._line_string import LineString -from foundry.v2.models._line_string_coordinates import LineStringCoordinates -from foundry.v2.models._line_string_dict import LineStringDict -from foundry.v2.models._linear_ring import LinearRing -from foundry.v2.models._link_side_object import LinkSideObject -from foundry.v2.models._link_side_object_dict import LinkSideObjectDict -from foundry.v2.models._link_type_api_name import LinkTypeApiName -from foundry.v2.models._link_type_rid import LinkTypeRid -from foundry.v2.models._link_type_side import LinkTypeSide -from foundry.v2.models._link_type_side_cardinality import LinkTypeSideCardinality -from foundry.v2.models._link_type_side_dict import LinkTypeSideDict -from foundry.v2.models._link_type_side_v2 import LinkTypeSideV2 -from foundry.v2.models._link_type_side_v2_dict import LinkTypeSideV2Dict -from foundry.v2.models._linked_interface_type_api_name import LinkedInterfaceTypeApiName -from foundry.v2.models._linked_interface_type_api_name_dict import ( - LinkedInterfaceTypeApiNameDict, -) # NOQA -from foundry.v2.models._linked_object_type_api_name import LinkedObjectTypeApiName -from foundry.v2.models._linked_object_type_api_name_dict import LinkedObjectTypeApiNameDict # NOQA -from foundry.v2.models._list_action_types_response import ListActionTypesResponse -from foundry.v2.models._list_action_types_response_dict import ListActionTypesResponseDict # NOQA -from foundry.v2.models._list_action_types_response_v2 import ListActionTypesResponseV2 -from foundry.v2.models._list_action_types_response_v2_dict import ( - ListActionTypesResponseV2Dict, -) # NOQA -from foundry.v2.models._list_attachments_response_v2 import ListAttachmentsResponseV2 -from foundry.v2.models._list_attachments_response_v2_dict import ( - ListAttachmentsResponseV2Dict, -) # NOQA -from foundry.v2.models._list_branches_response import ListBranchesResponse -from foundry.v2.models._list_branches_response_dict import ListBranchesResponseDict -from foundry.v2.models._list_files_response import ListFilesResponse -from foundry.v2.models._list_files_response_dict import ListFilesResponseDict -from foundry.v2.models._list_group_members_response import ListGroupMembersResponse -from foundry.v2.models._list_group_members_response_dict import ListGroupMembersResponseDict # NOQA -from foundry.v2.models._list_group_memberships_response import ListGroupMembershipsResponse # NOQA -from foundry.v2.models._list_group_memberships_response_dict import ( - ListGroupMembershipsResponseDict, -) # NOQA -from foundry.v2.models._list_groups_response import ListGroupsResponse -from foundry.v2.models._list_groups_response_dict import ListGroupsResponseDict -from foundry.v2.models._list_interface_types_response import ListInterfaceTypesResponse -from foundry.v2.models._list_interface_types_response_dict import ( - ListInterfaceTypesResponseDict, -) # NOQA -from foundry.v2.models._list_linked_objects_response import ListLinkedObjectsResponse -from foundry.v2.models._list_linked_objects_response_dict import ( - ListLinkedObjectsResponseDict, -) # NOQA -from foundry.v2.models._list_linked_objects_response_v2 import ListLinkedObjectsResponseV2 # NOQA -from foundry.v2.models._list_linked_objects_response_v2_dict import ( - ListLinkedObjectsResponseV2Dict, -) # NOQA -from foundry.v2.models._list_object_types_response import ListObjectTypesResponse -from foundry.v2.models._list_object_types_response_dict import ListObjectTypesResponseDict # NOQA -from foundry.v2.models._list_object_types_v2_response import ListObjectTypesV2Response -from foundry.v2.models._list_object_types_v2_response_dict import ( - ListObjectTypesV2ResponseDict, -) # NOQA -from foundry.v2.models._list_objects_response import ListObjectsResponse -from foundry.v2.models._list_objects_response_dict import ListObjectsResponseDict -from foundry.v2.models._list_objects_response_v2 import ListObjectsResponseV2 -from foundry.v2.models._list_objects_response_v2_dict import ListObjectsResponseV2Dict -from foundry.v2.models._list_ontologies_response import ListOntologiesResponse -from foundry.v2.models._list_ontologies_response_dict import ListOntologiesResponseDict -from foundry.v2.models._list_ontologies_v2_response import ListOntologiesV2Response -from foundry.v2.models._list_ontologies_v2_response_dict import ListOntologiesV2ResponseDict # NOQA -from foundry.v2.models._list_outgoing_link_types_response import ( - ListOutgoingLinkTypesResponse, -) # NOQA -from foundry.v2.models._list_outgoing_link_types_response_dict import ( - ListOutgoingLinkTypesResponseDict, -) # NOQA -from foundry.v2.models._list_outgoing_link_types_response_v2 import ( - ListOutgoingLinkTypesResponseV2, -) # NOQA -from foundry.v2.models._list_outgoing_link_types_response_v2_dict import ( - ListOutgoingLinkTypesResponseV2Dict, -) # NOQA -from foundry.v2.models._list_query_types_response import ListQueryTypesResponse -from foundry.v2.models._list_query_types_response_dict import ListQueryTypesResponseDict -from foundry.v2.models._list_query_types_response_v2 import ListQueryTypesResponseV2 -from foundry.v2.models._list_query_types_response_v2_dict import ( - ListQueryTypesResponseV2Dict, -) # NOQA -from foundry.v2.models._list_users_response import ListUsersResponse -from foundry.v2.models._list_users_response_dict import ListUsersResponseDict -from foundry.v2.models._list_versions_response import ListVersionsResponse -from foundry.v2.models._list_versions_response_dict import ListVersionsResponseDict -from foundry.v2.models._load_object_set_request_v2 import LoadObjectSetRequestV2 -from foundry.v2.models._load_object_set_request_v2_dict import LoadObjectSetRequestV2Dict # NOQA -from foundry.v2.models._load_object_set_response_v2 import LoadObjectSetResponseV2 -from foundry.v2.models._load_object_set_response_v2_dict import LoadObjectSetResponseV2Dict # NOQA -from foundry.v2.models._local_file_path import LocalFilePath -from foundry.v2.models._local_file_path_dict import LocalFilePathDict -from foundry.v2.models._logic_rule import LogicRule -from foundry.v2.models._logic_rule_dict import LogicRuleDict -from foundry.v2.models._long_type import LongType -from foundry.v2.models._long_type_dict import LongTypeDict -from foundry.v2.models._lt_query import LtQuery -from foundry.v2.models._lt_query_dict import LtQueryDict -from foundry.v2.models._lt_query_v2 import LtQueryV2 -from foundry.v2.models._lt_query_v2_dict import LtQueryV2Dict -from foundry.v2.models._lte_query import LteQuery -from foundry.v2.models._lte_query_dict import LteQueryDict -from foundry.v2.models._lte_query_v2 import LteQueryV2 -from foundry.v2.models._lte_query_v2_dict import LteQueryV2Dict -from foundry.v2.models._manual_target import ManualTarget -from foundry.v2.models._manual_target_dict import ManualTargetDict -from foundry.v2.models._marking_type import MarkingType -from foundry.v2.models._marking_type_dict import MarkingTypeDict -from foundry.v2.models._max_aggregation import MaxAggregation -from foundry.v2.models._max_aggregation_dict import MaxAggregationDict -from foundry.v2.models._max_aggregation_v2 import MaxAggregationV2 -from foundry.v2.models._max_aggregation_v2_dict import MaxAggregationV2Dict -from foundry.v2.models._media_set_rid import MediaSetRid -from foundry.v2.models._media_set_updated_trigger import MediaSetUpdatedTrigger -from foundry.v2.models._media_set_updated_trigger_dict import MediaSetUpdatedTriggerDict -from foundry.v2.models._media_type import MediaType -from foundry.v2.models._min_aggregation import MinAggregation -from foundry.v2.models._min_aggregation_dict import MinAggregationDict -from foundry.v2.models._min_aggregation_v2 import MinAggregationV2 -from foundry.v2.models._min_aggregation_v2_dict import MinAggregationV2Dict -from foundry.v2.models._modify_object import ModifyObject -from foundry.v2.models._modify_object_dict import ModifyObjectDict -from foundry.v2.models._modify_object_rule import ModifyObjectRule -from foundry.v2.models._modify_object_rule_dict import ModifyObjectRuleDict -from foundry.v2.models._multi_line_string import MultiLineString -from foundry.v2.models._multi_line_string_dict import MultiLineStringDict -from foundry.v2.models._multi_point import MultiPoint -from foundry.v2.models._multi_point_dict import MultiPointDict -from foundry.v2.models._multi_polygon import MultiPolygon -from foundry.v2.models._multi_polygon_dict import MultiPolygonDict -from foundry.v2.models._nested_query_aggregation import NestedQueryAggregation -from foundry.v2.models._nested_query_aggregation_dict import NestedQueryAggregationDict -from foundry.v2.models._new_logic_trigger import NewLogicTrigger -from foundry.v2.models._new_logic_trigger_dict import NewLogicTriggerDict -from foundry.v2.models._notifications_enabled import NotificationsEnabled -from foundry.v2.models._null_type import NullType -from foundry.v2.models._null_type_dict import NullTypeDict -from foundry.v2.models._object_edit import ObjectEdit -from foundry.v2.models._object_edit_dict import ObjectEditDict -from foundry.v2.models._object_edits import ObjectEdits -from foundry.v2.models._object_edits_dict import ObjectEditsDict -from foundry.v2.models._object_primary_key import ObjectPrimaryKey -from foundry.v2.models._object_property_type import ObjectPropertyType -from foundry.v2.models._object_property_type import OntologyObjectArrayType -from foundry.v2.models._object_property_type_dict import ObjectPropertyTypeDict -from foundry.v2.models._object_property_type_dict import OntologyObjectArrayTypeDict -from foundry.v2.models._object_property_value_constraint import ( - ObjectPropertyValueConstraint, -) # NOQA -from foundry.v2.models._object_property_value_constraint_dict import ( - ObjectPropertyValueConstraintDict, -) # NOQA -from foundry.v2.models._object_query_result_constraint import ObjectQueryResultConstraint # NOQA -from foundry.v2.models._object_query_result_constraint_dict import ( - ObjectQueryResultConstraintDict, -) # NOQA -from foundry.v2.models._object_rid import ObjectRid -from foundry.v2.models._object_set import ObjectSet -from foundry.v2.models._object_set import ObjectSetFilterType -from foundry.v2.models._object_set import ObjectSetIntersectionType -from foundry.v2.models._object_set import ObjectSetSearchAroundType -from foundry.v2.models._object_set import ObjectSetSubtractType -from foundry.v2.models._object_set import ObjectSetUnionType -from foundry.v2.models._object_set_base_type import ObjectSetBaseType -from foundry.v2.models._object_set_base_type_dict import ObjectSetBaseTypeDict -from foundry.v2.models._object_set_dict import ObjectSetDict -from foundry.v2.models._object_set_dict import ObjectSetFilterTypeDict -from foundry.v2.models._object_set_dict import ObjectSetIntersectionTypeDict -from foundry.v2.models._object_set_dict import ObjectSetSearchAroundTypeDict -from foundry.v2.models._object_set_dict import ObjectSetSubtractTypeDict -from foundry.v2.models._object_set_dict import ObjectSetUnionTypeDict -from foundry.v2.models._object_set_reference_type import ObjectSetReferenceType -from foundry.v2.models._object_set_reference_type_dict import ObjectSetReferenceTypeDict -from foundry.v2.models._object_set_rid import ObjectSetRid -from foundry.v2.models._object_set_static_type import ObjectSetStaticType -from foundry.v2.models._object_set_static_type_dict import ObjectSetStaticTypeDict -from foundry.v2.models._object_set_stream_subscribe_request import ( - ObjectSetStreamSubscribeRequest, -) # NOQA -from foundry.v2.models._object_set_stream_subscribe_request_dict import ( - ObjectSetStreamSubscribeRequestDict, -) # NOQA -from foundry.v2.models._object_set_stream_subscribe_requests import ( - ObjectSetStreamSubscribeRequests, -) # NOQA -from foundry.v2.models._object_set_stream_subscribe_requests_dict import ( - ObjectSetStreamSubscribeRequestsDict, -) # NOQA -from foundry.v2.models._object_set_subscribe_response import ObjectSetSubscribeResponse -from foundry.v2.models._object_set_subscribe_response_dict import ( - ObjectSetSubscribeResponseDict, -) # NOQA -from foundry.v2.models._object_set_subscribe_responses import ObjectSetSubscribeResponses # NOQA -from foundry.v2.models._object_set_subscribe_responses_dict import ( - ObjectSetSubscribeResponsesDict, -) # NOQA -from foundry.v2.models._object_set_update import ObjectSetUpdate -from foundry.v2.models._object_set_update_dict import ObjectSetUpdateDict -from foundry.v2.models._object_set_updates import ObjectSetUpdates -from foundry.v2.models._object_set_updates_dict import ObjectSetUpdatesDict -from foundry.v2.models._object_state import ObjectState -from foundry.v2.models._object_type import ObjectType -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._object_type_dict import ObjectTypeDict -from foundry.v2.models._object_type_edits import ObjectTypeEdits -from foundry.v2.models._object_type_edits_dict import ObjectTypeEditsDict -from foundry.v2.models._object_type_full_metadata import ObjectTypeFullMetadata -from foundry.v2.models._object_type_full_metadata_dict import ObjectTypeFullMetadataDict -from foundry.v2.models._object_type_interface_implementation import ( - ObjectTypeInterfaceImplementation, -) # NOQA -from foundry.v2.models._object_type_interface_implementation_dict import ( - ObjectTypeInterfaceImplementationDict, -) # NOQA -from foundry.v2.models._object_type_rid import ObjectTypeRid -from foundry.v2.models._object_type_v2 import ObjectTypeV2 -from foundry.v2.models._object_type_v2_dict import ObjectTypeV2Dict -from foundry.v2.models._object_type_visibility import ObjectTypeVisibility -from foundry.v2.models._object_update import ObjectUpdate -from foundry.v2.models._object_update_dict import ObjectUpdateDict -from foundry.v2.models._one_of_constraint import OneOfConstraint -from foundry.v2.models._one_of_constraint_dict import OneOfConstraintDict -from foundry.v2.models._ontology import Ontology -from foundry.v2.models._ontology_api_name import OntologyApiName -from foundry.v2.models._ontology_data_type import OntologyArrayType -from foundry.v2.models._ontology_data_type import OntologyDataType -from foundry.v2.models._ontology_data_type import OntologyMapType -from foundry.v2.models._ontology_data_type import OntologySetType -from foundry.v2.models._ontology_data_type import OntologyStructField -from foundry.v2.models._ontology_data_type import OntologyStructType -from foundry.v2.models._ontology_data_type_dict import OntologyArrayTypeDict -from foundry.v2.models._ontology_data_type_dict import OntologyDataTypeDict -from foundry.v2.models._ontology_data_type_dict import OntologyMapTypeDict -from foundry.v2.models._ontology_data_type_dict import OntologySetTypeDict -from foundry.v2.models._ontology_data_type_dict import OntologyStructFieldDict -from foundry.v2.models._ontology_data_type_dict import OntologyStructTypeDict -from foundry.v2.models._ontology_dict import OntologyDict -from foundry.v2.models._ontology_full_metadata import OntologyFullMetadata -from foundry.v2.models._ontology_full_metadata_dict import OntologyFullMetadataDict -from foundry.v2.models._ontology_identifier import OntologyIdentifier -from foundry.v2.models._ontology_object import OntologyObject -from foundry.v2.models._ontology_object_dict import OntologyObjectDict -from foundry.v2.models._ontology_object_set_type import OntologyObjectSetType -from foundry.v2.models._ontology_object_set_type_dict import OntologyObjectSetTypeDict -from foundry.v2.models._ontology_object_type import OntologyObjectType -from foundry.v2.models._ontology_object_type_dict import OntologyObjectTypeDict -from foundry.v2.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v2.models._ontology_rid import OntologyRid -from foundry.v2.models._ontology_v2 import OntologyV2 -from foundry.v2.models._ontology_v2_dict import OntologyV2Dict -from foundry.v2.models._order_by import OrderBy -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._organization_rid import OrganizationRid -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._parameter import Parameter -from foundry.v2.models._parameter_dict import ParameterDict -from foundry.v2.models._parameter_evaluated_constraint import ParameterEvaluatedConstraint # NOQA -from foundry.v2.models._parameter_evaluated_constraint_dict import ( - ParameterEvaluatedConstraintDict, -) # NOQA -from foundry.v2.models._parameter_evaluation_result import ParameterEvaluationResult -from foundry.v2.models._parameter_evaluation_result_dict import ( - ParameterEvaluationResultDict, -) # NOQA -from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._parameter_option import ParameterOption -from foundry.v2.models._parameter_option_dict import ParameterOptionDict -from foundry.v2.models._phrase_query import PhraseQuery -from foundry.v2.models._phrase_query_dict import PhraseQueryDict -from foundry.v2.models._polygon import Polygon -from foundry.v2.models._polygon_dict import PolygonDict -from foundry.v2.models._polygon_value import PolygonValue -from foundry.v2.models._polygon_value_dict import PolygonValueDict -from foundry.v2.models._position import Position -from foundry.v2.models._prefix_query import PrefixQuery -from foundry.v2.models._prefix_query_dict import PrefixQueryDict -from foundry.v2.models._preview_mode import PreviewMode -from foundry.v2.models._primary_key_value import PrimaryKeyValue -from foundry.v2.models._principal_filter_type import PrincipalFilterType -from foundry.v2.models._principal_id import PrincipalId -from foundry.v2.models._principal_type import PrincipalType -from foundry.v2.models._project import Project -from foundry.v2.models._project_dict import ProjectDict -from foundry.v2.models._project_rid import ProjectRid -from foundry.v2.models._project_scope import ProjectScope -from foundry.v2.models._project_scope_dict import ProjectScopeDict -from foundry.v2.models._property import Property -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_dict import PropertyDict -from foundry.v2.models._property_filter import PropertyFilter -from foundry.v2.models._property_id import PropertyId -from foundry.v2.models._property_v2 import PropertyV2 -from foundry.v2.models._property_v2_dict import PropertyV2Dict -from foundry.v2.models._property_value import PropertyValue -from foundry.v2.models._property_value_escaped_string import PropertyValueEscapedString -from foundry.v2.models._qos_error import QosError -from foundry.v2.models._qos_error_dict import QosErrorDict -from foundry.v2.models._query_aggregation import QueryAggregation -from foundry.v2.models._query_aggregation_dict import QueryAggregationDict -from foundry.v2.models._query_aggregation_key_type import QueryAggregationKeyType -from foundry.v2.models._query_aggregation_key_type_dict import QueryAggregationKeyTypeDict # NOQA -from foundry.v2.models._query_aggregation_range import QueryAggregationRange -from foundry.v2.models._query_aggregation_range_dict import QueryAggregationRangeDict -from foundry.v2.models._query_aggregation_range_sub_type import QueryAggregationRangeSubType # NOQA -from foundry.v2.models._query_aggregation_range_sub_type_dict import ( - QueryAggregationRangeSubTypeDict, -) # NOQA -from foundry.v2.models._query_aggregation_range_type import QueryAggregationRangeType -from foundry.v2.models._query_aggregation_range_type_dict import ( - QueryAggregationRangeTypeDict, -) # NOQA -from foundry.v2.models._query_aggregation_value_type import QueryAggregationValueType -from foundry.v2.models._query_aggregation_value_type_dict import ( - QueryAggregationValueTypeDict, -) # NOQA -from foundry.v2.models._query_api_name import QueryApiName -from foundry.v2.models._query_data_type import QueryArrayType -from foundry.v2.models._query_data_type import QueryDataType -from foundry.v2.models._query_data_type import QuerySetType -from foundry.v2.models._query_data_type import QueryStructField -from foundry.v2.models._query_data_type import QueryStructType -from foundry.v2.models._query_data_type import QueryUnionType -from foundry.v2.models._query_data_type_dict import QueryArrayTypeDict -from foundry.v2.models._query_data_type_dict import QueryDataTypeDict -from foundry.v2.models._query_data_type_dict import QuerySetTypeDict -from foundry.v2.models._query_data_type_dict import QueryStructFieldDict -from foundry.v2.models._query_data_type_dict import QueryStructTypeDict -from foundry.v2.models._query_data_type_dict import QueryUnionTypeDict -from foundry.v2.models._query_output_v2 import QueryOutputV2 -from foundry.v2.models._query_output_v2_dict import QueryOutputV2Dict -from foundry.v2.models._query_parameter_v2 import QueryParameterV2 -from foundry.v2.models._query_parameter_v2_dict import QueryParameterV2Dict -from foundry.v2.models._query_runtime_error_parameter import QueryRuntimeErrorParameter -from foundry.v2.models._query_three_dimensional_aggregation import ( - QueryThreeDimensionalAggregation, -) # NOQA -from foundry.v2.models._query_three_dimensional_aggregation_dict import ( - QueryThreeDimensionalAggregationDict, -) # NOQA -from foundry.v2.models._query_two_dimensional_aggregation import ( - QueryTwoDimensionalAggregation, -) # NOQA -from foundry.v2.models._query_two_dimensional_aggregation_dict import ( - QueryTwoDimensionalAggregationDict, -) # NOQA -from foundry.v2.models._query_type import QueryType -from foundry.v2.models._query_type_dict import QueryTypeDict -from foundry.v2.models._query_type_v2 import QueryTypeV2 -from foundry.v2.models._query_type_v2_dict import QueryTypeV2Dict -from foundry.v2.models._range_constraint import RangeConstraint -from foundry.v2.models._range_constraint_dict import RangeConstraintDict -from foundry.v2.models._realm import Realm -from foundry.v2.models._reason import Reason -from foundry.v2.models._reason_dict import ReasonDict -from foundry.v2.models._reason_type import ReasonType -from foundry.v2.models._reference_update import ReferenceUpdate -from foundry.v2.models._reference_update_dict import ReferenceUpdateDict -from foundry.v2.models._reference_value import ReferenceValue -from foundry.v2.models._reference_value_dict import ReferenceValueDict -from foundry.v2.models._refresh_object_set import RefreshObjectSet -from foundry.v2.models._refresh_object_set_dict import RefreshObjectSetDict -from foundry.v2.models._relative_time import RelativeTime -from foundry.v2.models._relative_time_dict import RelativeTimeDict -from foundry.v2.models._relative_time_range import RelativeTimeRange -from foundry.v2.models._relative_time_range_dict import RelativeTimeRangeDict -from foundry.v2.models._relative_time_relation import RelativeTimeRelation -from foundry.v2.models._relative_time_series_time_unit import RelativeTimeSeriesTimeUnit -from foundry.v2.models._release_status import ReleaseStatus -from foundry.v2.models._remove_group_members_request import RemoveGroupMembersRequest -from foundry.v2.models._remove_group_members_request_dict import ( - RemoveGroupMembersRequestDict, -) # NOQA -from foundry.v2.models._request_id import RequestId -from foundry.v2.models._resource import Resource -from foundry.v2.models._resource_dict import ResourceDict -from foundry.v2.models._resource_display_name import ResourceDisplayName -from foundry.v2.models._resource_path import ResourcePath -from foundry.v2.models._resource_rid import ResourceRid -from foundry.v2.models._resource_type import ResourceType -from foundry.v2.models._retry_backoff_duration import RetryBackoffDuration -from foundry.v2.models._retry_backoff_duration_dict import RetryBackoffDurationDict -from foundry.v2.models._retry_count import RetryCount -from foundry.v2.models._return_edits_mode import ReturnEditsMode -from foundry.v2.models._schedule import Schedule -from foundry.v2.models._schedule_dict import ScheduleDict -from foundry.v2.models._schedule_paused import SchedulePaused -from foundry.v2.models._schedule_rid import ScheduleRid -from foundry.v2.models._schedule_run import ScheduleRun -from foundry.v2.models._schedule_run_dict import ScheduleRunDict -from foundry.v2.models._schedule_run_error import ScheduleRunError -from foundry.v2.models._schedule_run_error_dict import ScheduleRunErrorDict -from foundry.v2.models._schedule_run_error_name import ScheduleRunErrorName -from foundry.v2.models._schedule_run_ignored import ScheduleRunIgnored -from foundry.v2.models._schedule_run_ignored_dict import ScheduleRunIgnoredDict -from foundry.v2.models._schedule_run_result import ScheduleRunResult -from foundry.v2.models._schedule_run_result_dict import ScheduleRunResultDict -from foundry.v2.models._schedule_run_rid import ScheduleRunRid -from foundry.v2.models._schedule_run_submitted import ScheduleRunSubmitted -from foundry.v2.models._schedule_run_submitted_dict import ScheduleRunSubmittedDict -from foundry.v2.models._schedule_succeeded_trigger import ScheduleSucceededTrigger -from foundry.v2.models._schedule_succeeded_trigger_dict import ScheduleSucceededTriggerDict # NOQA -from foundry.v2.models._schedule_version import ScheduleVersion -from foundry.v2.models._schedule_version_dict import ScheduleVersionDict -from foundry.v2.models._schedule_version_rid import ScheduleVersionRid -from foundry.v2.models._scope_mode import ScopeMode -from foundry.v2.models._scope_mode_dict import ScopeModeDict -from foundry.v2.models._sdk_package_name import SdkPackageName -from foundry.v2.models._search_groups_request import SearchGroupsRequest -from foundry.v2.models._search_groups_request_dict import SearchGroupsRequestDict -from foundry.v2.models._search_groups_response import SearchGroupsResponse -from foundry.v2.models._search_groups_response_dict import SearchGroupsResponseDict -from foundry.v2.models._search_json_query import AndQuery -from foundry.v2.models._search_json_query import NotQuery -from foundry.v2.models._search_json_query import OrQuery -from foundry.v2.models._search_json_query import SearchJsonQuery -from foundry.v2.models._search_json_query_dict import AndQueryDict -from foundry.v2.models._search_json_query_dict import NotQueryDict -from foundry.v2.models._search_json_query_dict import OrQueryDict -from foundry.v2.models._search_json_query_dict import SearchJsonQueryDict -from foundry.v2.models._search_json_query_v2 import AndQueryV2 -from foundry.v2.models._search_json_query_v2 import NotQueryV2 -from foundry.v2.models._search_json_query_v2 import OrQueryV2 -from foundry.v2.models._search_json_query_v2 import SearchJsonQueryV2 -from foundry.v2.models._search_json_query_v2_dict import AndQueryV2Dict -from foundry.v2.models._search_json_query_v2_dict import NotQueryV2Dict -from foundry.v2.models._search_json_query_v2_dict import OrQueryV2Dict -from foundry.v2.models._search_json_query_v2_dict import SearchJsonQueryV2Dict -from foundry.v2.models._search_objects_for_interface_request import ( - SearchObjectsForInterfaceRequest, -) # NOQA -from foundry.v2.models._search_objects_for_interface_request_dict import ( - SearchObjectsForInterfaceRequestDict, -) # NOQA -from foundry.v2.models._search_objects_request import SearchObjectsRequest -from foundry.v2.models._search_objects_request_dict import SearchObjectsRequestDict -from foundry.v2.models._search_objects_request_v2 import SearchObjectsRequestV2 -from foundry.v2.models._search_objects_request_v2_dict import SearchObjectsRequestV2Dict -from foundry.v2.models._search_objects_response import SearchObjectsResponse -from foundry.v2.models._search_objects_response_dict import SearchObjectsResponseDict -from foundry.v2.models._search_objects_response_v2 import SearchObjectsResponseV2 -from foundry.v2.models._search_objects_response_v2_dict import SearchObjectsResponseV2Dict # NOQA -from foundry.v2.models._search_order_by import SearchOrderBy -from foundry.v2.models._search_order_by_dict import SearchOrderByDict -from foundry.v2.models._search_order_by_v2 import SearchOrderByV2 -from foundry.v2.models._search_order_by_v2_dict import SearchOrderByV2Dict -from foundry.v2.models._search_ordering import SearchOrdering -from foundry.v2.models._search_ordering_dict import SearchOrderingDict -from foundry.v2.models._search_ordering_v2 import SearchOrderingV2 -from foundry.v2.models._search_ordering_v2_dict import SearchOrderingV2Dict -from foundry.v2.models._search_users_request import SearchUsersRequest -from foundry.v2.models._search_users_request_dict import SearchUsersRequestDict -from foundry.v2.models._search_users_response import SearchUsersResponse -from foundry.v2.models._search_users_response_dict import SearchUsersResponseDict -from foundry.v2.models._selected_property_api_name import SelectedPropertyApiName -from foundry.v2.models._shared_property_type import SharedPropertyType -from foundry.v2.models._shared_property_type_api_name import SharedPropertyTypeApiName -from foundry.v2.models._shared_property_type_dict import SharedPropertyTypeDict -from foundry.v2.models._shared_property_type_rid import SharedPropertyTypeRid -from foundry.v2.models._short_type import ShortType -from foundry.v2.models._short_type_dict import ShortTypeDict -from foundry.v2.models._size_bytes import SizeBytes -from foundry.v2.models._space import Space -from foundry.v2.models._space_dict import SpaceDict -from foundry.v2.models._space_rid import SpaceRid -from foundry.v2.models._starts_with_query import StartsWithQuery -from foundry.v2.models._starts_with_query_dict import StartsWithQueryDict -from foundry.v2.models._stream_message import StreamMessage -from foundry.v2.models._stream_message_dict import StreamMessageDict -from foundry.v2.models._stream_time_series_points_request import ( - StreamTimeSeriesPointsRequest, -) # NOQA -from foundry.v2.models._stream_time_series_points_request_dict import ( - StreamTimeSeriesPointsRequestDict, -) # NOQA -from foundry.v2.models._stream_time_series_points_response import ( - StreamTimeSeriesPointsResponse, -) # NOQA -from foundry.v2.models._stream_time_series_points_response_dict import ( - StreamTimeSeriesPointsResponseDict, -) # NOQA -from foundry.v2.models._string_length_constraint import StringLengthConstraint -from foundry.v2.models._string_length_constraint_dict import StringLengthConstraintDict -from foundry.v2.models._string_regex_match_constraint import StringRegexMatchConstraint -from foundry.v2.models._string_regex_match_constraint_dict import ( - StringRegexMatchConstraintDict, -) # NOQA -from foundry.v2.models._string_type import StringType -from foundry.v2.models._string_type_dict import StringTypeDict -from foundry.v2.models._struct_field_name import StructFieldName -from foundry.v2.models._subdomain import Subdomain -from foundry.v2.models._submission_criteria_evaluation import SubmissionCriteriaEvaluation # NOQA -from foundry.v2.models._submission_criteria_evaluation_dict import ( - SubmissionCriteriaEvaluationDict, -) # NOQA -from foundry.v2.models._subscription_closed import SubscriptionClosed -from foundry.v2.models._subscription_closed_dict import SubscriptionClosedDict -from foundry.v2.models._subscription_closure_cause import SubscriptionClosureCause -from foundry.v2.models._subscription_closure_cause_dict import SubscriptionClosureCauseDict # NOQA -from foundry.v2.models._subscription_error import SubscriptionError -from foundry.v2.models._subscription_error_dict import SubscriptionErrorDict -from foundry.v2.models._subscription_id import SubscriptionId -from foundry.v2.models._subscription_success import SubscriptionSuccess -from foundry.v2.models._subscription_success_dict import SubscriptionSuccessDict -from foundry.v2.models._sum_aggregation import SumAggregation -from foundry.v2.models._sum_aggregation_dict import SumAggregationDict -from foundry.v2.models._sum_aggregation_v2 import SumAggregationV2 -from foundry.v2.models._sum_aggregation_v2_dict import SumAggregationV2Dict -from foundry.v2.models._sync_apply_action_response_v2 import SyncApplyActionResponseV2 -from foundry.v2.models._sync_apply_action_response_v2_dict import ( - SyncApplyActionResponseV2Dict, -) # NOQA -from foundry.v2.models._table_export_format import TableExportFormat -from foundry.v2.models._third_party_application import ThirdPartyApplication -from foundry.v2.models._third_party_application_dict import ThirdPartyApplicationDict -from foundry.v2.models._third_party_application_rid import ThirdPartyApplicationRid -from foundry.v2.models._three_dimensional_aggregation import ThreeDimensionalAggregation -from foundry.v2.models._three_dimensional_aggregation_dict import ( - ThreeDimensionalAggregationDict, -) # NOQA -from foundry.v2.models._time_range import TimeRange -from foundry.v2.models._time_range_dict import TimeRangeDict -from foundry.v2.models._time_series_item_type import TimeSeriesItemType -from foundry.v2.models._time_series_item_type_dict import TimeSeriesItemTypeDict -from foundry.v2.models._time_series_point import TimeSeriesPoint -from foundry.v2.models._time_series_point_dict import TimeSeriesPointDict -from foundry.v2.models._time_trigger import TimeTrigger -from foundry.v2.models._time_trigger_dict import TimeTriggerDict -from foundry.v2.models._time_unit import TimeUnit -from foundry.v2.models._timeseries_type import TimeseriesType -from foundry.v2.models._timeseries_type_dict import TimeseriesTypeDict -from foundry.v2.models._timestamp_type import TimestampType -from foundry.v2.models._timestamp_type_dict import TimestampTypeDict -from foundry.v2.models._total_count import TotalCount -from foundry.v2.models._transaction import Transaction -from foundry.v2.models._transaction_created_time import TransactionCreatedTime -from foundry.v2.models._transaction_dict import TransactionDict -from foundry.v2.models._transaction_rid import TransactionRid -from foundry.v2.models._transaction_status import TransactionStatus -from foundry.v2.models._transaction_type import TransactionType -from foundry.v2.models._trashed_status import TrashedStatus -from foundry.v2.models._trigger import AndTrigger -from foundry.v2.models._trigger import OrTrigger -from foundry.v2.models._trigger import Trigger -from foundry.v2.models._trigger_dict import AndTriggerDict -from foundry.v2.models._trigger_dict import OrTriggerDict -from foundry.v2.models._trigger_dict import TriggerDict -from foundry.v2.models._two_dimensional_aggregation import TwoDimensionalAggregation -from foundry.v2.models._two_dimensional_aggregation_dict import ( - TwoDimensionalAggregationDict, -) # NOQA -from foundry.v2.models._unevaluable_constraint import UnevaluableConstraint -from foundry.v2.models._unevaluable_constraint_dict import UnevaluableConstraintDict -from foundry.v2.models._unsupported_type import UnsupportedType -from foundry.v2.models._unsupported_type_dict import UnsupportedTypeDict -from foundry.v2.models._updated_by import UpdatedBy -from foundry.v2.models._updated_time import UpdatedTime -from foundry.v2.models._upstream_target import UpstreamTarget -from foundry.v2.models._upstream_target_dict import UpstreamTargetDict -from foundry.v2.models._user import User -from foundry.v2.models._user_dict import UserDict -from foundry.v2.models._user_id import UserId -from foundry.v2.models._user_scope import UserScope -from foundry.v2.models._user_scope_dict import UserScopeDict -from foundry.v2.models._user_search_filter import UserSearchFilter -from foundry.v2.models._user_search_filter_dict import UserSearchFilterDict -from foundry.v2.models._user_username import UserUsername -from foundry.v2.models._validate_action_request import ValidateActionRequest -from foundry.v2.models._validate_action_request_dict import ValidateActionRequestDict -from foundry.v2.models._validate_action_response import ValidateActionResponse -from foundry.v2.models._validate_action_response_dict import ValidateActionResponseDict -from foundry.v2.models._validate_action_response_v2 import ValidateActionResponseV2 -from foundry.v2.models._validate_action_response_v2_dict import ValidateActionResponseV2Dict # NOQA -from foundry.v2.models._validation_result import ValidationResult -from foundry.v2.models._value_type import ValueType -from foundry.v2.models._version import Version -from foundry.v2.models._version_dict import VersionDict -from foundry.v2.models._version_version import VersionVersion -from foundry.v2.models._website import Website -from foundry.v2.models._website_dict import WebsiteDict -from foundry.v2.models._within_bounding_box_point import WithinBoundingBoxPoint -from foundry.v2.models._within_bounding_box_point_dict import WithinBoundingBoxPointDict -from foundry.v2.models._within_bounding_box_query import WithinBoundingBoxQuery -from foundry.v2.models._within_bounding_box_query_dict import WithinBoundingBoxQueryDict -from foundry.v2.models._within_distance_of_query import WithinDistanceOfQuery -from foundry.v2.models._within_distance_of_query_dict import WithinDistanceOfQueryDict -from foundry.v2.models._within_polygon_query import WithinPolygonQuery -from foundry.v2.models._within_polygon_query_dict import WithinPolygonQueryDict -from foundry.v2.models._zone_id import ZoneId - -__all__ = [ - "AbortOnFailure", - "AbsoluteTimeRange", - "AbsoluteTimeRangeDict", - "Action", - "ActionDict", - "ActionMode", - "ActionParameterArrayType", - "ActionParameterArrayTypeDict", - "ActionParameterType", - "ActionParameterTypeDict", - "ActionParameterV2", - "ActionParameterV2Dict", - "ActionResults", - "ActionResultsDict", - "ActionRid", - "ActionType", - "ActionTypeApiName", - "ActionTypeDict", - "ActionTypeRid", - "ActionTypeV2", - "ActionTypeV2Dict", - "AddGroupMembersRequest", - "AddGroupMembersRequestDict", - "AddLink", - "AddLinkDict", - "AddObject", - "AddObjectDict", - "AggregateObjectSetRequestV2", - "AggregateObjectSetRequestV2Dict", - "AggregateObjectsRequest", - "AggregateObjectsRequestDict", - "AggregateObjectsRequestV2", - "AggregateObjectsRequestV2Dict", - "AggregateObjectsResponse", - "AggregateObjectsResponseDict", - "AggregateObjectsResponseItem", - "AggregateObjectsResponseItemDict", - "AggregateObjectsResponseItemV2", - "AggregateObjectsResponseItemV2Dict", - "AggregateObjectsResponseV2", - "AggregateObjectsResponseV2Dict", - "Aggregation", - "AggregationAccuracy", - "AggregationAccuracyRequest", - "AggregationDict", - "AggregationDurationGrouping", - "AggregationDurationGroupingDict", - "AggregationDurationGroupingV2", - "AggregationDurationGroupingV2Dict", - "AggregationExactGrouping", - "AggregationExactGroupingDict", - "AggregationExactGroupingV2", - "AggregationExactGroupingV2Dict", - "AggregationFixedWidthGrouping", - "AggregationFixedWidthGroupingDict", - "AggregationFixedWidthGroupingV2", - "AggregationFixedWidthGroupingV2Dict", - "AggregationGroupBy", - "AggregationGroupByDict", - "AggregationGroupByV2", - "AggregationGroupByV2Dict", - "AggregationGroupKey", - "AggregationGroupKeyV2", - "AggregationGroupValue", - "AggregationGroupValueV2", - "AggregationMetricName", - "AggregationMetricResult", - "AggregationMetricResultDict", - "AggregationMetricResultV2", - "AggregationMetricResultV2Dict", - "AggregationObjectTypeGrouping", - "AggregationObjectTypeGroupingDict", - "AggregationOrderBy", - "AggregationOrderByDict", - "AggregationRange", - "AggregationRangeDict", - "AggregationRangesGrouping", - "AggregationRangesGroupingDict", - "AggregationRangesGroupingV2", - "AggregationRangesGroupingV2Dict", - "AggregationRangeV2", - "AggregationRangeV2Dict", - "AggregationV2", - "AggregationV2Dict", - "AllTermsQuery", - "AllTermsQueryDict", - "AndQuery", - "AndQueryDict", - "AndQueryV2", - "AndQueryV2Dict", - "AndTrigger", - "AndTriggerDict", - "AnyTermQuery", - "AnyTermQueryDict", - "AnyType", - "AnyTypeDict", - "ApiDefinition", - "ApiDefinitionDeprecated", - "ApiDefinitionDict", - "ApiDefinitionName", - "ApiDefinitionRid", - "ApplyActionMode", - "ApplyActionRequest", - "ApplyActionRequestDict", - "ApplyActionRequestOptions", - "ApplyActionRequestOptionsDict", - "ApplyActionRequestV2", - "ApplyActionRequestV2Dict", - "ApplyActionResponse", - "ApplyActionResponseDict", - "ApproximateDistinctAggregation", - "ApproximateDistinctAggregationDict", - "ApproximateDistinctAggregationV2", - "ApproximateDistinctAggregationV2Dict", - "ApproximatePercentileAggregationV2", - "ApproximatePercentileAggregationV2Dict", - "ArchiveFileFormat", - "Arg", - "ArgDict", - "ArraySizeConstraint", - "ArraySizeConstraintDict", - "ArtifactRepositoryRid", - "AsyncActionStatus", - "AsyncApplyActionOperationResponseV2", - "AsyncApplyActionOperationResponseV2Dict", - "AsyncApplyActionRequest", - "AsyncApplyActionRequestDict", - "AsyncApplyActionRequestV2", - "AsyncApplyActionRequestV2Dict", - "AsyncApplyActionResponse", - "AsyncApplyActionResponseDict", - "AsyncApplyActionResponseV2", - "AsyncApplyActionResponseV2Dict", - "Attachment", - "AttachmentDict", - "AttachmentMetadataResponse", - "AttachmentMetadataResponseDict", - "AttachmentProperty", - "AttachmentPropertyDict", - "AttachmentRid", - "AttachmentType", - "AttachmentTypeDict", - "AttachmentV2", - "AttachmentV2Dict", - "AttributeName", - "AttributeValue", - "AttributeValues", - "AvgAggregation", - "AvgAggregationDict", - "AvgAggregationV2", - "AvgAggregationV2Dict", - "BatchApplyActionRequest", - "BatchApplyActionRequestDict", - "BatchApplyActionRequestItem", - "BatchApplyActionRequestItemDict", - "BatchApplyActionRequestOptions", - "BatchApplyActionRequestOptionsDict", - "BatchApplyActionRequestV2", - "BatchApplyActionRequestV2Dict", - "BatchApplyActionResponse", - "BatchApplyActionResponseDict", - "BatchApplyActionResponseV2", - "BatchApplyActionResponseV2Dict", - "BBox", - "BinaryType", - "BinaryTypeDict", - "BlueprintIcon", - "BlueprintIconDict", - "BooleanType", - "BooleanTypeDict", - "BoundingBoxValue", - "BoundingBoxValueDict", - "Branch", - "BranchDict", - "BranchId", - "BranchName", - "Build", - "BuildDict", - "BuildRid", - "BuildStatus", - "BuildTarget", - "BuildTargetDict", - "ByteType", - "ByteTypeDict", - "CenterPoint", - "CenterPointDict", - "CenterPointTypes", - "CenterPointTypesDict", - "ConnectingTarget", - "ConnectingTargetDict", - "ContainsAllTermsInOrderPrefixLastTerm", - "ContainsAllTermsInOrderPrefixLastTermDict", - "ContainsAllTermsInOrderQuery", - "ContainsAllTermsInOrderQueryDict", - "ContainsAllTermsQuery", - "ContainsAllTermsQueryDict", - "ContainsAnyTermQuery", - "ContainsAnyTermQueryDict", - "ContainsQuery", - "ContainsQueryDict", - "ContainsQueryV2", - "ContainsQueryV2Dict", - "ContentLength", - "ContentType", - "Coordinate", - "CountAggregation", - "CountAggregationDict", - "CountAggregationV2", - "CountAggregationV2Dict", - "CountObjectsResponseV2", - "CountObjectsResponseV2Dict", - "CreateBranchRequest", - "CreateBranchRequestDict", - "CreateBuildsRequest", - "CreateBuildsRequestDict", - "CreateDatasetRequest", - "CreateDatasetRequestDict", - "CreatedBy", - "CreatedTime", - "CreateGroupRequest", - "CreateGroupRequestDict", - "CreateLinkRule", - "CreateLinkRuleDict", - "CreateObjectRule", - "CreateObjectRuleDict", - "CreateTemporaryObjectSetRequestV2", - "CreateTemporaryObjectSetRequestV2Dict", - "CreateTemporaryObjectSetResponseV2", - "CreateTemporaryObjectSetResponseV2Dict", - "CreateTransactionRequest", - "CreateTransactionRequestDict", - "CronExpression", - "CustomTypeId", - "Dataset", - "DatasetDict", - "DatasetName", - "DatasetRid", - "DatasetUpdatedTrigger", - "DatasetUpdatedTriggerDict", - "DataValue", - "DateType", - "DateTypeDict", - "DecimalType", - "DecimalTypeDict", - "DeleteLinkRule", - "DeleteLinkRuleDict", - "DeleteObjectRule", - "DeleteObjectRuleDict", - "DeployWebsiteRequest", - "DeployWebsiteRequestDict", - "DisplayName", - "Distance", - "DistanceDict", - "DistanceUnit", - "DoesNotIntersectBoundingBoxQuery", - "DoesNotIntersectBoundingBoxQueryDict", - "DoesNotIntersectPolygonQuery", - "DoesNotIntersectPolygonQueryDict", - "DoubleType", - "DoubleTypeDict", - "Duration", - "DurationDict", - "EqualsQuery", - "EqualsQueryDict", - "EqualsQueryV2", - "EqualsQueryV2Dict", - "Error", - "ErrorDict", - "ErrorName", - "ExactDistinctAggregationV2", - "ExactDistinctAggregationV2Dict", - "ExecuteQueryRequest", - "ExecuteQueryRequestDict", - "ExecuteQueryResponse", - "ExecuteQueryResponseDict", - "FallbackBranches", - "Feature", - "FeatureCollection", - "FeatureCollectionDict", - "FeatureCollectionTypes", - "FeatureCollectionTypesDict", - "FeatureDict", - "FeaturePropertyKey", - "FieldNameV1", - "File", - "FileDict", - "Filename", - "FilePath", - "FilesystemResource", - "FilesystemResourceDict", - "FileUpdatedTime", - "FilterValue", - "FloatType", - "FloatTypeDict", - "Folder", - "FolderDict", - "FolderRid", - "ForceBuild", - "FunctionRid", - "FunctionVersion", - "Fuzzy", - "FuzzyV2", - "GeoJsonObject", - "GeoJsonObjectDict", - "Geometry", - "GeometryCollection", - "GeometryCollectionDict", - "GeometryDict", - "GeoPoint", - "GeoPointDict", - "GeoPointType", - "GeoPointTypeDict", - "GeoShapeType", - "GeoShapeTypeDict", - "GeotimeSeriesValue", - "GeotimeSeriesValueDict", - "GetGroupsBatchRequestElement", - "GetGroupsBatchRequestElementDict", - "GetGroupsBatchResponse", - "GetGroupsBatchResponseDict", - "GetUsersBatchRequestElement", - "GetUsersBatchRequestElementDict", - "GetUsersBatchResponse", - "GetUsersBatchResponseDict", - "Group", - "GroupDict", - "GroupMember", - "GroupMemberConstraint", - "GroupMemberConstraintDict", - "GroupMemberDict", - "GroupMembership", - "GroupMembershipDict", - "GroupMembershipExpiration", - "GroupName", - "GroupSearchFilter", - "GroupSearchFilterDict", - "GteQuery", - "GteQueryDict", - "GteQueryV2", - "GteQueryV2Dict", - "GtQuery", - "GtQueryDict", - "GtQueryV2", - "GtQueryV2Dict", - "Icon", - "IconDict", - "IntegerType", - "IntegerTypeDict", - "InterfaceLinkType", - "InterfaceLinkTypeApiName", - "InterfaceLinkTypeCardinality", - "InterfaceLinkTypeDict", - "InterfaceLinkTypeLinkedEntityApiName", - "InterfaceLinkTypeLinkedEntityApiNameDict", - "InterfaceLinkTypeRid", - "InterfaceType", - "InterfaceTypeApiName", - "InterfaceTypeDict", - "InterfaceTypeRid", - "IntersectsBoundingBoxQuery", - "IntersectsBoundingBoxQueryDict", - "IntersectsPolygonQuery", - "IntersectsPolygonQueryDict", - "IrVersion", - "IsNullQuery", - "IsNullQueryDict", - "IsNullQueryV2", - "IsNullQueryV2Dict", - "JobSucceededTrigger", - "JobSucceededTriggerDict", - "LinearRing", - "LineString", - "LineStringCoordinates", - "LineStringDict", - "LinkedInterfaceTypeApiName", - "LinkedInterfaceTypeApiNameDict", - "LinkedObjectTypeApiName", - "LinkedObjectTypeApiNameDict", - "LinkSideObject", - "LinkSideObjectDict", - "LinkTypeApiName", - "LinkTypeRid", - "LinkTypeSide", - "LinkTypeSideCardinality", - "LinkTypeSideDict", - "LinkTypeSideV2", - "LinkTypeSideV2Dict", - "ListActionTypesResponse", - "ListActionTypesResponseDict", - "ListActionTypesResponseV2", - "ListActionTypesResponseV2Dict", - "ListAttachmentsResponseV2", - "ListAttachmentsResponseV2Dict", - "ListBranchesResponse", - "ListBranchesResponseDict", - "ListFilesResponse", - "ListFilesResponseDict", - "ListGroupMembershipsResponse", - "ListGroupMembershipsResponseDict", - "ListGroupMembersResponse", - "ListGroupMembersResponseDict", - "ListGroupsResponse", - "ListGroupsResponseDict", - "ListInterfaceTypesResponse", - "ListInterfaceTypesResponseDict", - "ListLinkedObjectsResponse", - "ListLinkedObjectsResponseDict", - "ListLinkedObjectsResponseV2", - "ListLinkedObjectsResponseV2Dict", - "ListObjectsResponse", - "ListObjectsResponseDict", - "ListObjectsResponseV2", - "ListObjectsResponseV2Dict", - "ListObjectTypesResponse", - "ListObjectTypesResponseDict", - "ListObjectTypesV2Response", - "ListObjectTypesV2ResponseDict", - "ListOntologiesResponse", - "ListOntologiesResponseDict", - "ListOntologiesV2Response", - "ListOntologiesV2ResponseDict", - "ListOutgoingLinkTypesResponse", - "ListOutgoingLinkTypesResponseDict", - "ListOutgoingLinkTypesResponseV2", - "ListOutgoingLinkTypesResponseV2Dict", - "ListQueryTypesResponse", - "ListQueryTypesResponseDict", - "ListQueryTypesResponseV2", - "ListQueryTypesResponseV2Dict", - "ListUsersResponse", - "ListUsersResponseDict", - "ListVersionsResponse", - "ListVersionsResponseDict", - "LoadObjectSetRequestV2", - "LoadObjectSetRequestV2Dict", - "LoadObjectSetResponseV2", - "LoadObjectSetResponseV2Dict", - "LocalFilePath", - "LocalFilePathDict", - "LogicRule", - "LogicRuleDict", - "LongType", - "LongTypeDict", - "LteQuery", - "LteQueryDict", - "LteQueryV2", - "LteQueryV2Dict", - "LtQuery", - "LtQueryDict", - "LtQueryV2", - "LtQueryV2Dict", - "ManualTarget", - "ManualTargetDict", - "MarkingType", - "MarkingTypeDict", - "MaxAggregation", - "MaxAggregationDict", - "MaxAggregationV2", - "MaxAggregationV2Dict", - "MediaSetRid", - "MediaSetUpdatedTrigger", - "MediaSetUpdatedTriggerDict", - "MediaType", - "MinAggregation", - "MinAggregationDict", - "MinAggregationV2", - "MinAggregationV2Dict", - "ModifyObject", - "ModifyObjectDict", - "ModifyObjectRule", - "ModifyObjectRuleDict", - "MultiLineString", - "MultiLineStringDict", - "MultiPoint", - "MultiPointDict", - "MultiPolygon", - "MultiPolygonDict", - "NestedQueryAggregation", - "NestedQueryAggregationDict", - "NewLogicTrigger", - "NewLogicTriggerDict", - "NotificationsEnabled", - "NotQuery", - "NotQueryDict", - "NotQueryV2", - "NotQueryV2Dict", - "NullType", - "NullTypeDict", - "ObjectEdit", - "ObjectEditDict", - "ObjectEdits", - "ObjectEditsDict", - "ObjectPrimaryKey", - "ObjectPropertyType", - "ObjectPropertyTypeDict", - "ObjectPropertyValueConstraint", - "ObjectPropertyValueConstraintDict", - "ObjectQueryResultConstraint", - "ObjectQueryResultConstraintDict", - "ObjectRid", - "ObjectSet", - "ObjectSetBaseType", - "ObjectSetBaseTypeDict", - "ObjectSetDict", - "ObjectSetFilterType", - "ObjectSetFilterTypeDict", - "ObjectSetIntersectionType", - "ObjectSetIntersectionTypeDict", - "ObjectSetReferenceType", - "ObjectSetReferenceTypeDict", - "ObjectSetRid", - "ObjectSetSearchAroundType", - "ObjectSetSearchAroundTypeDict", - "ObjectSetStaticType", - "ObjectSetStaticTypeDict", - "ObjectSetStreamSubscribeRequest", - "ObjectSetStreamSubscribeRequestDict", - "ObjectSetStreamSubscribeRequests", - "ObjectSetStreamSubscribeRequestsDict", - "ObjectSetSubscribeResponse", - "ObjectSetSubscribeResponseDict", - "ObjectSetSubscribeResponses", - "ObjectSetSubscribeResponsesDict", - "ObjectSetSubtractType", - "ObjectSetSubtractTypeDict", - "ObjectSetUnionType", - "ObjectSetUnionTypeDict", - "ObjectSetUpdate", - "ObjectSetUpdateDict", - "ObjectSetUpdates", - "ObjectSetUpdatesDict", - "ObjectState", - "ObjectType", - "ObjectTypeApiName", - "ObjectTypeDict", - "ObjectTypeEdits", - "ObjectTypeEditsDict", - "ObjectTypeFullMetadata", - "ObjectTypeFullMetadataDict", - "ObjectTypeInterfaceImplementation", - "ObjectTypeInterfaceImplementationDict", - "ObjectTypeRid", - "ObjectTypeV2", - "ObjectTypeV2Dict", - "ObjectTypeVisibility", - "ObjectUpdate", - "ObjectUpdateDict", - "OneOfConstraint", - "OneOfConstraintDict", - "Ontology", - "OntologyApiName", - "OntologyArrayType", - "OntologyArrayTypeDict", - "OntologyDataType", - "OntologyDataTypeDict", - "OntologyDict", - "OntologyFullMetadata", - "OntologyFullMetadataDict", - "OntologyIdentifier", - "OntologyMapType", - "OntologyMapTypeDict", - "OntologyObject", - "OntologyObjectArrayType", - "OntologyObjectArrayTypeDict", - "OntologyObjectDict", - "OntologyObjectSetType", - "OntologyObjectSetTypeDict", - "OntologyObjectType", - "OntologyObjectTypeDict", - "OntologyObjectV2", - "OntologyRid", - "OntologySetType", - "OntologySetTypeDict", - "OntologyStructField", - "OntologyStructFieldDict", - "OntologyStructType", - "OntologyStructTypeDict", - "OntologyV2", - "OntologyV2Dict", - "OrderBy", - "OrderByDirection", - "OrganizationRid", - "OrQuery", - "OrQueryDict", - "OrQueryV2", - "OrQueryV2Dict", - "OrTrigger", - "OrTriggerDict", - "PageSize", - "PageToken", - "Parameter", - "ParameterDict", - "ParameterEvaluatedConstraint", - "ParameterEvaluatedConstraintDict", - "ParameterEvaluationResult", - "ParameterEvaluationResultDict", - "ParameterId", - "ParameterOption", - "ParameterOptionDict", - "PhraseQuery", - "PhraseQueryDict", - "Polygon", - "PolygonDict", - "PolygonValue", - "PolygonValueDict", - "Position", - "PrefixQuery", - "PrefixQueryDict", - "PreviewMode", - "PrimaryKeyValue", - "PrincipalFilterType", - "PrincipalId", - "PrincipalType", - "Project", - "ProjectDict", - "ProjectRid", - "ProjectScope", - "ProjectScopeDict", - "Property", - "PropertyApiName", - "PropertyDict", - "PropertyFilter", - "PropertyId", - "PropertyV2", - "PropertyV2Dict", - "PropertyValue", - "PropertyValueEscapedString", - "QosError", - "QosErrorDict", - "QueryAggregation", - "QueryAggregationDict", - "QueryAggregationKeyType", - "QueryAggregationKeyTypeDict", - "QueryAggregationRange", - "QueryAggregationRangeDict", - "QueryAggregationRangeSubType", - "QueryAggregationRangeSubTypeDict", - "QueryAggregationRangeType", - "QueryAggregationRangeTypeDict", - "QueryAggregationValueType", - "QueryAggregationValueTypeDict", - "QueryApiName", - "QueryArrayType", - "QueryArrayTypeDict", - "QueryDataType", - "QueryDataTypeDict", - "QueryOutputV2", - "QueryOutputV2Dict", - "QueryParameterV2", - "QueryParameterV2Dict", - "QueryRuntimeErrorParameter", - "QuerySetType", - "QuerySetTypeDict", - "QueryStructField", - "QueryStructFieldDict", - "QueryStructType", - "QueryStructTypeDict", - "QueryThreeDimensionalAggregation", - "QueryThreeDimensionalAggregationDict", - "QueryTwoDimensionalAggregation", - "QueryTwoDimensionalAggregationDict", - "QueryType", - "QueryTypeDict", - "QueryTypeV2", - "QueryTypeV2Dict", - "QueryUnionType", - "QueryUnionTypeDict", - "RangeConstraint", - "RangeConstraintDict", - "Realm", - "Reason", - "ReasonDict", - "ReasonType", - "ReferenceUpdate", - "ReferenceUpdateDict", - "ReferenceValue", - "ReferenceValueDict", - "RefreshObjectSet", - "RefreshObjectSetDict", - "RelativeTime", - "RelativeTimeDict", - "RelativeTimeRange", - "RelativeTimeRangeDict", - "RelativeTimeRelation", - "RelativeTimeSeriesTimeUnit", - "ReleaseStatus", - "RemoveGroupMembersRequest", - "RemoveGroupMembersRequestDict", - "RequestId", - "Resource", - "ResourceDict", - "ResourceDisplayName", - "ResourcePath", - "ResourceRid", - "ResourceType", - "RetryBackoffDuration", - "RetryBackoffDurationDict", - "RetryCount", - "ReturnEditsMode", - "Schedule", - "ScheduleDict", - "SchedulePaused", - "ScheduleRid", - "ScheduleRun", - "ScheduleRunDict", - "ScheduleRunError", - "ScheduleRunErrorDict", - "ScheduleRunErrorName", - "ScheduleRunIgnored", - "ScheduleRunIgnoredDict", - "ScheduleRunResult", - "ScheduleRunResultDict", - "ScheduleRunRid", - "ScheduleRunSubmitted", - "ScheduleRunSubmittedDict", - "ScheduleSucceededTrigger", - "ScheduleSucceededTriggerDict", - "ScheduleVersion", - "ScheduleVersionDict", - "ScheduleVersionRid", - "ScopeMode", - "ScopeModeDict", - "SdkPackageName", - "SearchGroupsRequest", - "SearchGroupsRequestDict", - "SearchGroupsResponse", - "SearchGroupsResponseDict", - "SearchJsonQuery", - "SearchJsonQueryDict", - "SearchJsonQueryV2", - "SearchJsonQueryV2Dict", - "SearchObjectsForInterfaceRequest", - "SearchObjectsForInterfaceRequestDict", - "SearchObjectsRequest", - "SearchObjectsRequestDict", - "SearchObjectsRequestV2", - "SearchObjectsRequestV2Dict", - "SearchObjectsResponse", - "SearchObjectsResponseDict", - "SearchObjectsResponseV2", - "SearchObjectsResponseV2Dict", - "SearchOrderBy", - "SearchOrderByDict", - "SearchOrderByV2", - "SearchOrderByV2Dict", - "SearchOrdering", - "SearchOrderingDict", - "SearchOrderingV2", - "SearchOrderingV2Dict", - "SearchUsersRequest", - "SearchUsersRequestDict", - "SearchUsersResponse", - "SearchUsersResponseDict", - "SelectedPropertyApiName", - "SharedPropertyType", - "SharedPropertyTypeApiName", - "SharedPropertyTypeDict", - "SharedPropertyTypeRid", - "ShortType", - "ShortTypeDict", - "SizeBytes", - "Space", - "SpaceDict", - "SpaceRid", - "StartsWithQuery", - "StartsWithQueryDict", - "StreamMessage", - "StreamMessageDict", - "StreamTimeSeriesPointsRequest", - "StreamTimeSeriesPointsRequestDict", - "StreamTimeSeriesPointsResponse", - "StreamTimeSeriesPointsResponseDict", - "StringLengthConstraint", - "StringLengthConstraintDict", - "StringRegexMatchConstraint", - "StringRegexMatchConstraintDict", - "StringType", - "StringTypeDict", - "StructFieldName", - "Subdomain", - "SubmissionCriteriaEvaluation", - "SubmissionCriteriaEvaluationDict", - "SubscriptionClosed", - "SubscriptionClosedDict", - "SubscriptionClosureCause", - "SubscriptionClosureCauseDict", - "SubscriptionError", - "SubscriptionErrorDict", - "SubscriptionId", - "SubscriptionSuccess", - "SubscriptionSuccessDict", - "SumAggregation", - "SumAggregationDict", - "SumAggregationV2", - "SumAggregationV2Dict", - "SyncApplyActionResponseV2", - "SyncApplyActionResponseV2Dict", - "TableExportFormat", - "ThirdPartyApplication", - "ThirdPartyApplicationDict", - "ThirdPartyApplicationRid", - "ThreeDimensionalAggregation", - "ThreeDimensionalAggregationDict", - "TimeRange", - "TimeRangeDict", - "TimeSeriesItemType", - "TimeSeriesItemTypeDict", - "TimeSeriesPoint", - "TimeSeriesPointDict", - "TimeseriesType", - "TimeseriesTypeDict", - "TimestampType", - "TimestampTypeDict", - "TimeTrigger", - "TimeTriggerDict", - "TimeUnit", - "TotalCount", - "Transaction", - "TransactionCreatedTime", - "TransactionDict", - "TransactionRid", - "TransactionStatus", - "TransactionType", - "TrashedStatus", - "Trigger", - "TriggerDict", - "TwoDimensionalAggregation", - "TwoDimensionalAggregationDict", - "UnevaluableConstraint", - "UnevaluableConstraintDict", - "UnsupportedType", - "UnsupportedTypeDict", - "UpdatedBy", - "UpdatedTime", - "UpstreamTarget", - "UpstreamTargetDict", - "User", - "UserDict", - "UserId", - "UserScope", - "UserScopeDict", - "UserSearchFilter", - "UserSearchFilterDict", - "UserUsername", - "ValidateActionRequest", - "ValidateActionRequestDict", - "ValidateActionResponse", - "ValidateActionResponseDict", - "ValidateActionResponseV2", - "ValidateActionResponseV2Dict", - "ValidationResult", - "ValueType", - "Version", - "VersionDict", - "VersionVersion", - "Website", - "WebsiteDict", - "WithinBoundingBoxPoint", - "WithinBoundingBoxPointDict", - "WithinBoundingBoxQuery", - "WithinBoundingBoxQueryDict", - "WithinDistanceOfQuery", - "WithinDistanceOfQueryDict", - "WithinPolygonQuery", - "WithinPolygonQueryDict", - "ZoneId", -] diff --git a/foundry/v2/models/_absolute_time_range.py b/foundry/v2/models/_absolute_time_range.py deleted file mode 100644 index 6c85c359..00000000 --- a/foundry/v2/models/_absolute_time_range.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._absolute_time_range_dict import AbsoluteTimeRangeDict - - -class AbsoluteTimeRange(BaseModel): - """ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.""" - - start_time: Optional[datetime] = Field(alias="startTime", default=None) - - end_time: Optional[datetime] = Field(alias="endTime", default=None) - - type: Literal["absolute"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AbsoluteTimeRangeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AbsoluteTimeRangeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_absolute_time_range_dict.py b/foundry/v2/models/_absolute_time_range_dict.py deleted file mode 100644 index 2f92014b..00000000 --- a/foundry/v2/models/_absolute_time_range_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - - -class AbsoluteTimeRangeDict(TypedDict): - """ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - startTime: NotRequired[datetime] - - endTime: NotRequired[datetime] - - type: Literal["absolute"] diff --git a/foundry/v2/models/_action.py b/foundry/v2/models/_action.py deleted file mode 100644 index a33c3d29..00000000 --- a/foundry/v2/models/_action.py +++ /dev/null @@ -1,61 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._abort_on_failure import AbortOnFailure -from foundry.v2.models._action_dict import ActionDict -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._build_target import BuildTarget -from foundry.v2.models._fallback_branches import FallbackBranches -from foundry.v2.models._force_build import ForceBuild -from foundry.v2.models._notifications_enabled import NotificationsEnabled -from foundry.v2.models._retry_backoff_duration import RetryBackoffDuration -from foundry.v2.models._retry_count import RetryCount - - -class Action(BaseModel): - """Action""" - - target: BuildTarget - - branch_name: BranchName = Field(alias="branchName") - """The target branch the schedule should run on.""" - - fallback_branches: FallbackBranches = Field(alias="fallbackBranches") - - force_build: ForceBuild = Field(alias="forceBuild") - - retry_count: Optional[RetryCount] = Field(alias="retryCount", default=None) - - retry_backoff_duration: Optional[RetryBackoffDuration] = Field( - alias="retryBackoffDuration", default=None - ) - - abort_on_failure: AbortOnFailure = Field(alias="abortOnFailure") - - notifications_enabled: NotificationsEnabled = Field(alias="notificationsEnabled") - - model_config = {"extra": "allow"} - - def to_dict(self) -> ActionDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ActionDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_action_dict.py b/foundry/v2/models/_action_dict.py deleted file mode 100644 index ac0742e7..00000000 --- a/foundry/v2/models/_action_dict.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._abort_on_failure import AbortOnFailure -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._build_target_dict import BuildTargetDict -from foundry.v2.models._fallback_branches import FallbackBranches -from foundry.v2.models._force_build import ForceBuild -from foundry.v2.models._notifications_enabled import NotificationsEnabled -from foundry.v2.models._retry_backoff_duration_dict import RetryBackoffDurationDict -from foundry.v2.models._retry_count import RetryCount - - -class ActionDict(TypedDict): - """Action""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - target: BuildTargetDict - - branchName: BranchName - """The target branch the schedule should run on.""" - - fallbackBranches: FallbackBranches - - forceBuild: ForceBuild - - retryCount: NotRequired[RetryCount] - - retryBackoffDuration: NotRequired[RetryBackoffDurationDict] - - abortOnFailure: AbortOnFailure - - notificationsEnabled: NotificationsEnabled diff --git a/foundry/v2/models/_action_mode.py b/foundry/v2/models/_action_mode.py deleted file mode 100644 index 1c1c159a..00000000 --- a/foundry/v2/models/_action_mode.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -ActionMode = Literal["ASYNC", "RUN", "VALIDATE"] -"""ActionMode""" diff --git a/foundry/v2/models/_action_parameter_type.py b/foundry/v2/models/_action_parameter_type.py deleted file mode 100644 index 3f67aed3..00000000 --- a/foundry/v2/models/_action_parameter_type.py +++ /dev/null @@ -1,73 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._action_parameter_type_dict import ActionParameterArrayTypeDict -from foundry.v2.models._attachment_type import AttachmentType -from foundry.v2.models._boolean_type import BooleanType -from foundry.v2.models._date_type import DateType -from foundry.v2.models._double_type import DoubleType -from foundry.v2.models._integer_type import IntegerType -from foundry.v2.models._long_type import LongType -from foundry.v2.models._marking_type import MarkingType -from foundry.v2.models._ontology_object_set_type import OntologyObjectSetType -from foundry.v2.models._ontology_object_type import OntologyObjectType -from foundry.v2.models._string_type import StringType -from foundry.v2.models._timestamp_type import TimestampType - - -class ActionParameterArrayType(BaseModel): - """ActionParameterArrayType""" - - sub_type: ActionParameterType = Field(alias="subType") - - type: Literal["array"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ActionParameterArrayTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ActionParameterArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True) - ) - - -ActionParameterType = Annotated[ - Union[ - ActionParameterArrayType, - AttachmentType, - BooleanType, - DateType, - DoubleType, - IntegerType, - LongType, - MarkingType, - OntologyObjectSetType, - OntologyObjectType, - StringType, - TimestampType, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Action parameters.""" diff --git a/foundry/v2/models/_action_parameter_type_dict.py b/foundry/v2/models/_action_parameter_type_dict.py deleted file mode 100644 index e2de14f8..00000000 --- a/foundry/v2/models/_action_parameter_type_dict.py +++ /dev/null @@ -1,65 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import TypedDict - -from foundry.v2.models._attachment_type_dict import AttachmentTypeDict -from foundry.v2.models._boolean_type_dict import BooleanTypeDict -from foundry.v2.models._date_type_dict import DateTypeDict -from foundry.v2.models._double_type_dict import DoubleTypeDict -from foundry.v2.models._integer_type_dict import IntegerTypeDict -from foundry.v2.models._long_type_dict import LongTypeDict -from foundry.v2.models._marking_type_dict import MarkingTypeDict -from foundry.v2.models._ontology_object_set_type_dict import OntologyObjectSetTypeDict -from foundry.v2.models._ontology_object_type_dict import OntologyObjectTypeDict -from foundry.v2.models._string_type_dict import StringTypeDict -from foundry.v2.models._timestamp_type_dict import TimestampTypeDict - - -class ActionParameterArrayTypeDict(TypedDict): - """ActionParameterArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: ActionParameterTypeDict - - type: Literal["array"] - - -ActionParameterTypeDict = Annotated[ - Union[ - ActionParameterArrayTypeDict, - AttachmentTypeDict, - BooleanTypeDict, - DateTypeDict, - DoubleTypeDict, - IntegerTypeDict, - LongTypeDict, - MarkingTypeDict, - OntologyObjectSetTypeDict, - OntologyObjectTypeDict, - StringTypeDict, - TimestampTypeDict, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Action parameters.""" diff --git a/foundry/v2/models/_action_parameter_v2.py b/foundry/v2/models/_action_parameter_v2.py deleted file mode 100644 index 09c9382c..00000000 --- a/foundry/v2/models/_action_parameter_v2.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool -from pydantic import StrictStr - -from foundry.v2.models._action_parameter_type import ActionParameterType -from foundry.v2.models._action_parameter_v2_dict import ActionParameterV2Dict - - -class ActionParameterV2(BaseModel): - """Details about a parameter of an action.""" - - description: Optional[StrictStr] = None - - data_type: ActionParameterType = Field(alias="dataType") - - required: StrictBool - - model_config = {"extra": "allow"} - - def to_dict(self) -> ActionParameterV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ActionParameterV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_action_parameter_v2_dict.py b/foundry/v2/models/_action_parameter_v2_dict.py deleted file mode 100644 index eb191151..00000000 --- a/foundry/v2/models/_action_parameter_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictBool -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._action_parameter_type_dict import ActionParameterTypeDict - - -class ActionParameterV2Dict(TypedDict): - """Details about a parameter of an action.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: NotRequired[StrictStr] - - dataType: ActionParameterTypeDict - - required: StrictBool diff --git a/foundry/v2/models/_action_results.py b/foundry/v2/models/_action_results.py deleted file mode 100644 index 84115bdd..00000000 --- a/foundry/v2/models/_action_results.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._object_edits import ObjectEdits -from foundry.v2.models._object_type_edits import ObjectTypeEdits - -ActionResults = Annotated[Union[ObjectEdits, ObjectTypeEdits], Field(discriminator="type")] -"""ActionResults""" diff --git a/foundry/v2/models/_action_results_dict.py b/foundry/v2/models/_action_results_dict.py deleted file mode 100644 index 1d1ac147..00000000 --- a/foundry/v2/models/_action_results_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._object_edits_dict import ObjectEditsDict -from foundry.v2.models._object_type_edits_dict import ObjectTypeEditsDict - -ActionResultsDict = Annotated[ - Union[ObjectEditsDict, ObjectTypeEditsDict], Field(discriminator="type") -] -"""ActionResults""" diff --git a/foundry/v2/models/_action_rid.py b/foundry/v2/models/_action_rid.py deleted file mode 100644 index ab25db69..00000000 --- a/foundry/v2/models/_action_rid.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import RID - -ActionRid = RID -"""The unique resource identifier for an action.""" diff --git a/foundry/v2/models/_action_type.py b/foundry/v2/models/_action_type.py deleted file mode 100644 index c17fd0d6..00000000 --- a/foundry/v2/models/_action_type.py +++ /dev/null @@ -1,58 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._action_type_api_name import ActionTypeApiName -from foundry.v2.models._action_type_dict import ActionTypeDict -from foundry.v2.models._action_type_rid import ActionTypeRid -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._logic_rule import LogicRule -from foundry.v2.models._parameter import Parameter -from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._release_status import ReleaseStatus - - -class ActionType(BaseModel): - """Represents an action type in the Ontology.""" - - api_name: ActionTypeApiName = Field(alias="apiName") - - description: Optional[StrictStr] = None - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - status: ReleaseStatus - - parameters: Dict[ParameterId, Parameter] - - rid: ActionTypeRid - - operations: List[LogicRule] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ActionTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ActionTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_action_type_dict.py b/foundry/v2/models/_action_type_dict.py deleted file mode 100644 index 7d440c42..00000000 --- a/foundry/v2/models/_action_type_dict.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._action_type_api_name import ActionTypeApiName -from foundry.v2.models._action_type_rid import ActionTypeRid -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._logic_rule_dict import LogicRuleDict -from foundry.v2.models._parameter_dict import ParameterDict -from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._release_status import ReleaseStatus - - -class ActionTypeDict(TypedDict): - """Represents an action type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ActionTypeApiName - - description: NotRequired[StrictStr] - - displayName: NotRequired[DisplayName] - - status: ReleaseStatus - - parameters: Dict[ParameterId, ParameterDict] - - rid: ActionTypeRid - - operations: List[LogicRuleDict] diff --git a/foundry/v2/models/_action_type_v2.py b/foundry/v2/models/_action_type_v2.py deleted file mode 100644 index 6161f0ec..00000000 --- a/foundry/v2/models/_action_type_v2.py +++ /dev/null @@ -1,58 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._action_parameter_v2 import ActionParameterV2 -from foundry.v2.models._action_type_api_name import ActionTypeApiName -from foundry.v2.models._action_type_rid import ActionTypeRid -from foundry.v2.models._action_type_v2_dict import ActionTypeV2Dict -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._logic_rule import LogicRule -from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._release_status import ReleaseStatus - - -class ActionTypeV2(BaseModel): - """Represents an action type in the Ontology.""" - - api_name: ActionTypeApiName = Field(alias="apiName") - - description: Optional[StrictStr] = None - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - status: ReleaseStatus - - parameters: Dict[ParameterId, ActionParameterV2] - - rid: ActionTypeRid - - operations: List[LogicRule] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ActionTypeV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ActionTypeV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_action_type_v2_dict.py b/foundry/v2/models/_action_type_v2_dict.py deleted file mode 100644 index cbfa000f..00000000 --- a/foundry/v2/models/_action_type_v2_dict.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._action_parameter_v2_dict import ActionParameterV2Dict -from foundry.v2.models._action_type_api_name import ActionTypeApiName -from foundry.v2.models._action_type_rid import ActionTypeRid -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._logic_rule_dict import LogicRuleDict -from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._release_status import ReleaseStatus - - -class ActionTypeV2Dict(TypedDict): - """Represents an action type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ActionTypeApiName - - description: NotRequired[StrictStr] - - displayName: NotRequired[DisplayName] - - status: ReleaseStatus - - parameters: Dict[ParameterId, ActionParameterV2Dict] - - rid: ActionTypeRid - - operations: List[LogicRuleDict] diff --git a/foundry/v2/models/_add_group_members_request.py b/foundry/v2/models/_add_group_members_request.py deleted file mode 100644 index 9e884ef8..00000000 --- a/foundry/v2/models/_add_group_members_request.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._add_group_members_request_dict import AddGroupMembersRequestDict -from foundry.v2.models._group_membership_expiration import GroupMembershipExpiration -from foundry.v2.models._principal_id import PrincipalId - - -class AddGroupMembersRequest(BaseModel): - """AddGroupMembersRequest""" - - principal_ids: List[PrincipalId] = Field(alias="principalIds") - - expiration: Optional[GroupMembershipExpiration] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> AddGroupMembersRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AddGroupMembersRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_add_group_members_request_dict.py b/foundry/v2/models/_add_group_members_request_dict.py deleted file mode 100644 index 0fd09d80..00000000 --- a/foundry/v2/models/_add_group_members_request_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._group_membership_expiration import GroupMembershipExpiration -from foundry.v2.models._principal_id import PrincipalId - - -class AddGroupMembersRequestDict(TypedDict): - """AddGroupMembersRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - principalIds: List[PrincipalId] - - expiration: NotRequired[GroupMembershipExpiration] diff --git a/foundry/v2/models/_add_link.py b/foundry/v2/models/_add_link.py deleted file mode 100644 index 042b3ef9..00000000 --- a/foundry/v2/models/_add_link.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._add_link_dict import AddLinkDict -from foundry.v2.models._link_side_object import LinkSideObject -from foundry.v2.models._link_type_api_name import LinkTypeApiName - - -class AddLink(BaseModel): - """AddLink""" - - link_type_api_name_ato_b: LinkTypeApiName = Field(alias="linkTypeApiNameAtoB") - - link_type_api_name_bto_a: LinkTypeApiName = Field(alias="linkTypeApiNameBtoA") - - a_side_object: LinkSideObject = Field(alias="aSideObject") - - b_side_object: LinkSideObject = Field(alias="bSideObject") - - type: Literal["addLink"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AddLinkDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AddLinkDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_add_link_dict.py b/foundry/v2/models/_add_link_dict.py deleted file mode 100644 index 8815ec4e..00000000 --- a/foundry/v2/models/_add_link_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._link_side_object_dict import LinkSideObjectDict -from foundry.v2.models._link_type_api_name import LinkTypeApiName - - -class AddLinkDict(TypedDict): - """AddLink""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - linkTypeApiNameAtoB: LinkTypeApiName - - linkTypeApiNameBtoA: LinkTypeApiName - - aSideObject: LinkSideObjectDict - - bSideObject: LinkSideObjectDict - - type: Literal["addLink"] diff --git a/foundry/v2/models/_add_object.py b/foundry/v2/models/_add_object.py deleted file mode 100644 index 382644f6..00000000 --- a/foundry/v2/models/_add_object.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._add_object_dict import AddObjectDict -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._property_value import PropertyValue - - -class AddObject(BaseModel): - """AddObject""" - - primary_key: PropertyValue = Field(alias="primaryKey") - - object_type: ObjectTypeApiName = Field(alias="objectType") - - type: Literal["addObject"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AddObjectDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AddObjectDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_add_object_dict.py b/foundry/v2/models/_add_object_dict.py deleted file mode 100644 index da136d5a..00000000 --- a/foundry/v2/models/_add_object_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._property_value import PropertyValue - - -class AddObjectDict(TypedDict): - """AddObject""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - primaryKey: PropertyValue - - objectType: ObjectTypeApiName - - type: Literal["addObject"] diff --git a/foundry/v2/models/_aggregate_object_set_request_v2.py b/foundry/v2/models/_aggregate_object_set_request_v2.py deleted file mode 100644 index 9a3299c4..00000000 --- a/foundry/v2/models/_aggregate_object_set_request_v2.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._aggregate_object_set_request_v2_dict import ( - AggregateObjectSetRequestV2Dict, -) # NOQA -from foundry.v2.models._aggregation_accuracy_request import AggregationAccuracyRequest -from foundry.v2.models._aggregation_group_by_v2 import AggregationGroupByV2 -from foundry.v2.models._aggregation_v2 import AggregationV2 -from foundry.v2.models._object_set import ObjectSet - - -class AggregateObjectSetRequestV2(BaseModel): - """AggregateObjectSetRequestV2""" - - aggregation: List[AggregationV2] - - object_set: ObjectSet = Field(alias="objectSet") - - group_by: List[AggregationGroupByV2] = Field(alias="groupBy") - - accuracy: Optional[AggregationAccuracyRequest] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregateObjectSetRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregateObjectSetRequestV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregate_object_set_request_v2_dict.py b/foundry/v2/models/_aggregate_object_set_request_v2_dict.py deleted file mode 100644 index 917ad1e4..00000000 --- a/foundry/v2/models/_aggregate_object_set_request_v2_dict.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_accuracy_request import AggregationAccuracyRequest -from foundry.v2.models._aggregation_group_by_v2_dict import AggregationGroupByV2Dict -from foundry.v2.models._aggregation_v2_dict import AggregationV2Dict -from foundry.v2.models._object_set_dict import ObjectSetDict - - -class AggregateObjectSetRequestV2Dict(TypedDict): - """AggregateObjectSetRequestV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - aggregation: List[AggregationV2Dict] - - objectSet: ObjectSetDict - - groupBy: List[AggregationGroupByV2Dict] - - accuracy: NotRequired[AggregationAccuracyRequest] diff --git a/foundry/v2/models/_aggregate_objects_request.py b/foundry/v2/models/_aggregate_objects_request.py deleted file mode 100644 index 641bead5..00000000 --- a/foundry/v2/models/_aggregate_objects_request.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._aggregate_objects_request_dict import AggregateObjectsRequestDict # NOQA -from foundry.v2.models._aggregation import Aggregation -from foundry.v2.models._aggregation_group_by import AggregationGroupBy -from foundry.v2.models._search_json_query import SearchJsonQuery - - -class AggregateObjectsRequest(BaseModel): - """AggregateObjectsRequest""" - - aggregation: List[Aggregation] - - query: Optional[SearchJsonQuery] = None - - group_by: List[AggregationGroupBy] = Field(alias="groupBy") - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregateObjectsRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AggregateObjectsRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_aggregate_objects_request_dict.py b/foundry/v2/models/_aggregate_objects_request_dict.py deleted file mode 100644 index 166818a7..00000000 --- a/foundry/v2/models/_aggregate_objects_request_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_dict import AggregationDict -from foundry.v2.models._aggregation_group_by_dict import AggregationGroupByDict -from foundry.v2.models._search_json_query_dict import SearchJsonQueryDict - - -class AggregateObjectsRequestDict(TypedDict): - """AggregateObjectsRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - aggregation: List[AggregationDict] - - query: NotRequired[SearchJsonQueryDict] - - groupBy: List[AggregationGroupByDict] diff --git a/foundry/v2/models/_aggregate_objects_request_v2.py b/foundry/v2/models/_aggregate_objects_request_v2.py deleted file mode 100644 index 2effea12..00000000 --- a/foundry/v2/models/_aggregate_objects_request_v2.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._aggregate_objects_request_v2_dict import ( - AggregateObjectsRequestV2Dict, -) # NOQA -from foundry.v2.models._aggregation_accuracy_request import AggregationAccuracyRequest -from foundry.v2.models._aggregation_group_by_v2 import AggregationGroupByV2 -from foundry.v2.models._aggregation_v2 import AggregationV2 -from foundry.v2.models._search_json_query_v2 import SearchJsonQueryV2 - - -class AggregateObjectsRequestV2(BaseModel): - """AggregateObjectsRequestV2""" - - aggregation: List[AggregationV2] - - where: Optional[SearchJsonQueryV2] = None - - group_by: List[AggregationGroupByV2] = Field(alias="groupBy") - - accuracy: Optional[AggregationAccuracyRequest] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregateObjectsRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregateObjectsRequestV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregate_objects_request_v2_dict.py b/foundry/v2/models/_aggregate_objects_request_v2_dict.py deleted file mode 100644 index 78c9fc69..00000000 --- a/foundry/v2/models/_aggregate_objects_request_v2_dict.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_accuracy_request import AggregationAccuracyRequest -from foundry.v2.models._aggregation_group_by_v2_dict import AggregationGroupByV2Dict -from foundry.v2.models._aggregation_v2_dict import AggregationV2Dict -from foundry.v2.models._search_json_query_v2_dict import SearchJsonQueryV2Dict - - -class AggregateObjectsRequestV2Dict(TypedDict): - """AggregateObjectsRequestV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - aggregation: List[AggregationV2Dict] - - where: NotRequired[SearchJsonQueryV2Dict] - - groupBy: List[AggregationGroupByV2Dict] - - accuracy: NotRequired[AggregationAccuracyRequest] diff --git a/foundry/v2/models/_aggregate_objects_response.py b/foundry/v2/models/_aggregate_objects_response.py deleted file mode 100644 index 5948e8e7..00000000 --- a/foundry/v2/models/_aggregate_objects_response.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictInt - -from foundry.v2.models._aggregate_objects_response_dict import AggregateObjectsResponseDict # NOQA -from foundry.v2.models._aggregate_objects_response_item import AggregateObjectsResponseItem # NOQA -from foundry.v2.models._page_token import PageToken - - -class AggregateObjectsResponse(BaseModel): - """AggregateObjectsResponse""" - - excluded_items: Optional[StrictInt] = Field(alias="excludedItems", default=None) - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[AggregateObjectsResponseItem] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregateObjectsResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregateObjectsResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregate_objects_response_dict.py b/foundry/v2/models/_aggregate_objects_response_dict.py deleted file mode 100644 index 73662599..00000000 --- a/foundry/v2/models/_aggregate_objects_response_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from pydantic import StrictInt -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregate_objects_response_item_dict import ( - AggregateObjectsResponseItemDict, -) # NOQA -from foundry.v2.models._page_token import PageToken - - -class AggregateObjectsResponseDict(TypedDict): - """AggregateObjectsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - excludedItems: NotRequired[StrictInt] - - nextPageToken: NotRequired[PageToken] - - data: List[AggregateObjectsResponseItemDict] diff --git a/foundry/v2/models/_aggregate_objects_response_item.py b/foundry/v2/models/_aggregate_objects_response_item.py deleted file mode 100644 index d1a13a92..00000000 --- a/foundry/v2/models/_aggregate_objects_response_item.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregate_objects_response_item_dict import ( - AggregateObjectsResponseItemDict, -) # NOQA -from foundry.v2.models._aggregation_group_key import AggregationGroupKey -from foundry.v2.models._aggregation_group_value import AggregationGroupValue -from foundry.v2.models._aggregation_metric_result import AggregationMetricResult - - -class AggregateObjectsResponseItem(BaseModel): - """AggregateObjectsResponseItem""" - - group: Dict[AggregationGroupKey, AggregationGroupValue] - - metrics: List[AggregationMetricResult] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregateObjectsResponseItemDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregateObjectsResponseItemDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregate_objects_response_item_dict.py b/foundry/v2/models/_aggregate_objects_response_item_dict.py deleted file mode 100644 index 1df743b2..00000000 --- a/foundry/v2/models/_aggregate_objects_response_item_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_group_key import AggregationGroupKey -from foundry.v2.models._aggregation_group_value import AggregationGroupValue -from foundry.v2.models._aggregation_metric_result_dict import AggregationMetricResultDict # NOQA - - -class AggregateObjectsResponseItemDict(TypedDict): - """AggregateObjectsResponseItem""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - group: Dict[AggregationGroupKey, AggregationGroupValue] - - metrics: List[AggregationMetricResultDict] diff --git a/foundry/v2/models/_aggregate_objects_response_item_v2.py b/foundry/v2/models/_aggregate_objects_response_item_v2.py deleted file mode 100644 index fc83d0b6..00000000 --- a/foundry/v2/models/_aggregate_objects_response_item_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregate_objects_response_item_v2_dict import ( - AggregateObjectsResponseItemV2Dict, -) # NOQA -from foundry.v2.models._aggregation_group_key_v2 import AggregationGroupKeyV2 -from foundry.v2.models._aggregation_group_value_v2 import AggregationGroupValueV2 -from foundry.v2.models._aggregation_metric_result_v2 import AggregationMetricResultV2 - - -class AggregateObjectsResponseItemV2(BaseModel): - """AggregateObjectsResponseItemV2""" - - group: Dict[AggregationGroupKeyV2, AggregationGroupValueV2] - - metrics: List[AggregationMetricResultV2] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregateObjectsResponseItemV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregateObjectsResponseItemV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregate_objects_response_item_v2_dict.py b/foundry/v2/models/_aggregate_objects_response_item_v2_dict.py deleted file mode 100644 index dabab0da..00000000 --- a/foundry/v2/models/_aggregate_objects_response_item_v2_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_group_key_v2 import AggregationGroupKeyV2 -from foundry.v2.models._aggregation_group_value_v2 import AggregationGroupValueV2 -from foundry.v2.models._aggregation_metric_result_v2_dict import ( - AggregationMetricResultV2Dict, -) # NOQA - - -class AggregateObjectsResponseItemV2Dict(TypedDict): - """AggregateObjectsResponseItemV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - group: Dict[AggregationGroupKeyV2, AggregationGroupValueV2] - - metrics: List[AggregationMetricResultV2Dict] diff --git a/foundry/v2/models/_aggregate_objects_response_v2.py b/foundry/v2/models/_aggregate_objects_response_v2.py deleted file mode 100644 index f9e5b7e3..00000000 --- a/foundry/v2/models/_aggregate_objects_response_v2.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictInt - -from foundry.v2.models._aggregate_objects_response_item_v2 import ( - AggregateObjectsResponseItemV2, -) # NOQA -from foundry.v2.models._aggregate_objects_response_v2_dict import ( - AggregateObjectsResponseV2Dict, -) # NOQA -from foundry.v2.models._aggregation_accuracy import AggregationAccuracy - - -class AggregateObjectsResponseV2(BaseModel): - """AggregateObjectsResponseV2""" - - excluded_items: Optional[StrictInt] = Field(alias="excludedItems", default=None) - - accuracy: AggregationAccuracy - - data: List[AggregateObjectsResponseItemV2] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregateObjectsResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregateObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregate_objects_response_v2_dict.py b/foundry/v2/models/_aggregate_objects_response_v2_dict.py deleted file mode 100644 index c386ed11..00000000 --- a/foundry/v2/models/_aggregate_objects_response_v2_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from pydantic import StrictInt -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregate_objects_response_item_v2_dict import ( - AggregateObjectsResponseItemV2Dict, -) # NOQA -from foundry.v2.models._aggregation_accuracy import AggregationAccuracy - - -class AggregateObjectsResponseV2Dict(TypedDict): - """AggregateObjectsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - excludedItems: NotRequired[StrictInt] - - accuracy: AggregationAccuracy - - data: List[AggregateObjectsResponseItemV2Dict] diff --git a/foundry/v2/models/_aggregation.py b/foundry/v2/models/_aggregation.py deleted file mode 100644 index 4bbd8390..00000000 --- a/foundry/v2/models/_aggregation.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._approximate_distinct_aggregation import ( - ApproximateDistinctAggregation, -) # NOQA -from foundry.v2.models._avg_aggregation import AvgAggregation -from foundry.v2.models._count_aggregation import CountAggregation -from foundry.v2.models._max_aggregation import MaxAggregation -from foundry.v2.models._min_aggregation import MinAggregation -from foundry.v2.models._sum_aggregation import SumAggregation - -Aggregation = Annotated[ - Union[ - MaxAggregation, - MinAggregation, - AvgAggregation, - SumAggregation, - CountAggregation, - ApproximateDistinctAggregation, - ], - Field(discriminator="type"), -] -"""Specifies an aggregation function.""" diff --git a/foundry/v2/models/_aggregation_accuracy.py b/foundry/v2/models/_aggregation_accuracy.py deleted file mode 100644 index 6e7a81b3..00000000 --- a/foundry/v2/models/_aggregation_accuracy.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -AggregationAccuracy = Literal["ACCURATE", "APPROXIMATE"] -"""AggregationAccuracy""" diff --git a/foundry/v2/models/_aggregation_accuracy_request.py b/foundry/v2/models/_aggregation_accuracy_request.py deleted file mode 100644 index 90ae6e5f..00000000 --- a/foundry/v2/models/_aggregation_accuracy_request.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -AggregationAccuracyRequest = Literal["REQUIRE_ACCURATE", "ALLOW_APPROXIMATE"] -"""AggregationAccuracyRequest""" diff --git a/foundry/v2/models/_aggregation_dict.py b/foundry/v2/models/_aggregation_dict.py deleted file mode 100644 index 99e6d437..00000000 --- a/foundry/v2/models/_aggregation_dict.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._approximate_distinct_aggregation_dict import ( - ApproximateDistinctAggregationDict, -) # NOQA -from foundry.v2.models._avg_aggregation_dict import AvgAggregationDict -from foundry.v2.models._count_aggregation_dict import CountAggregationDict -from foundry.v2.models._max_aggregation_dict import MaxAggregationDict -from foundry.v2.models._min_aggregation_dict import MinAggregationDict -from foundry.v2.models._sum_aggregation_dict import SumAggregationDict - -AggregationDict = Annotated[ - Union[ - MaxAggregationDict, - MinAggregationDict, - AvgAggregationDict, - SumAggregationDict, - CountAggregationDict, - ApproximateDistinctAggregationDict, - ], - Field(discriminator="type"), -] -"""Specifies an aggregation function.""" diff --git a/foundry/v2/models/_aggregation_duration_grouping.py b/foundry/v2/models/_aggregation_duration_grouping.py deleted file mode 100644 index 03b7047a..00000000 --- a/foundry/v2/models/_aggregation_duration_grouping.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_duration_grouping_dict import ( - AggregationDurationGroupingDict, -) # NOQA -from foundry.v2.models._duration import Duration -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class AggregationDurationGrouping(BaseModel): - """ - Divides objects into groups according to an interval. Note that this grouping applies only on date types. - The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. - """ - - field: FieldNameV1 - - duration: Duration - - type: Literal["duration"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationDurationGroupingDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationDurationGroupingDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregation_duration_grouping_dict.py b/foundry/v2/models/_aggregation_duration_grouping_dict.py deleted file mode 100644 index dfb1c4b4..00000000 --- a/foundry/v2/models/_aggregation_duration_grouping_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._duration_dict import DurationDict -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class AggregationDurationGroupingDict(TypedDict): - """ - Divides objects into groups according to an interval. Note that this grouping applies only on date types. - The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - duration: DurationDict - - type: Literal["duration"] diff --git a/foundry/v2/models/_aggregation_duration_grouping_v2.py b/foundry/v2/models/_aggregation_duration_grouping_v2.py deleted file mode 100644 index 60e0cef6..00000000 --- a/foundry/v2/models/_aggregation_duration_grouping_v2.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictInt - -from foundry.v2.models._aggregation_duration_grouping_v2_dict import ( - AggregationDurationGroupingV2Dict, -) # NOQA -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._time_unit import TimeUnit - - -class AggregationDurationGroupingV2(BaseModel): - """ - Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. - When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. - """ - - field: PropertyApiName - - value: StrictInt - - unit: TimeUnit - - type: Literal["duration"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationDurationGroupingV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationDurationGroupingV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregation_duration_grouping_v2_dict.py b/foundry/v2/models/_aggregation_duration_grouping_v2_dict.py deleted file mode 100644 index 6265cbb0..00000000 --- a/foundry/v2/models/_aggregation_duration_grouping_v2_dict.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictInt -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._time_unit import TimeUnit - - -class AggregationDurationGroupingV2Dict(TypedDict): - """ - Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. - When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: StrictInt - - unit: TimeUnit - - type: Literal["duration"] diff --git a/foundry/v2/models/_aggregation_exact_grouping.py b/foundry/v2/models/_aggregation_exact_grouping.py deleted file mode 100644 index d504fade..00000000 --- a/foundry/v2/models/_aggregation_exact_grouping.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictInt - -from foundry.v2.models._aggregation_exact_grouping_dict import AggregationExactGroupingDict # NOQA -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class AggregationExactGrouping(BaseModel): - """Divides objects into groups according to an exact value.""" - - field: FieldNameV1 - - max_group_count: Optional[StrictInt] = Field(alias="maxGroupCount", default=None) - - type: Literal["exact"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationExactGroupingDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationExactGroupingDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregation_exact_grouping_dict.py b/foundry/v2/models/_aggregation_exact_grouping_dict.py deleted file mode 100644 index 9146182b..00000000 --- a/foundry/v2/models/_aggregation_exact_grouping_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictInt -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class AggregationExactGroupingDict(TypedDict): - """Divides objects into groups according to an exact value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - maxGroupCount: NotRequired[StrictInt] - - type: Literal["exact"] diff --git a/foundry/v2/models/_aggregation_exact_grouping_v2.py b/foundry/v2/models/_aggregation_exact_grouping_v2.py deleted file mode 100644 index f850428e..00000000 --- a/foundry/v2/models/_aggregation_exact_grouping_v2.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictInt - -from foundry.v2.models._aggregation_exact_grouping_v2_dict import ( - AggregationExactGroupingV2Dict, -) # NOQA -from foundry.v2.models._property_api_name import PropertyApiName - - -class AggregationExactGroupingV2(BaseModel): - """Divides objects into groups according to an exact value.""" - - field: PropertyApiName - - max_group_count: Optional[StrictInt] = Field(alias="maxGroupCount", default=None) - - type: Literal["exact"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationExactGroupingV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationExactGroupingV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregation_exact_grouping_v2_dict.py b/foundry/v2/models/_aggregation_exact_grouping_v2_dict.py deleted file mode 100644 index 89a0caf6..00000000 --- a/foundry/v2/models/_aggregation_exact_grouping_v2_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictInt -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName - - -class AggregationExactGroupingV2Dict(TypedDict): - """Divides objects into groups according to an exact value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - maxGroupCount: NotRequired[StrictInt] - - type: Literal["exact"] diff --git a/foundry/v2/models/_aggregation_fixed_width_grouping.py b/foundry/v2/models/_aggregation_fixed_width_grouping.py deleted file mode 100644 index a46f18d1..00000000 --- a/foundry/v2/models/_aggregation_fixed_width_grouping.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictInt - -from foundry.v2.models._aggregation_fixed_width_grouping_dict import ( - AggregationFixedWidthGroupingDict, -) # NOQA -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class AggregationFixedWidthGrouping(BaseModel): - """Divides objects into groups with the specified width.""" - - field: FieldNameV1 - - fixed_width: StrictInt = Field(alias="fixedWidth") - - type: Literal["fixedWidth"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationFixedWidthGroupingDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationFixedWidthGroupingDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregation_fixed_width_grouping_dict.py b/foundry/v2/models/_aggregation_fixed_width_grouping_dict.py deleted file mode 100644 index 7254dda4..00000000 --- a/foundry/v2/models/_aggregation_fixed_width_grouping_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictInt -from typing_extensions import TypedDict - -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class AggregationFixedWidthGroupingDict(TypedDict): - """Divides objects into groups with the specified width.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - fixedWidth: StrictInt - - type: Literal["fixedWidth"] diff --git a/foundry/v2/models/_aggregation_fixed_width_grouping_v2.py b/foundry/v2/models/_aggregation_fixed_width_grouping_v2.py deleted file mode 100644 index d646c794..00000000 --- a/foundry/v2/models/_aggregation_fixed_width_grouping_v2.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictInt - -from foundry.v2.models._aggregation_fixed_width_grouping_v2_dict import ( - AggregationFixedWidthGroupingV2Dict, -) # NOQA -from foundry.v2.models._property_api_name import PropertyApiName - - -class AggregationFixedWidthGroupingV2(BaseModel): - """Divides objects into groups with the specified width.""" - - field: PropertyApiName - - fixed_width: StrictInt = Field(alias="fixedWidth") - - type: Literal["fixedWidth"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationFixedWidthGroupingV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationFixedWidthGroupingV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregation_fixed_width_grouping_v2_dict.py b/foundry/v2/models/_aggregation_fixed_width_grouping_v2_dict.py deleted file mode 100644 index 761b1c7b..00000000 --- a/foundry/v2/models/_aggregation_fixed_width_grouping_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictInt -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName - - -class AggregationFixedWidthGroupingV2Dict(TypedDict): - """Divides objects into groups with the specified width.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - fixedWidth: StrictInt - - type: Literal["fixedWidth"] diff --git a/foundry/v2/models/_aggregation_group_by.py b/foundry/v2/models/_aggregation_group_by.py deleted file mode 100644 index 2d7be8fe..00000000 --- a/foundry/v2/models/_aggregation_group_by.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._aggregation_duration_grouping import AggregationDurationGrouping -from foundry.v2.models._aggregation_exact_grouping import AggregationExactGrouping -from foundry.v2.models._aggregation_fixed_width_grouping import ( - AggregationFixedWidthGrouping, -) # NOQA -from foundry.v2.models._aggregation_ranges_grouping import AggregationRangesGrouping - -AggregationGroupBy = Annotated[ - Union[ - AggregationFixedWidthGrouping, - AggregationRangesGrouping, - AggregationExactGrouping, - AggregationDurationGrouping, - ], - Field(discriminator="type"), -] -"""Specifies a grouping for aggregation results.""" diff --git a/foundry/v2/models/_aggregation_group_by_dict.py b/foundry/v2/models/_aggregation_group_by_dict.py deleted file mode 100644 index 0a2dab01..00000000 --- a/foundry/v2/models/_aggregation_group_by_dict.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._aggregation_duration_grouping_dict import ( - AggregationDurationGroupingDict, -) # NOQA -from foundry.v2.models._aggregation_exact_grouping_dict import AggregationExactGroupingDict # NOQA -from foundry.v2.models._aggregation_fixed_width_grouping_dict import ( - AggregationFixedWidthGroupingDict, -) # NOQA -from foundry.v2.models._aggregation_ranges_grouping_dict import ( - AggregationRangesGroupingDict, -) # NOQA - -AggregationGroupByDict = Annotated[ - Union[ - AggregationFixedWidthGroupingDict, - AggregationRangesGroupingDict, - AggregationExactGroupingDict, - AggregationDurationGroupingDict, - ], - Field(discriminator="type"), -] -"""Specifies a grouping for aggregation results.""" diff --git a/foundry/v2/models/_aggregation_group_by_v2.py b/foundry/v2/models/_aggregation_group_by_v2.py deleted file mode 100644 index b70789a6..00000000 --- a/foundry/v2/models/_aggregation_group_by_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._aggregation_duration_grouping_v2 import ( - AggregationDurationGroupingV2, -) # NOQA -from foundry.v2.models._aggregation_exact_grouping_v2 import AggregationExactGroupingV2 -from foundry.v2.models._aggregation_fixed_width_grouping_v2 import ( - AggregationFixedWidthGroupingV2, -) # NOQA -from foundry.v2.models._aggregation_ranges_grouping_v2 import AggregationRangesGroupingV2 # NOQA - -AggregationGroupByV2 = Annotated[ - Union[ - AggregationFixedWidthGroupingV2, - AggregationRangesGroupingV2, - AggregationExactGroupingV2, - AggregationDurationGroupingV2, - ], - Field(discriminator="type"), -] -"""Specifies a grouping for aggregation results.""" diff --git a/foundry/v2/models/_aggregation_group_by_v2_dict.py b/foundry/v2/models/_aggregation_group_by_v2_dict.py deleted file mode 100644 index 741188b1..00000000 --- a/foundry/v2/models/_aggregation_group_by_v2_dict.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._aggregation_duration_grouping_v2_dict import ( - AggregationDurationGroupingV2Dict, -) # NOQA -from foundry.v2.models._aggregation_exact_grouping_v2_dict import ( - AggregationExactGroupingV2Dict, -) # NOQA -from foundry.v2.models._aggregation_fixed_width_grouping_v2_dict import ( - AggregationFixedWidthGroupingV2Dict, -) # NOQA -from foundry.v2.models._aggregation_ranges_grouping_v2_dict import ( - AggregationRangesGroupingV2Dict, -) # NOQA - -AggregationGroupByV2Dict = Annotated[ - Union[ - AggregationFixedWidthGroupingV2Dict, - AggregationRangesGroupingV2Dict, - AggregationExactGroupingV2Dict, - AggregationDurationGroupingV2Dict, - ], - Field(discriminator="type"), -] -"""Specifies a grouping for aggregation results.""" diff --git a/foundry/v2/models/_aggregation_group_key.py b/foundry/v2/models/_aggregation_group_key.py deleted file mode 100644 index af2204d8..00000000 --- a/foundry/v2/models/_aggregation_group_key.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -AggregationGroupKey = StrictStr -"""AggregationGroupKey""" diff --git a/foundry/v2/models/_aggregation_group_key_v2.py b/foundry/v2/models/_aggregation_group_key_v2.py deleted file mode 100644 index 3f4d3ba5..00000000 --- a/foundry/v2/models/_aggregation_group_key_v2.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -AggregationGroupKeyV2 = StrictStr -"""AggregationGroupKeyV2""" diff --git a/foundry/v2/models/_aggregation_group_value.py b/foundry/v2/models/_aggregation_group_value.py deleted file mode 100644 index c20bb849..00000000 --- a/foundry/v2/models/_aggregation_group_value.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any - -AggregationGroupValue = Any -"""AggregationGroupValue""" diff --git a/foundry/v2/models/_aggregation_group_value_v2.py b/foundry/v2/models/_aggregation_group_value_v2.py deleted file mode 100644 index 13264d2e..00000000 --- a/foundry/v2/models/_aggregation_group_value_v2.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any - -AggregationGroupValueV2 = Any -"""AggregationGroupValueV2""" diff --git a/foundry/v2/models/_aggregation_metric_result.py b/foundry/v2/models/_aggregation_metric_result.py deleted file mode 100644 index 932bfb65..00000000 --- a/foundry/v2/models/_aggregation_metric_result.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictFloat -from pydantic import StrictStr - -from foundry.v2.models._aggregation_metric_result_dict import AggregationMetricResultDict # NOQA - - -class AggregationMetricResult(BaseModel): - """AggregationMetricResult""" - - name: StrictStr - - value: Optional[StrictFloat] = None - """TBD""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationMetricResultDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AggregationMetricResultDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_aggregation_metric_result_dict.py b/foundry/v2/models/_aggregation_metric_result_dict.py deleted file mode 100644 index 16e29307..00000000 --- a/foundry/v2/models/_aggregation_metric_result_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictFloat -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - - -class AggregationMetricResultDict(TypedDict): - """AggregationMetricResult""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: StrictStr - - value: NotRequired[StrictFloat] - """TBD""" diff --git a/foundry/v2/models/_aggregation_metric_result_v2.py b/foundry/v2/models/_aggregation_metric_result_v2.py deleted file mode 100644 index 15662758..00000000 --- a/foundry/v2/models/_aggregation_metric_result_v2.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._aggregation_metric_result_v2_dict import ( - AggregationMetricResultV2Dict, -) # NOQA - - -class AggregationMetricResultV2(BaseModel): - """AggregationMetricResultV2""" - - name: StrictStr - - value: Optional[Any] = None - """ - The value of the metric. This will be a double in the case of - a numeric metric, or a date string in the case of a date metric. - """ - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationMetricResultV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationMetricResultV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregation_metric_result_v2_dict.py b/foundry/v2/models/_aggregation_metric_result_v2_dict.py deleted file mode 100644 index 8cb7e369..00000000 --- a/foundry/v2/models/_aggregation_metric_result_v2_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - - -class AggregationMetricResultV2Dict(TypedDict): - """AggregationMetricResultV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: StrictStr - - value: NotRequired[Any] - """ - The value of the metric. This will be a double in the case of - a numeric metric, or a date string in the case of a date metric. - """ diff --git a/foundry/v2/models/_aggregation_object_type_grouping.py b/foundry/v2/models/_aggregation_object_type_grouping.py deleted file mode 100644 index 618b48a9..00000000 --- a/foundry/v2/models/_aggregation_object_type_grouping.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_object_type_grouping_dict import ( - AggregationObjectTypeGroupingDict, -) # NOQA - - -class AggregationObjectTypeGrouping(BaseModel): - """ - Divides objects into groups based on their object type. This grouping is only useful when aggregating across - multiple object types, such as when aggregating over an interface type. - """ - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationObjectTypeGroupingDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationObjectTypeGroupingDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregation_object_type_grouping_dict.py b/foundry/v2/models/_aggregation_object_type_grouping_dict.py deleted file mode 100644 index d5801329..00000000 --- a/foundry/v2/models/_aggregation_object_type_grouping_dict.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - - -class AggregationObjectTypeGroupingDict(TypedDict): - """ - Divides objects into groups based on their object type. This grouping is only useful when aggregating across - multiple object types, such as when aggregating over an interface type. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/models/_aggregation_order_by.py b/foundry/v2/models/_aggregation_order_by.py deleted file mode 100644 index 227e9abe..00000000 --- a/foundry/v2/models/_aggregation_order_by.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._aggregation_order_by_dict import AggregationOrderByDict - - -class AggregationOrderBy(BaseModel): - """AggregationOrderBy""" - - metric_name: StrictStr = Field(alias="metricName") - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationOrderByDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AggregationOrderByDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_aggregation_order_by_dict.py b/foundry/v2/models/_aggregation_order_by_dict.py deleted file mode 100644 index 12825d13..00000000 --- a/foundry/v2/models/_aggregation_order_by_dict.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import TypedDict - - -class AggregationOrderByDict(TypedDict): - """AggregationOrderBy""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - metricName: StrictStr diff --git a/foundry/v2/models/_aggregation_range.py b/foundry/v2/models/_aggregation_range.py deleted file mode 100644 index e8a7678c..00000000 --- a/foundry/v2/models/_aggregation_range.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_range_dict import AggregationRangeDict - - -class AggregationRange(BaseModel): - """Specifies a date range from an inclusive start date to an exclusive end date.""" - - lt: Optional[Any] = None - """Exclusive end date.""" - - lte: Optional[Any] = None - """Inclusive end date.""" - - gt: Optional[Any] = None - """Exclusive start date.""" - - gte: Optional[Any] = None - """Inclusive start date.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationRangeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AggregationRangeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_aggregation_range_dict.py b/foundry/v2/models/_aggregation_range_dict.py deleted file mode 100644 index 26d0ce0d..00000000 --- a/foundry/v2/models/_aggregation_range_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - - -class AggregationRangeDict(TypedDict): - """Specifies a date range from an inclusive start date to an exclusive end date.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - lt: NotRequired[Any] - """Exclusive end date.""" - - lte: NotRequired[Any] - """Inclusive end date.""" - - gt: NotRequired[Any] - """Exclusive start date.""" - - gte: NotRequired[Any] - """Inclusive start date.""" diff --git a/foundry/v2/models/_aggregation_range_v2.py b/foundry/v2/models/_aggregation_range_v2.py deleted file mode 100644 index 7ecaa6bc..00000000 --- a/foundry/v2/models/_aggregation_range_v2.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._aggregation_range_v2_dict import AggregationRangeV2Dict - - -class AggregationRangeV2(BaseModel): - """Specifies a range from an inclusive start value to an exclusive end value.""" - - start_value: Any = Field(alias="startValue") - """Inclusive start.""" - - end_value: Any = Field(alias="endValue") - """Exclusive end.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationRangeV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AggregationRangeV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_aggregation_range_v2_dict.py b/foundry/v2/models/_aggregation_range_v2_dict.py deleted file mode 100644 index 3dea54ea..00000000 --- a/foundry/v2/models/_aggregation_range_v2_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any - -from typing_extensions import TypedDict - - -class AggregationRangeV2Dict(TypedDict): - """Specifies a range from an inclusive start value to an exclusive end value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - startValue: Any - """Inclusive start.""" - - endValue: Any - """Exclusive end.""" diff --git a/foundry/v2/models/_aggregation_ranges_grouping.py b/foundry/v2/models/_aggregation_ranges_grouping.py deleted file mode 100644 index 49720aa1..00000000 --- a/foundry/v2/models/_aggregation_ranges_grouping.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_range import AggregationRange -from foundry.v2.models._aggregation_ranges_grouping_dict import ( - AggregationRangesGroupingDict, -) # NOQA -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class AggregationRangesGrouping(BaseModel): - """Divides objects into groups according to specified ranges.""" - - field: FieldNameV1 - - ranges: List[AggregationRange] - - type: Literal["ranges"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationRangesGroupingDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationRangesGroupingDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregation_ranges_grouping_dict.py b/foundry/v2/models/_aggregation_ranges_grouping_dict.py deleted file mode 100644 index 95c2d260..00000000 --- a/foundry/v2/models/_aggregation_ranges_grouping_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_range_dict import AggregationRangeDict -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class AggregationRangesGroupingDict(TypedDict): - """Divides objects into groups according to specified ranges.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - ranges: List[AggregationRangeDict] - - type: Literal["ranges"] diff --git a/foundry/v2/models/_aggregation_ranges_grouping_v2.py b/foundry/v2/models/_aggregation_ranges_grouping_v2.py deleted file mode 100644 index 25ecab5a..00000000 --- a/foundry/v2/models/_aggregation_ranges_grouping_v2.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_range_v2 import AggregationRangeV2 -from foundry.v2.models._aggregation_ranges_grouping_v2_dict import ( - AggregationRangesGroupingV2Dict, -) # NOQA -from foundry.v2.models._property_api_name import PropertyApiName - - -class AggregationRangesGroupingV2(BaseModel): - """Divides objects into groups according to specified ranges.""" - - field: PropertyApiName - - ranges: List[AggregationRangeV2] - - type: Literal["ranges"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AggregationRangesGroupingV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AggregationRangesGroupingV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_aggregation_ranges_grouping_v2_dict.py b/foundry/v2/models/_aggregation_ranges_grouping_v2_dict.py deleted file mode 100644 index e82c101a..00000000 --- a/foundry/v2/models/_aggregation_ranges_grouping_v2_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_range_v2_dict import AggregationRangeV2Dict -from foundry.v2.models._property_api_name import PropertyApiName - - -class AggregationRangesGroupingV2Dict(TypedDict): - """Divides objects into groups according to specified ranges.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - ranges: List[AggregationRangeV2Dict] - - type: Literal["ranges"] diff --git a/foundry/v2/models/_aggregation_v2.py b/foundry/v2/models/_aggregation_v2.py deleted file mode 100644 index a4a3690a..00000000 --- a/foundry/v2/models/_aggregation_v2.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._approximate_distinct_aggregation_v2 import ( - ApproximateDistinctAggregationV2, -) # NOQA -from foundry.v2.models._approximate_percentile_aggregation_v2 import ( - ApproximatePercentileAggregationV2, -) # NOQA -from foundry.v2.models._avg_aggregation_v2 import AvgAggregationV2 -from foundry.v2.models._count_aggregation_v2 import CountAggregationV2 -from foundry.v2.models._exact_distinct_aggregation_v2 import ExactDistinctAggregationV2 -from foundry.v2.models._max_aggregation_v2 import MaxAggregationV2 -from foundry.v2.models._min_aggregation_v2 import MinAggregationV2 -from foundry.v2.models._sum_aggregation_v2 import SumAggregationV2 - -AggregationV2 = Annotated[ - Union[ - MaxAggregationV2, - MinAggregationV2, - AvgAggregationV2, - SumAggregationV2, - CountAggregationV2, - ApproximateDistinctAggregationV2, - ApproximatePercentileAggregationV2, - ExactDistinctAggregationV2, - ], - Field(discriminator="type"), -] -"""Specifies an aggregation function.""" diff --git a/foundry/v2/models/_aggregation_v2_dict.py b/foundry/v2/models/_aggregation_v2_dict.py deleted file mode 100644 index 2d753edd..00000000 --- a/foundry/v2/models/_aggregation_v2_dict.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._approximate_distinct_aggregation_v2_dict import ( - ApproximateDistinctAggregationV2Dict, -) # NOQA -from foundry.v2.models._approximate_percentile_aggregation_v2_dict import ( - ApproximatePercentileAggregationV2Dict, -) # NOQA -from foundry.v2.models._avg_aggregation_v2_dict import AvgAggregationV2Dict -from foundry.v2.models._count_aggregation_v2_dict import CountAggregationV2Dict -from foundry.v2.models._exact_distinct_aggregation_v2_dict import ( - ExactDistinctAggregationV2Dict, -) # NOQA -from foundry.v2.models._max_aggregation_v2_dict import MaxAggregationV2Dict -from foundry.v2.models._min_aggregation_v2_dict import MinAggregationV2Dict -from foundry.v2.models._sum_aggregation_v2_dict import SumAggregationV2Dict - -AggregationV2Dict = Annotated[ - Union[ - MaxAggregationV2Dict, - MinAggregationV2Dict, - AvgAggregationV2Dict, - SumAggregationV2Dict, - CountAggregationV2Dict, - ApproximateDistinctAggregationV2Dict, - ApproximatePercentileAggregationV2Dict, - ExactDistinctAggregationV2Dict, - ], - Field(discriminator="type"), -] -"""Specifies an aggregation function.""" diff --git a/foundry/v2/models/_all_terms_query.py b/foundry/v2/models/_all_terms_query.py deleted file mode 100644 index e4de879b..00000000 --- a/foundry/v2/models/_all_terms_query.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._all_terms_query_dict import AllTermsQueryDict -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._fuzzy import Fuzzy - - -class AllTermsQuery(BaseModel): - """ - Returns objects where the specified field contains all of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - field: FieldNameV1 - - value: StrictStr - - fuzzy: Optional[Fuzzy] = None - - type: Literal["allTerms"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AllTermsQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AllTermsQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_all_terms_query_dict.py b/foundry/v2/models/_all_terms_query_dict.py deleted file mode 100644 index 4db90b44..00000000 --- a/foundry/v2/models/_all_terms_query_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._fuzzy import Fuzzy - - -class AllTermsQueryDict(TypedDict): - """ - Returns objects where the specified field contains all of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: StrictStr - - fuzzy: NotRequired[Fuzzy] - - type: Literal["allTerms"] diff --git a/foundry/v2/models/_any_term_query.py b/foundry/v2/models/_any_term_query.py deleted file mode 100644 index 5951048d..00000000 --- a/foundry/v2/models/_any_term_query.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._any_term_query_dict import AnyTermQueryDict -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._fuzzy import Fuzzy - - -class AnyTermQuery(BaseModel): - """ - Returns objects where the specified field contains any of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - field: FieldNameV1 - - value: StrictStr - - fuzzy: Optional[Fuzzy] = None - - type: Literal["anyTerm"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AnyTermQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AnyTermQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_any_term_query_dict.py b/foundry/v2/models/_any_term_query_dict.py deleted file mode 100644 index 1d68e945..00000000 --- a/foundry/v2/models/_any_term_query_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._fuzzy import Fuzzy - - -class AnyTermQueryDict(TypedDict): - """ - Returns objects where the specified field contains any of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: StrictStr - - fuzzy: NotRequired[Fuzzy] - - type: Literal["anyTerm"] diff --git a/foundry/v2/models/_any_type.py b/foundry/v2/models/_any_type.py deleted file mode 100644 index 8ab2bdce..00000000 --- a/foundry/v2/models/_any_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._any_type_dict import AnyTypeDict - - -class AnyType(BaseModel): - """AnyType""" - - type: Literal["any"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AnyTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AnyTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_any_type_dict.py b/foundry/v2/models/_any_type_dict.py deleted file mode 100644 index 59b2cc37..00000000 --- a/foundry/v2/models/_any_type_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - - -class AnyTypeDict(TypedDict): - """AnyType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: Literal["any"] diff --git a/foundry/v2/models/_api_definition.py b/foundry/v2/models/_api_definition.py deleted file mode 100644 index 4fc102bd..00000000 --- a/foundry/v2/models/_api_definition.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._api_definition_deprecated import ApiDefinitionDeprecated -from foundry.v2.models._api_definition_dict import ApiDefinitionDict -from foundry.v2.models._api_definition_name import ApiDefinitionName -from foundry.v2.models._api_definition_rid import ApiDefinitionRid -from foundry.v2.models._ir_version import IrVersion - - -class ApiDefinition(BaseModel): - """ApiDefinition""" - - version: IrVersion - - rid: ApiDefinitionRid - - name: ApiDefinitionName - - deprecated: ApiDefinitionDeprecated - - ir: List[Any] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApiDefinitionDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ApiDefinitionDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_api_definition_deprecated.py b/foundry/v2/models/_api_definition_deprecated.py deleted file mode 100644 index df0593bd..00000000 --- a/foundry/v2/models/_api_definition_deprecated.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictBool - -ApiDefinitionDeprecated = StrictBool -"""ApiDefinitionDeprecated""" diff --git a/foundry/v2/models/_api_definition_dict.py b/foundry/v2/models/_api_definition_dict.py deleted file mode 100644 index d60ed970..00000000 --- a/foundry/v2/models/_api_definition_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._api_definition_deprecated import ApiDefinitionDeprecated -from foundry.v2.models._api_definition_name import ApiDefinitionName -from foundry.v2.models._api_definition_rid import ApiDefinitionRid -from foundry.v2.models._ir_version import IrVersion - - -class ApiDefinitionDict(TypedDict): - """ApiDefinition""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - version: IrVersion - - rid: ApiDefinitionRid - - name: ApiDefinitionName - - deprecated: ApiDefinitionDeprecated - - ir: List[Any] diff --git a/foundry/v2/models/_api_definition_name.py b/foundry/v2/models/_api_definition_name.py deleted file mode 100644 index cd02431e..00000000 --- a/foundry/v2/models/_api_definition_name.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -ApiDefinitionName = StrictStr -"""ApiDefinitionName""" diff --git a/foundry/v2/models/_api_definition_rid.py b/foundry/v2/models/_api_definition_rid.py deleted file mode 100644 index d67b8d8a..00000000 --- a/foundry/v2/models/_api_definition_rid.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import RID - -ApiDefinitionRid = RID -"""ApiDefinitionRid""" diff --git a/foundry/v2/models/_apply_action_mode.py b/foundry/v2/models/_apply_action_mode.py deleted file mode 100644 index 36bbf23e..00000000 --- a/foundry/v2/models/_apply_action_mode.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -ApplyActionMode = Literal["VALIDATE_ONLY", "VALIDATE_AND_EXECUTE"] -"""ApplyActionMode""" diff --git a/foundry/v2/models/_apply_action_request.py b/foundry/v2/models/_apply_action_request.py deleted file mode 100644 index a73afc15..00000000 --- a/foundry/v2/models/_apply_action_request.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._apply_action_request_dict import ApplyActionRequestDict -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._parameter_id import ParameterId - - -class ApplyActionRequest(BaseModel): - """ApplyActionRequest""" - - parameters: Dict[ParameterId, Optional[DataValue]] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApplyActionRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ApplyActionRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_apply_action_request_dict.py b/foundry/v2/models/_apply_action_request_dict.py deleted file mode 100644 index 8e7c1b5b..00000000 --- a/foundry/v2/models/_apply_action_request_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import TypedDict - -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._parameter_id import ParameterId - - -class ApplyActionRequestDict(TypedDict): - """ApplyActionRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v2/models/_apply_action_request_options.py b/foundry/v2/models/_apply_action_request_options.py deleted file mode 100644 index 1b5537c4..00000000 --- a/foundry/v2/models/_apply_action_request_options.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._apply_action_mode import ApplyActionMode -from foundry.v2.models._apply_action_request_options_dict import ( - ApplyActionRequestOptionsDict, -) # NOQA -from foundry.v2.models._return_edits_mode import ReturnEditsMode - - -class ApplyActionRequestOptions(BaseModel): - """ApplyActionRequestOptions""" - - mode: Optional[ApplyActionMode] = None - - return_edits: Optional[ReturnEditsMode] = Field(alias="returnEdits", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApplyActionRequestOptionsDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ApplyActionRequestOptionsDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_apply_action_request_options_dict.py b/foundry/v2/models/_apply_action_request_options_dict.py deleted file mode 100644 index f59e2469..00000000 --- a/foundry/v2/models/_apply_action_request_options_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._apply_action_mode import ApplyActionMode -from foundry.v2.models._return_edits_mode import ReturnEditsMode - - -class ApplyActionRequestOptionsDict(TypedDict): - """ApplyActionRequestOptions""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - mode: NotRequired[ApplyActionMode] - - returnEdits: NotRequired[ReturnEditsMode] diff --git a/foundry/v2/models/_apply_action_request_v2.py b/foundry/v2/models/_apply_action_request_v2.py deleted file mode 100644 index c217bc1b..00000000 --- a/foundry/v2/models/_apply_action_request_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._apply_action_request_options import ApplyActionRequestOptions -from foundry.v2.models._apply_action_request_v2_dict import ApplyActionRequestV2Dict -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._parameter_id import ParameterId - - -class ApplyActionRequestV2(BaseModel): - """ApplyActionRequestV2""" - - options: Optional[ApplyActionRequestOptions] = None - - parameters: Dict[ParameterId, Optional[DataValue]] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApplyActionRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ApplyActionRequestV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_apply_action_request_v2_dict.py b/foundry/v2/models/_apply_action_request_v2_dict.py deleted file mode 100644 index 19da349e..00000000 --- a/foundry/v2/models/_apply_action_request_v2_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._apply_action_request_options_dict import ( - ApplyActionRequestOptionsDict, -) # NOQA -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._parameter_id import ParameterId - - -class ApplyActionRequestV2Dict(TypedDict): - """ApplyActionRequestV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - options: NotRequired[ApplyActionRequestOptionsDict] - - parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v2/models/_apply_action_response.py b/foundry/v2/models/_apply_action_response.py deleted file mode 100644 index 90a458c2..00000000 --- a/foundry/v2/models/_apply_action_response.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._apply_action_response_dict import ApplyActionResponseDict - - -class ApplyActionResponse(BaseModel): - """ApplyActionResponse""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApplyActionResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ApplyActionResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_apply_action_response_dict.py b/foundry/v2/models/_apply_action_response_dict.py deleted file mode 100644 index 0bd59733..00000000 --- a/foundry/v2/models/_apply_action_response_dict.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - - -class ApplyActionResponseDict(TypedDict): - """ApplyActionResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/models/_approximate_distinct_aggregation.py b/foundry/v2/models/_approximate_distinct_aggregation.py deleted file mode 100644 index e10f0491..00000000 --- a/foundry/v2/models/_approximate_distinct_aggregation.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._approximate_distinct_aggregation_dict import ( - ApproximateDistinctAggregationDict, -) # NOQA -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class ApproximateDistinctAggregation(BaseModel): - """Computes an approximate number of distinct values for the provided field.""" - - field: FieldNameV1 - - name: Optional[AggregationMetricName] = None - - type: Literal["approximateDistinct"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApproximateDistinctAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ApproximateDistinctAggregationDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_approximate_distinct_aggregation_dict.py b/foundry/v2/models/_approximate_distinct_aggregation_dict.py deleted file mode 100644 index 2a88506b..00000000 --- a/foundry/v2/models/_approximate_distinct_aggregation_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class ApproximateDistinctAggregationDict(TypedDict): - """Computes an approximate number of distinct values for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - name: NotRequired[AggregationMetricName] - - type: Literal["approximateDistinct"] diff --git a/foundry/v2/models/_approximate_distinct_aggregation_v2.py b/foundry/v2/models/_approximate_distinct_aggregation_v2.py deleted file mode 100644 index 458106cf..00000000 --- a/foundry/v2/models/_approximate_distinct_aggregation_v2.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._approximate_distinct_aggregation_v2_dict import ( - ApproximateDistinctAggregationV2Dict, -) # NOQA -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._property_api_name import PropertyApiName - - -class ApproximateDistinctAggregationV2(BaseModel): - """Computes an approximate number of distinct values for the provided field.""" - - field: PropertyApiName - - name: Optional[AggregationMetricName] = None - - direction: Optional[OrderByDirection] = None - - type: Literal["approximateDistinct"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApproximateDistinctAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ApproximateDistinctAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_approximate_distinct_aggregation_v2_dict.py b/foundry/v2/models/_approximate_distinct_aggregation_v2_dict.py deleted file mode 100644 index b95c38ff..00000000 --- a/foundry/v2/models/_approximate_distinct_aggregation_v2_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._property_api_name import PropertyApiName - - -class ApproximateDistinctAggregationV2Dict(TypedDict): - """Computes an approximate number of distinct values for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - name: NotRequired[AggregationMetricName] - - direction: NotRequired[OrderByDirection] - - type: Literal["approximateDistinct"] diff --git a/foundry/v2/models/_approximate_percentile_aggregation_v2.py b/foundry/v2/models/_approximate_percentile_aggregation_v2.py deleted file mode 100644 index 7d9aa451..00000000 --- a/foundry/v2/models/_approximate_percentile_aggregation_v2.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictFloat - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._approximate_percentile_aggregation_v2_dict import ( - ApproximatePercentileAggregationV2Dict, -) # NOQA -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._property_api_name import PropertyApiName - - -class ApproximatePercentileAggregationV2(BaseModel): - """Computes the approximate percentile value for the provided field. Requires Object Storage V2.""" - - field: PropertyApiName - - name: Optional[AggregationMetricName] = None - - approximate_percentile: StrictFloat = Field(alias="approximatePercentile") - - direction: Optional[OrderByDirection] = None - - type: Literal["approximatePercentile"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ApproximatePercentileAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ApproximatePercentileAggregationV2Dict, - self.model_dump(by_alias=True, exclude_unset=True), - ) diff --git a/foundry/v2/models/_approximate_percentile_aggregation_v2_dict.py b/foundry/v2/models/_approximate_percentile_aggregation_v2_dict.py deleted file mode 100644 index 35de4a94..00000000 --- a/foundry/v2/models/_approximate_percentile_aggregation_v2_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictFloat -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._property_api_name import PropertyApiName - - -class ApproximatePercentileAggregationV2Dict(TypedDict): - """Computes the approximate percentile value for the provided field. Requires Object Storage V2.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - name: NotRequired[AggregationMetricName] - - approximatePercentile: StrictFloat - - direction: NotRequired[OrderByDirection] - - type: Literal["approximatePercentile"] diff --git a/foundry/v2/models/_archive_file_format.py b/foundry/v2/models/_archive_file_format.py deleted file mode 100644 index 4bcba7ea..00000000 --- a/foundry/v2/models/_archive_file_format.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -ArchiveFileFormat = Literal["ZIP"] -"""The format of an archive file.""" diff --git a/foundry/v2/models/_arg.py b/foundry/v2/models/_arg.py deleted file mode 100644 index 2911b285..00000000 --- a/foundry/v2/models/_arg.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._arg_dict import ArgDict - - -class Arg(BaseModel): - """Arg""" - - name: StrictStr - - value: StrictStr - - model_config = {"extra": "allow"} - - def to_dict(self) -> ArgDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ArgDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_arg_dict.py b/foundry/v2/models/_arg_dict.py deleted file mode 100644 index 1278721c..00000000 --- a/foundry/v2/models/_arg_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import TypedDict - - -class ArgDict(TypedDict): - """Arg""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: StrictStr - - value: StrictStr diff --git a/foundry/v2/models/_array_size_constraint.py b/foundry/v2/models/_array_size_constraint.py deleted file mode 100644 index 8fe34440..00000000 --- a/foundry/v2/models/_array_size_constraint.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._array_size_constraint_dict import ArraySizeConstraintDict - - -class ArraySizeConstraint(BaseModel): - """The parameter expects an array of values and the size of the array must fall within the defined range.""" - - lt: Optional[Any] = None - """Less than""" - - lte: Optional[Any] = None - """Less than or equal""" - - gt: Optional[Any] = None - """Greater than""" - - gte: Optional[Any] = None - """Greater than or equal""" - - type: Literal["arraySize"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ArraySizeConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ArraySizeConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_artifact_repository_rid.py b/foundry/v2/models/_artifact_repository_rid.py deleted file mode 100644 index 6818dd28..00000000 --- a/foundry/v2/models/_artifact_repository_rid.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import RID - -ArtifactRepositoryRid = RID -"""ArtifactRepositoryRid""" diff --git a/foundry/v2/models/_async_action_status.py b/foundry/v2/models/_async_action_status.py deleted file mode 100644 index 5f398c69..00000000 --- a/foundry/v2/models/_async_action_status.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -AsyncActionStatus = Literal[ - "RUNNING_SUBMISSION_CHECKS", - "EXECUTING_WRITE_BACK_WEBHOOK", - "COMPUTING_ONTOLOGY_EDITS", - "COMPUTING_FUNCTION", - "WRITING_ONTOLOGY_EDITS", - "EXECUTING_SIDE_EFFECT_WEBHOOK", - "SENDING_NOTIFICATIONS", -] -"""AsyncActionStatus""" diff --git a/foundry/v2/models/_async_apply_action_operation_response_v2.py b/foundry/v2/models/_async_apply_action_operation_response_v2.py deleted file mode 100644 index 4069df17..00000000 --- a/foundry/v2/models/_async_apply_action_operation_response_v2.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._async_apply_action_operation_response_v2_dict import ( - AsyncApplyActionOperationResponseV2Dict, -) # NOQA - - -class AsyncApplyActionOperationResponseV2(BaseModel): - """AsyncApplyActionOperationResponseV2""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> AsyncApplyActionOperationResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AsyncApplyActionOperationResponseV2Dict, - self.model_dump(by_alias=True, exclude_unset=True), - ) diff --git a/foundry/v2/models/_async_apply_action_operation_response_v2_dict.py b/foundry/v2/models/_async_apply_action_operation_response_v2_dict.py deleted file mode 100644 index 03cfc825..00000000 --- a/foundry/v2/models/_async_apply_action_operation_response_v2_dict.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - - -class AsyncApplyActionOperationResponseV2Dict(TypedDict): - """AsyncApplyActionOperationResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/models/_async_apply_action_request.py b/foundry/v2/models/_async_apply_action_request.py deleted file mode 100644 index 31b2e4d2..00000000 --- a/foundry/v2/models/_async_apply_action_request.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._async_apply_action_request_dict import AsyncApplyActionRequestDict # NOQA -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._parameter_id import ParameterId - - -class AsyncApplyActionRequest(BaseModel): - """AsyncApplyActionRequest""" - - parameters: Dict[ParameterId, Optional[DataValue]] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AsyncApplyActionRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AsyncApplyActionRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_async_apply_action_request_dict.py b/foundry/v2/models/_async_apply_action_request_dict.py deleted file mode 100644 index 99a39631..00000000 --- a/foundry/v2/models/_async_apply_action_request_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import TypedDict - -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._parameter_id import ParameterId - - -class AsyncApplyActionRequestDict(TypedDict): - """AsyncApplyActionRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v2/models/_async_apply_action_request_v2.py b/foundry/v2/models/_async_apply_action_request_v2.py deleted file mode 100644 index 6a99497b..00000000 --- a/foundry/v2/models/_async_apply_action_request_v2.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._async_apply_action_request_v2_dict import ( - AsyncApplyActionRequestV2Dict, -) # NOQA -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._parameter_id import ParameterId - - -class AsyncApplyActionRequestV2(BaseModel): - """AsyncApplyActionRequestV2""" - - parameters: Dict[ParameterId, Optional[DataValue]] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AsyncApplyActionRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AsyncApplyActionRequestV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_async_apply_action_request_v2_dict.py b/foundry/v2/models/_async_apply_action_request_v2_dict.py deleted file mode 100644 index e33e5075..00000000 --- a/foundry/v2/models/_async_apply_action_request_v2_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import TypedDict - -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._parameter_id import ParameterId - - -class AsyncApplyActionRequestV2Dict(TypedDict): - """AsyncApplyActionRequestV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v2/models/_async_apply_action_response.py b/foundry/v2/models/_async_apply_action_response.py deleted file mode 100644 index e1c8b51a..00000000 --- a/foundry/v2/models/_async_apply_action_response.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._async_apply_action_response_dict import AsyncApplyActionResponseDict # NOQA - - -class AsyncApplyActionResponse(BaseModel): - """AsyncApplyActionResponse""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> AsyncApplyActionResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AsyncApplyActionResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_async_apply_action_response_dict.py b/foundry/v2/models/_async_apply_action_response_dict.py deleted file mode 100644 index 39d048fb..00000000 --- a/foundry/v2/models/_async_apply_action_response_dict.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - - -class AsyncApplyActionResponseDict(TypedDict): - """AsyncApplyActionResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/models/_async_apply_action_response_v2.py b/foundry/v2/models/_async_apply_action_response_v2.py deleted file mode 100644 index 360534d5..00000000 --- a/foundry/v2/models/_async_apply_action_response_v2.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry._core.utils import RID -from foundry.v2.models._async_apply_action_response_v2_dict import ( - AsyncApplyActionResponseV2Dict, -) # NOQA - - -class AsyncApplyActionResponseV2(BaseModel): - """AsyncApplyActionResponseV2""" - - operation_id: RID = Field(alias="operationId") - - model_config = {"extra": "allow"} - - def to_dict(self) -> AsyncApplyActionResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - AsyncApplyActionResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_async_apply_action_response_v2_dict.py b/foundry/v2/models/_async_apply_action_response_v2_dict.py deleted file mode 100644 index 2748bc32..00000000 --- a/foundry/v2/models/_async_apply_action_response_v2_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry._core.utils import RID - - -class AsyncApplyActionResponseV2Dict(TypedDict): - """AsyncApplyActionResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - operationId: RID diff --git a/foundry/v2/models/_attachment.py b/foundry/v2/models/_attachment.py deleted file mode 100644 index b13b2d13..00000000 --- a/foundry/v2/models/_attachment.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._attachment_dict import AttachmentDict -from foundry.v2.models._attachment_rid import AttachmentRid -from foundry.v2.models._filename import Filename -from foundry.v2.models._media_type import MediaType -from foundry.v2.models._size_bytes import SizeBytes - - -class Attachment(BaseModel): - """The representation of an attachment.""" - - rid: AttachmentRid - - filename: Filename - - size_bytes: SizeBytes = Field(alias="sizeBytes") - - media_type: MediaType = Field(alias="mediaType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> AttachmentDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AttachmentDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_attachment_dict.py b/foundry/v2/models/_attachment_dict.py deleted file mode 100644 index 32892604..00000000 --- a/foundry/v2/models/_attachment_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._attachment_rid import AttachmentRid -from foundry.v2.models._filename import Filename -from foundry.v2.models._media_type import MediaType -from foundry.v2.models._size_bytes import SizeBytes - - -class AttachmentDict(TypedDict): - """The representation of an attachment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: AttachmentRid - - filename: Filename - - sizeBytes: SizeBytes - - mediaType: MediaType diff --git a/foundry/v2/models/_attachment_metadata_response.py b/foundry/v2/models/_attachment_metadata_response.py deleted file mode 100644 index ca3ebae1..00000000 --- a/foundry/v2/models/_attachment_metadata_response.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._attachment_v2 import AttachmentV2 -from foundry.v2.models._list_attachments_response_v2 import ListAttachmentsResponseV2 - -AttachmentMetadataResponse = Annotated[ - Union[AttachmentV2, ListAttachmentsResponseV2], Field(discriminator="type") -] -"""The attachment metadata response""" diff --git a/foundry/v2/models/_attachment_metadata_response_dict.py b/foundry/v2/models/_attachment_metadata_response_dict.py deleted file mode 100644 index d349e153..00000000 --- a/foundry/v2/models/_attachment_metadata_response_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._attachment_v2_dict import AttachmentV2Dict -from foundry.v2.models._list_attachments_response_v2_dict import ( - ListAttachmentsResponseV2Dict, -) # NOQA - -AttachmentMetadataResponseDict = Annotated[ - Union[AttachmentV2Dict, ListAttachmentsResponseV2Dict], Field(discriminator="type") -] -"""The attachment metadata response""" diff --git a/foundry/v2/models/_attachment_property.py b/foundry/v2/models/_attachment_property.py deleted file mode 100644 index 1d1a769f..00000000 --- a/foundry/v2/models/_attachment_property.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._attachment_property_dict import AttachmentPropertyDict -from foundry.v2.models._attachment_rid import AttachmentRid - - -class AttachmentProperty(BaseModel): - """The representation of an attachment as a data type.""" - - rid: AttachmentRid - - model_config = {"extra": "allow"} - - def to_dict(self) -> AttachmentPropertyDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AttachmentPropertyDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_attachment_property_dict.py b/foundry/v2/models/_attachment_property_dict.py deleted file mode 100644 index 155902f8..00000000 --- a/foundry/v2/models/_attachment_property_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._attachment_rid import AttachmentRid - - -class AttachmentPropertyDict(TypedDict): - """The representation of an attachment as a data type.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: AttachmentRid diff --git a/foundry/v2/models/_attachment_rid.py b/foundry/v2/models/_attachment_rid.py deleted file mode 100644 index 6eb7c7fc..00000000 --- a/foundry/v2/models/_attachment_rid.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import RID - -AttachmentRid = RID -"""The unique resource identifier of an attachment.""" diff --git a/foundry/v2/models/_attachment_type.py b/foundry/v2/models/_attachment_type.py deleted file mode 100644 index 4a1c24bd..00000000 --- a/foundry/v2/models/_attachment_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._attachment_type_dict import AttachmentTypeDict - - -class AttachmentType(BaseModel): - """AttachmentType""" - - type: Literal["attachment"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AttachmentTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AttachmentTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_attachment_type_dict.py b/foundry/v2/models/_attachment_type_dict.py deleted file mode 100644 index 9f6613d8..00000000 --- a/foundry/v2/models/_attachment_type_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - - -class AttachmentTypeDict(TypedDict): - """AttachmentType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: Literal["attachment"] diff --git a/foundry/v2/models/_attachment_v2.py b/foundry/v2/models/_attachment_v2.py deleted file mode 100644 index f800c680..00000000 --- a/foundry/v2/models/_attachment_v2.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._attachment_rid import AttachmentRid -from foundry.v2.models._attachment_v2_dict import AttachmentV2Dict -from foundry.v2.models._filename import Filename -from foundry.v2.models._media_type import MediaType -from foundry.v2.models._size_bytes import SizeBytes - - -class AttachmentV2(BaseModel): - """The representation of an attachment.""" - - rid: AttachmentRid - - filename: Filename - - size_bytes: SizeBytes = Field(alias="sizeBytes") - - media_type: MediaType = Field(alias="mediaType") - - type: Literal["single"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AttachmentV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AttachmentV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_attachment_v2_dict.py b/foundry/v2/models/_attachment_v2_dict.py deleted file mode 100644 index d4d5abb3..00000000 --- a/foundry/v2/models/_attachment_v2_dict.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._attachment_rid import AttachmentRid -from foundry.v2.models._filename import Filename -from foundry.v2.models._media_type import MediaType -from foundry.v2.models._size_bytes import SizeBytes - - -class AttachmentV2Dict(TypedDict): - """The representation of an attachment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: AttachmentRid - - filename: Filename - - sizeBytes: SizeBytes - - mediaType: MediaType - - type: Literal["single"] diff --git a/foundry/v2/models/_avg_aggregation.py b/foundry/v2/models/_avg_aggregation.py deleted file mode 100644 index a5f53b5b..00000000 --- a/foundry/v2/models/_avg_aggregation.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._avg_aggregation_dict import AvgAggregationDict -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class AvgAggregation(BaseModel): - """Computes the average value for the provided field.""" - - field: FieldNameV1 - - name: Optional[AggregationMetricName] = None - - type: Literal["avg"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AvgAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AvgAggregationDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_avg_aggregation_dict.py b/foundry/v2/models/_avg_aggregation_dict.py deleted file mode 100644 index c3cc6ed5..00000000 --- a/foundry/v2/models/_avg_aggregation_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class AvgAggregationDict(TypedDict): - """Computes the average value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - name: NotRequired[AggregationMetricName] - - type: Literal["avg"] diff --git a/foundry/v2/models/_avg_aggregation_v2.py b/foundry/v2/models/_avg_aggregation_v2.py deleted file mode 100644 index 0d784a49..00000000 --- a/foundry/v2/models/_avg_aggregation_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._avg_aggregation_v2_dict import AvgAggregationV2Dict -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._property_api_name import PropertyApiName - - -class AvgAggregationV2(BaseModel): - """Computes the average value for the provided field.""" - - field: PropertyApiName - - name: Optional[AggregationMetricName] = None - - direction: Optional[OrderByDirection] = None - - type: Literal["avg"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AvgAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AvgAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_avg_aggregation_v2_dict.py b/foundry/v2/models/_avg_aggregation_v2_dict.py deleted file mode 100644 index 5201593f..00000000 --- a/foundry/v2/models/_avg_aggregation_v2_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._property_api_name import PropertyApiName - - -class AvgAggregationV2Dict(TypedDict): - """Computes the average value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - name: NotRequired[AggregationMetricName] - - direction: NotRequired[OrderByDirection] - - type: Literal["avg"] diff --git a/foundry/v2/models/_b_box.py b/foundry/v2/models/_b_box.py deleted file mode 100644 index e6301dd0..00000000 --- a/foundry/v2/models/_b_box.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from foundry.v2.models._coordinate import Coordinate - -BBox = List[Coordinate] -""" -A GeoJSON object MAY have a member named "bbox" to include -information on the coordinate range for its Geometries, Features, or -FeatureCollections. The value of the bbox member MUST be an array of -length 2*n where n is the number of dimensions represented in the -contained geometries, with all axes of the most southwesterly point -followed by all axes of the more northeasterly point. The axes order -of a bbox follows the axes order of geometries. -""" diff --git a/foundry/v2/models/_batch_apply_action_request.py b/foundry/v2/models/_batch_apply_action_request.py deleted file mode 100644 index 858805c4..00000000 --- a/foundry/v2/models/_batch_apply_action_request.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._apply_action_request import ApplyActionRequest -from foundry.v2.models._batch_apply_action_request_dict import BatchApplyActionRequestDict # NOQA - - -class BatchApplyActionRequest(BaseModel): - """BatchApplyActionRequest""" - - requests: List[ApplyActionRequest] - - model_config = {"extra": "allow"} - - def to_dict(self) -> BatchApplyActionRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(BatchApplyActionRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_batch_apply_action_request_dict.py b/foundry/v2/models/_batch_apply_action_request_dict.py deleted file mode 100644 index b3b614b0..00000000 --- a/foundry/v2/models/_batch_apply_action_request_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._apply_action_request_dict import ApplyActionRequestDict - - -class BatchApplyActionRequestDict(TypedDict): - """BatchApplyActionRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - requests: List[ApplyActionRequestDict] diff --git a/foundry/v2/models/_batch_apply_action_request_item.py b/foundry/v2/models/_batch_apply_action_request_item.py deleted file mode 100644 index 15e8c2ae..00000000 --- a/foundry/v2/models/_batch_apply_action_request_item.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._batch_apply_action_request_item_dict import ( - BatchApplyActionRequestItemDict, -) # NOQA -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._parameter_id import ParameterId - - -class BatchApplyActionRequestItem(BaseModel): - """BatchApplyActionRequestItem""" - - parameters: Dict[ParameterId, Optional[DataValue]] - - model_config = {"extra": "allow"} - - def to_dict(self) -> BatchApplyActionRequestItemDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - BatchApplyActionRequestItemDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_batch_apply_action_request_item_dict.py b/foundry/v2/models/_batch_apply_action_request_item_dict.py deleted file mode 100644 index 6b4d4a4e..00000000 --- a/foundry/v2/models/_batch_apply_action_request_item_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import TypedDict - -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._parameter_id import ParameterId - - -class BatchApplyActionRequestItemDict(TypedDict): - """BatchApplyActionRequestItem""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v2/models/_batch_apply_action_request_options.py b/foundry/v2/models/_batch_apply_action_request_options.py deleted file mode 100644 index ef76434a..00000000 --- a/foundry/v2/models/_batch_apply_action_request_options.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._batch_apply_action_request_options_dict import ( - BatchApplyActionRequestOptionsDict, -) # NOQA -from foundry.v2.models._return_edits_mode import ReturnEditsMode - - -class BatchApplyActionRequestOptions(BaseModel): - """BatchApplyActionRequestOptions""" - - return_edits: Optional[ReturnEditsMode] = Field(alias="returnEdits", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> BatchApplyActionRequestOptionsDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - BatchApplyActionRequestOptionsDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_batch_apply_action_request_options_dict.py b/foundry/v2/models/_batch_apply_action_request_options_dict.py deleted file mode 100644 index 5ed12bb2..00000000 --- a/foundry/v2/models/_batch_apply_action_request_options_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._return_edits_mode import ReturnEditsMode - - -class BatchApplyActionRequestOptionsDict(TypedDict): - """BatchApplyActionRequestOptions""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - returnEdits: NotRequired[ReturnEditsMode] diff --git a/foundry/v2/models/_batch_apply_action_request_v2.py b/foundry/v2/models/_batch_apply_action_request_v2.py deleted file mode 100644 index 6ec6c72f..00000000 --- a/foundry/v2/models/_batch_apply_action_request_v2.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._batch_apply_action_request_item import BatchApplyActionRequestItem # NOQA -from foundry.v2.models._batch_apply_action_request_options import ( - BatchApplyActionRequestOptions, -) # NOQA -from foundry.v2.models._batch_apply_action_request_v2_dict import ( - BatchApplyActionRequestV2Dict, -) # NOQA - - -class BatchApplyActionRequestV2(BaseModel): - """BatchApplyActionRequestV2""" - - options: Optional[BatchApplyActionRequestOptions] = None - - requests: List[BatchApplyActionRequestItem] - - model_config = {"extra": "allow"} - - def to_dict(self) -> BatchApplyActionRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - BatchApplyActionRequestV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_batch_apply_action_request_v2_dict.py b/foundry/v2/models/_batch_apply_action_request_v2_dict.py deleted file mode 100644 index 95358db6..00000000 --- a/foundry/v2/models/_batch_apply_action_request_v2_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._batch_apply_action_request_item_dict import ( - BatchApplyActionRequestItemDict, -) # NOQA -from foundry.v2.models._batch_apply_action_request_options_dict import ( - BatchApplyActionRequestOptionsDict, -) # NOQA - - -class BatchApplyActionRequestV2Dict(TypedDict): - """BatchApplyActionRequestV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - options: NotRequired[BatchApplyActionRequestOptionsDict] - - requests: List[BatchApplyActionRequestItemDict] diff --git a/foundry/v2/models/_batch_apply_action_response.py b/foundry/v2/models/_batch_apply_action_response.py deleted file mode 100644 index 703bf933..00000000 --- a/foundry/v2/models/_batch_apply_action_response.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._batch_apply_action_response_dict import BatchApplyActionResponseDict # NOQA - - -class BatchApplyActionResponse(BaseModel): - """BatchApplyActionResponse""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> BatchApplyActionResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - BatchApplyActionResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_batch_apply_action_response_dict.py b/foundry/v2/models/_batch_apply_action_response_dict.py deleted file mode 100644 index faea07b6..00000000 --- a/foundry/v2/models/_batch_apply_action_response_dict.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - - -class BatchApplyActionResponseDict(TypedDict): - """BatchApplyActionResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/models/_batch_apply_action_response_v2.py b/foundry/v2/models/_batch_apply_action_response_v2.py deleted file mode 100644 index 66524019..00000000 --- a/foundry/v2/models/_batch_apply_action_response_v2.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._action_results import ActionResults -from foundry.v2.models._batch_apply_action_response_v2_dict import ( - BatchApplyActionResponseV2Dict, -) # NOQA - - -class BatchApplyActionResponseV2(BaseModel): - """BatchApplyActionResponseV2""" - - edits: Optional[ActionResults] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> BatchApplyActionResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - BatchApplyActionResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_batch_apply_action_response_v2_dict.py b/foundry/v2/models/_batch_apply_action_response_v2_dict.py deleted file mode 100644 index 2d081524..00000000 --- a/foundry/v2/models/_batch_apply_action_response_v2_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._action_results_dict import ActionResultsDict - - -class BatchApplyActionResponseV2Dict(TypedDict): - """BatchApplyActionResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - edits: NotRequired[ActionResultsDict] diff --git a/foundry/v2/models/_binary_type.py b/foundry/v2/models/_binary_type.py deleted file mode 100644 index 892a8a00..00000000 --- a/foundry/v2/models/_binary_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._binary_type_dict import BinaryTypeDict - - -class BinaryType(BaseModel): - """BinaryType""" - - type: Literal["binary"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> BinaryTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(BinaryTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_binary_type_dict.py b/foundry/v2/models/_binary_type_dict.py deleted file mode 100644 index b4fd1b9a..00000000 --- a/foundry/v2/models/_binary_type_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - - -class BinaryTypeDict(TypedDict): - """BinaryType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: Literal["binary"] diff --git a/foundry/v2/models/_blueprint_icon.py b/foundry/v2/models/_blueprint_icon.py deleted file mode 100644 index 53468810..00000000 --- a/foundry/v2/models/_blueprint_icon.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._blueprint_icon_dict import BlueprintIconDict - - -class BlueprintIcon(BaseModel): - """BlueprintIcon""" - - color: StrictStr - """A hexadecimal color code.""" - - name: StrictStr - """ - The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. - Used to specify the Blueprint icon to represent the object type in a React app. - """ - - type: Literal["blueprint"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> BlueprintIconDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(BlueprintIconDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_blueprint_icon_dict.py b/foundry/v2/models/_blueprint_icon_dict.py deleted file mode 100644 index 00c8e21e..00000000 --- a/foundry/v2/models/_blueprint_icon_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import TypedDict - - -class BlueprintIconDict(TypedDict): - """BlueprintIcon""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - color: StrictStr - """A hexadecimal color code.""" - - name: StrictStr - """ - The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. - Used to specify the Blueprint icon to represent the object type in a React app. - """ - - type: Literal["blueprint"] diff --git a/foundry/v2/models/_boolean_type.py b/foundry/v2/models/_boolean_type.py deleted file mode 100644 index eb7a7037..00000000 --- a/foundry/v2/models/_boolean_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._boolean_type_dict import BooleanTypeDict - - -class BooleanType(BaseModel): - """BooleanType""" - - type: Literal["boolean"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> BooleanTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(BooleanTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_bounding_box_value.py b/foundry/v2/models/_bounding_box_value.py deleted file mode 100644 index 57b5fce0..00000000 --- a/foundry/v2/models/_bounding_box_value.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._bounding_box_value_dict import BoundingBoxValueDict -from foundry.v2.models._within_bounding_box_point import WithinBoundingBoxPoint - - -class BoundingBoxValue(BaseModel): - """The top left and bottom right coordinate points that make up the bounding box.""" - - top_left: WithinBoundingBoxPoint = Field(alias="topLeft") - - bottom_right: WithinBoundingBoxPoint = Field(alias="bottomRight") - - model_config = {"extra": "allow"} - - def to_dict(self) -> BoundingBoxValueDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(BoundingBoxValueDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_bounding_box_value_dict.py b/foundry/v2/models/_bounding_box_value_dict.py deleted file mode 100644 index 71a71c0a..00000000 --- a/foundry/v2/models/_bounding_box_value_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._within_bounding_box_point_dict import WithinBoundingBoxPointDict - - -class BoundingBoxValueDict(TypedDict): - """The top left and bottom right coordinate points that make up the bounding box.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - topLeft: WithinBoundingBoxPointDict - - bottomRight: WithinBoundingBoxPointDict diff --git a/foundry/v2/models/_branch.py b/foundry/v2/models/_branch.py deleted file mode 100644 index 16d9b0bc..00000000 --- a/foundry/v2/models/_branch.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._branch_dict import BranchDict -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._transaction_rid import TransactionRid - - -class Branch(BaseModel): - """Branch""" - - name: BranchName - - transaction_rid: Optional[TransactionRid] = Field(alias="transactionRid", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> BranchDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(BranchDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_branch_dict.py b/foundry/v2/models/_branch_dict.py deleted file mode 100644 index 0219420b..00000000 --- a/foundry/v2/models/_branch_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._transaction_rid import TransactionRid - - -class BranchDict(TypedDict): - """Branch""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: BranchName - - transactionRid: NotRequired[TransactionRid] diff --git a/foundry/v2/models/_branch_id.py b/foundry/v2/models/_branch_id.py deleted file mode 100644 index 4bcbdecd..00000000 --- a/foundry/v2/models/_branch_id.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -BranchId = StrictStr -"""The identifier (name) of a Branch. Example: `master`.""" diff --git a/foundry/v2/models/_build.py b/foundry/v2/models/_build.py deleted file mode 100644 index 5a6a8927..00000000 --- a/foundry/v2/models/_build.py +++ /dev/null @@ -1,64 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._abort_on_failure import AbortOnFailure -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._build_dict import BuildDict -from foundry.v2.models._build_rid import BuildRid -from foundry.v2.models._build_status import BuildStatus -from foundry.v2.models._created_by import CreatedBy -from foundry.v2.models._created_time import CreatedTime -from foundry.v2.models._fallback_branches import FallbackBranches -from foundry.v2.models._retry_backoff_duration import RetryBackoffDuration -from foundry.v2.models._retry_count import RetryCount - - -class Build(BaseModel): - """Build""" - - rid: BuildRid - """The RID of a build""" - - branch_name: BranchName = Field(alias="branchName") - """The branch that the build is running on.""" - - created_time: CreatedTime = Field(alias="createdTime") - """The timestamp that the build was created.""" - - created_by: CreatedBy = Field(alias="createdBy") - """The user who created the build.""" - - fallback_branches: FallbackBranches = Field(alias="fallbackBranches") - - retry_count: RetryCount = Field(alias="retryCount") - - retry_backoff_duration: RetryBackoffDuration = Field(alias="retryBackoffDuration") - - abort_on_failure: AbortOnFailure = Field(alias="abortOnFailure") - - status: BuildStatus - - model_config = {"extra": "allow"} - - def to_dict(self) -> BuildDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(BuildDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_build_dict.py b/foundry/v2/models/_build_dict.py deleted file mode 100644 index e353efbc..00000000 --- a/foundry/v2/models/_build_dict.py +++ /dev/null @@ -1,56 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._abort_on_failure import AbortOnFailure -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._build_rid import BuildRid -from foundry.v2.models._build_status import BuildStatus -from foundry.v2.models._created_by import CreatedBy -from foundry.v2.models._created_time import CreatedTime -from foundry.v2.models._fallback_branches import FallbackBranches -from foundry.v2.models._retry_backoff_duration_dict import RetryBackoffDurationDict -from foundry.v2.models._retry_count import RetryCount - - -class BuildDict(TypedDict): - """Build""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: BuildRid - """The RID of a build""" - - branchName: BranchName - """The branch that the build is running on.""" - - createdTime: CreatedTime - """The timestamp that the build was created.""" - - createdBy: CreatedBy - """The user who created the build.""" - - fallbackBranches: FallbackBranches - - retryCount: RetryCount - - retryBackoffDuration: RetryBackoffDurationDict - - abortOnFailure: AbortOnFailure - - status: BuildStatus diff --git a/foundry/v2/models/_build_target.py b/foundry/v2/models/_build_target.py deleted file mode 100644 index 9354f5db..00000000 --- a/foundry/v2/models/_build_target.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._connecting_target import ConnectingTarget -from foundry.v2.models._manual_target import ManualTarget -from foundry.v2.models._upstream_target import UpstreamTarget - -BuildTarget = Annotated[ - Union[ManualTarget, UpstreamTarget, ConnectingTarget], Field(discriminator="type") -] -"""The targets of the build.""" diff --git a/foundry/v2/models/_build_target_dict.py b/foundry/v2/models/_build_target_dict.py deleted file mode 100644 index 10ef856b..00000000 --- a/foundry/v2/models/_build_target_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._connecting_target_dict import ConnectingTargetDict -from foundry.v2.models._manual_target_dict import ManualTargetDict -from foundry.v2.models._upstream_target_dict import UpstreamTargetDict - -BuildTargetDict = Annotated[ - Union[ManualTargetDict, UpstreamTargetDict, ConnectingTargetDict], Field(discriminator="type") -] -"""The targets of the build.""" diff --git a/foundry/v2/models/_byte_type.py b/foundry/v2/models/_byte_type.py deleted file mode 100644 index 14e20650..00000000 --- a/foundry/v2/models/_byte_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._byte_type_dict import ByteTypeDict - - -class ByteType(BaseModel): - """ByteType""" - - type: Literal["byte"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ByteTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ByteTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_center_point.py b/foundry/v2/models/_center_point.py deleted file mode 100644 index cb88c5aa..00000000 --- a/foundry/v2/models/_center_point.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._center_point_dict import CenterPointDict -from foundry.v2.models._center_point_types import CenterPointTypes -from foundry.v2.models._distance import Distance - - -class CenterPoint(BaseModel): - """The coordinate point to use as the center of the distance query.""" - - center: CenterPointTypes - - distance: Distance - - model_config = {"extra": "allow"} - - def to_dict(self) -> CenterPointDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CenterPointDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_center_point_dict.py b/foundry/v2/models/_center_point_dict.py deleted file mode 100644 index fc4055af..00000000 --- a/foundry/v2/models/_center_point_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._center_point_types_dict import CenterPointTypesDict -from foundry.v2.models._distance_dict import DistanceDict - - -class CenterPointDict(TypedDict): - """The coordinate point to use as the center of the distance query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - center: CenterPointTypesDict - - distance: DistanceDict diff --git a/foundry/v2/models/_center_point_types.py b/foundry/v2/models/_center_point_types.py deleted file mode 100644 index c4a1ef5e..00000000 --- a/foundry/v2/models/_center_point_types.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v2.models._geo_point import GeoPoint - -CenterPointTypes = GeoPoint -"""CenterPointTypes""" diff --git a/foundry/v2/models/_center_point_types_dict.py b/foundry/v2/models/_center_point_types_dict.py deleted file mode 100644 index bd044a69..00000000 --- a/foundry/v2/models/_center_point_types_dict.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v2.models._geo_point_dict import GeoPointDict - -CenterPointTypesDict = GeoPointDict -"""CenterPointTypes""" diff --git a/foundry/v2/models/_contains_all_terms_in_order_prefix_last_term.py b/foundry/v2/models/_contains_all_terms_in_order_prefix_last_term.py deleted file mode 100644 index 9595bc53..00000000 --- a/foundry/v2/models/_contains_all_terms_in_order_prefix_last_term.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._contains_all_terms_in_order_prefix_last_term_dict import ( - ContainsAllTermsInOrderPrefixLastTermDict, -) # NOQA -from foundry.v2.models._property_api_name import PropertyApiName - - -class ContainsAllTermsInOrderPrefixLastTerm(BaseModel): - """ - Returns objects where the specified field contains all of the terms in the order provided, - but they do have to be adjacent to each other. - The last term can be a partial prefix match. - """ - - field: PropertyApiName - - value: StrictStr - - type: Literal["containsAllTermsInOrderPrefixLastTerm"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ContainsAllTermsInOrderPrefixLastTermDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ContainsAllTermsInOrderPrefixLastTermDict, - self.model_dump(by_alias=True, exclude_unset=True), - ) diff --git a/foundry/v2/models/_contains_all_terms_in_order_prefix_last_term_dict.py b/foundry/v2/models/_contains_all_terms_in_order_prefix_last_term_dict.py deleted file mode 100644 index 917f4c08..00000000 --- a/foundry/v2/models/_contains_all_terms_in_order_prefix_last_term_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName - - -class ContainsAllTermsInOrderPrefixLastTermDict(TypedDict): - """ - Returns objects where the specified field contains all of the terms in the order provided, - but they do have to be adjacent to each other. - The last term can be a partial prefix match. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: StrictStr - - type: Literal["containsAllTermsInOrderPrefixLastTerm"] diff --git a/foundry/v2/models/_contains_all_terms_in_order_query.py b/foundry/v2/models/_contains_all_terms_in_order_query.py deleted file mode 100644 index 526b7fee..00000000 --- a/foundry/v2/models/_contains_all_terms_in_order_query.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._contains_all_terms_in_order_query_dict import ( - ContainsAllTermsInOrderQueryDict, -) # NOQA -from foundry.v2.models._property_api_name import PropertyApiName - - -class ContainsAllTermsInOrderQuery(BaseModel): - """ - Returns objects where the specified field contains all of the terms in the order provided, - but they do have to be adjacent to each other. - """ - - field: PropertyApiName - - value: StrictStr - - type: Literal["containsAllTermsInOrder"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ContainsAllTermsInOrderQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ContainsAllTermsInOrderQueryDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_contains_all_terms_in_order_query_dict.py b/foundry/v2/models/_contains_all_terms_in_order_query_dict.py deleted file mode 100644 index eee66243..00000000 --- a/foundry/v2/models/_contains_all_terms_in_order_query_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName - - -class ContainsAllTermsInOrderQueryDict(TypedDict): - """ - Returns objects where the specified field contains all of the terms in the order provided, - but they do have to be adjacent to each other. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: StrictStr - - type: Literal["containsAllTermsInOrder"] diff --git a/foundry/v2/models/_contains_all_terms_query.py b/foundry/v2/models/_contains_all_terms_query.py deleted file mode 100644 index 36cb4375..00000000 --- a/foundry/v2/models/_contains_all_terms_query.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._contains_all_terms_query_dict import ContainsAllTermsQueryDict -from foundry.v2.models._fuzzy_v2 import FuzzyV2 -from foundry.v2.models._property_api_name import PropertyApiName - - -class ContainsAllTermsQuery(BaseModel): - """ - Returns objects where the specified field contains all of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - field: PropertyApiName - - value: StrictStr - - fuzzy: Optional[FuzzyV2] = None - - type: Literal["containsAllTerms"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ContainsAllTermsQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ContainsAllTermsQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_contains_all_terms_query_dict.py b/foundry/v2/models/_contains_all_terms_query_dict.py deleted file mode 100644 index 531ead99..00000000 --- a/foundry/v2/models/_contains_all_terms_query_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._fuzzy_v2 import FuzzyV2 -from foundry.v2.models._property_api_name import PropertyApiName - - -class ContainsAllTermsQueryDict(TypedDict): - """ - Returns objects where the specified field contains all of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: StrictStr - - fuzzy: NotRequired[FuzzyV2] - - type: Literal["containsAllTerms"] diff --git a/foundry/v2/models/_contains_any_term_query.py b/foundry/v2/models/_contains_any_term_query.py deleted file mode 100644 index a099601b..00000000 --- a/foundry/v2/models/_contains_any_term_query.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._contains_any_term_query_dict import ContainsAnyTermQueryDict -from foundry.v2.models._fuzzy_v2 import FuzzyV2 -from foundry.v2.models._property_api_name import PropertyApiName - - -class ContainsAnyTermQuery(BaseModel): - """ - Returns objects where the specified field contains any of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - field: PropertyApiName - - value: StrictStr - - fuzzy: Optional[FuzzyV2] = None - - type: Literal["containsAnyTerm"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ContainsAnyTermQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ContainsAnyTermQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_contains_any_term_query_dict.py b/foundry/v2/models/_contains_any_term_query_dict.py deleted file mode 100644 index 4ecf84cb..00000000 --- a/foundry/v2/models/_contains_any_term_query_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._fuzzy_v2 import FuzzyV2 -from foundry.v2.models._property_api_name import PropertyApiName - - -class ContainsAnyTermQueryDict(TypedDict): - """ - Returns objects where the specified field contains any of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: StrictStr - - fuzzy: NotRequired[FuzzyV2] - - type: Literal["containsAnyTerm"] diff --git a/foundry/v2/models/_contains_query.py b/foundry/v2/models/_contains_query.py deleted file mode 100644 index 6043cf5e..00000000 --- a/foundry/v2/models/_contains_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._contains_query_dict import ContainsQueryDict -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._property_value import PropertyValue - - -class ContainsQuery(BaseModel): - """Returns objects where the specified array contains a value.""" - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["contains"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ContainsQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ContainsQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_contains_query_dict.py b/foundry/v2/models/_contains_query_dict.py deleted file mode 100644 index 4f92a4bb..00000000 --- a/foundry/v2/models/_contains_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._property_value import PropertyValue - - -class ContainsQueryDict(TypedDict): - """Returns objects where the specified array contains a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["contains"] diff --git a/foundry/v2/models/_contains_query_v2.py b/foundry/v2/models/_contains_query_v2.py deleted file mode 100644 index 19dac76c..00000000 --- a/foundry/v2/models/_contains_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._contains_query_v2_dict import ContainsQueryV2Dict -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - - -class ContainsQueryV2(BaseModel): - """Returns objects where the specified array contains a value.""" - - field: PropertyApiName - - value: PropertyValue - - type: Literal["contains"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ContainsQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ContainsQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_contains_query_v2_dict.py b/foundry/v2/models/_contains_query_v2_dict.py deleted file mode 100644 index 717a1e36..00000000 --- a/foundry/v2/models/_contains_query_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - - -class ContainsQueryV2Dict(TypedDict): - """Returns objects where the specified array contains a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PropertyValue - - type: Literal["contains"] diff --git a/foundry/v2/models/_content_length.py b/foundry/v2/models/_content_length.py deleted file mode 100644 index 45c14a48..00000000 --- a/foundry/v2/models/_content_length.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -ContentLength = StrictStr -"""ContentLength""" diff --git a/foundry/v2/models/_content_type.py b/foundry/v2/models/_content_type.py deleted file mode 100644 index eb8607da..00000000 --- a/foundry/v2/models/_content_type.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -ContentType = StrictStr -"""ContentType""" diff --git a/foundry/v2/models/_coordinate.py b/foundry/v2/models/_coordinate.py deleted file mode 100644 index 0d09d0c4..00000000 --- a/foundry/v2/models/_coordinate.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictFloat - -Coordinate = StrictFloat -"""Coordinate""" diff --git a/foundry/v2/models/_count_aggregation.py b/foundry/v2/models/_count_aggregation.py deleted file mode 100644 index 2ada3e48..00000000 --- a/foundry/v2/models/_count_aggregation.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._count_aggregation_dict import CountAggregationDict - - -class CountAggregation(BaseModel): - """Computes the total count of objects.""" - - name: Optional[AggregationMetricName] = None - - type: Literal["count"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> CountAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CountAggregationDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_count_aggregation_dict.py b/foundry/v2/models/_count_aggregation_dict.py deleted file mode 100644 index d8a93b69..00000000 --- a/foundry/v2/models/_count_aggregation_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName - - -class CountAggregationDict(TypedDict): - """Computes the total count of objects.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: NotRequired[AggregationMetricName] - - type: Literal["count"] diff --git a/foundry/v2/models/_count_aggregation_v2.py b/foundry/v2/models/_count_aggregation_v2.py deleted file mode 100644 index 190ad7c9..00000000 --- a/foundry/v2/models/_count_aggregation_v2.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._count_aggregation_v2_dict import CountAggregationV2Dict -from foundry.v2.models._order_by_direction import OrderByDirection - - -class CountAggregationV2(BaseModel): - """Computes the total count of objects.""" - - name: Optional[AggregationMetricName] = None - - direction: Optional[OrderByDirection] = None - - type: Literal["count"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> CountAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CountAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_count_aggregation_v2_dict.py b/foundry/v2/models/_count_aggregation_v2_dict.py deleted file mode 100644 index f14c1134..00000000 --- a/foundry/v2/models/_count_aggregation_v2_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._order_by_direction import OrderByDirection - - -class CountAggregationV2Dict(TypedDict): - """Computes the total count of objects.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: NotRequired[AggregationMetricName] - - direction: NotRequired[OrderByDirection] - - type: Literal["count"] diff --git a/foundry/v2/models/_count_objects_response_v2.py b/foundry/v2/models/_count_objects_response_v2.py deleted file mode 100644 index cff52965..00000000 --- a/foundry/v2/models/_count_objects_response_v2.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictInt - -from foundry.v2.models._count_objects_response_v2_dict import CountObjectsResponseV2Dict - - -class CountObjectsResponseV2(BaseModel): - """CountObjectsResponseV2""" - - count: Optional[StrictInt] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> CountObjectsResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CountObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_count_objects_response_v2_dict.py b/foundry/v2/models/_count_objects_response_v2_dict.py deleted file mode 100644 index 85ff7ee8..00000000 --- a/foundry/v2/models/_count_objects_response_v2_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictInt -from typing_extensions import NotRequired -from typing_extensions import TypedDict - - -class CountObjectsResponseV2Dict(TypedDict): - """CountObjectsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - count: NotRequired[StrictInt] diff --git a/foundry/v2/models/_create_branch_request.py b/foundry/v2/models/_create_branch_request.py deleted file mode 100644 index ca27ad75..00000000 --- a/foundry/v2/models/_create_branch_request.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._create_branch_request_dict import CreateBranchRequestDict -from foundry.v2.models._transaction_rid import TransactionRid - - -class CreateBranchRequest(BaseModel): - """CreateBranchRequest""" - - transaction_rid: Optional[TransactionRid] = Field(alias="transactionRid", default=None) - - name: BranchName - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateBranchRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CreateBranchRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_create_branch_request_dict.py b/foundry/v2/models/_create_branch_request_dict.py deleted file mode 100644 index 9e2a45df..00000000 --- a/foundry/v2/models/_create_branch_request_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._transaction_rid import TransactionRid - - -class CreateBranchRequestDict(TypedDict): - """CreateBranchRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - transactionRid: NotRequired[TransactionRid] - - name: BranchName diff --git a/foundry/v2/models/_create_builds_request.py b/foundry/v2/models/_create_builds_request.py deleted file mode 100644 index 1b68c6db..00000000 --- a/foundry/v2/models/_create_builds_request.py +++ /dev/null @@ -1,65 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._abort_on_failure import AbortOnFailure -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._build_target import BuildTarget -from foundry.v2.models._create_builds_request_dict import CreateBuildsRequestDict -from foundry.v2.models._fallback_branches import FallbackBranches -from foundry.v2.models._force_build import ForceBuild -from foundry.v2.models._notifications_enabled import NotificationsEnabled -from foundry.v2.models._retry_backoff_duration import RetryBackoffDuration -from foundry.v2.models._retry_count import RetryCount - - -class CreateBuildsRequest(BaseModel): - """CreateBuildsRequest""" - - target: BuildTarget - """The targets of the schedule.""" - - branch_name: Optional[BranchName] = Field(alias="branchName", default=None) - """The target branch the build should run on.""" - - fallback_branches: FallbackBranches = Field(alias="fallbackBranches") - - force_build: Optional[ForceBuild] = Field(alias="forceBuild", default=None) - - retry_count: Optional[RetryCount] = Field(alias="retryCount", default=None) - """The number of retry attempts for failed jobs.""" - - retry_backoff_duration: Optional[RetryBackoffDuration] = Field( - alias="retryBackoffDuration", default=None - ) - - abort_on_failure: Optional[AbortOnFailure] = Field(alias="abortOnFailure", default=None) - - notifications_enabled: Optional[NotificationsEnabled] = Field( - alias="notificationsEnabled", default=None - ) - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateBuildsRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CreateBuildsRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_create_builds_request_dict.py b/foundry/v2/models/_create_builds_request_dict.py deleted file mode 100644 index c93f2bd0..00000000 --- a/foundry/v2/models/_create_builds_request_dict.py +++ /dev/null @@ -1,53 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._abort_on_failure import AbortOnFailure -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._build_target_dict import BuildTargetDict -from foundry.v2.models._fallback_branches import FallbackBranches -from foundry.v2.models._force_build import ForceBuild -from foundry.v2.models._notifications_enabled import NotificationsEnabled -from foundry.v2.models._retry_backoff_duration_dict import RetryBackoffDurationDict -from foundry.v2.models._retry_count import RetryCount - - -class CreateBuildsRequestDict(TypedDict): - """CreateBuildsRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - target: BuildTargetDict - """The targets of the schedule.""" - - branchName: NotRequired[BranchName] - """The target branch the build should run on.""" - - fallbackBranches: FallbackBranches - - forceBuild: NotRequired[ForceBuild] - - retryCount: NotRequired[RetryCount] - """The number of retry attempts for failed jobs.""" - - retryBackoffDuration: NotRequired[RetryBackoffDurationDict] - - abortOnFailure: NotRequired[AbortOnFailure] - - notificationsEnabled: NotRequired[NotificationsEnabled] diff --git a/foundry/v2/models/_create_dataset_request.py b/foundry/v2/models/_create_dataset_request.py deleted file mode 100644 index 4e7b6110..00000000 --- a/foundry/v2/models/_create_dataset_request.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._create_dataset_request_dict import CreateDatasetRequestDict -from foundry.v2.models._dataset_name import DatasetName -from foundry.v2.models._folder_rid import FolderRid - - -class CreateDatasetRequest(BaseModel): - """CreateDatasetRequest""" - - parent_folder_rid: FolderRid = Field(alias="parentFolderRid") - - name: DatasetName - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateDatasetRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CreateDatasetRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_create_dataset_request_dict.py b/foundry/v2/models/_create_dataset_request_dict.py deleted file mode 100644 index e47756d8..00000000 --- a/foundry/v2/models/_create_dataset_request_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._dataset_name import DatasetName -from foundry.v2.models._folder_rid import FolderRid - - -class CreateDatasetRequestDict(TypedDict): - """CreateDatasetRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parentFolderRid: FolderRid - - name: DatasetName diff --git a/foundry/v2/models/_create_group_request.py b/foundry/v2/models/_create_group_request.py deleted file mode 100644 index 959bd2c1..00000000 --- a/foundry/v2/models/_create_group_request.py +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._attribute_name import AttributeName -from foundry.v2.models._attribute_values import AttributeValues -from foundry.v2.models._create_group_request_dict import CreateGroupRequestDict -from foundry.v2.models._group_name import GroupName -from foundry.v2.models._organization_rid import OrganizationRid - - -class CreateGroupRequest(BaseModel): - """CreateGroupRequest""" - - name: GroupName - """The name of the Group.""" - - organizations: List[OrganizationRid] - """The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed.""" - - description: Optional[StrictStr] = None - """A description of the Group.""" - - attributes: Dict[AttributeName, AttributeValues] - """A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateGroupRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CreateGroupRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_create_group_request_dict.py b/foundry/v2/models/_create_group_request_dict.py deleted file mode 100644 index 14112a5b..00000000 --- a/foundry/v2/models/_create_group_request_dict.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._attribute_name import AttributeName -from foundry.v2.models._attribute_values import AttributeValues -from foundry.v2.models._group_name import GroupName -from foundry.v2.models._organization_rid import OrganizationRid - - -class CreateGroupRequestDict(TypedDict): - """CreateGroupRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: GroupName - """The name of the Group.""" - - organizations: List[OrganizationRid] - """The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed.""" - - description: NotRequired[StrictStr] - """A description of the Group.""" - - attributes: Dict[AttributeName, AttributeValues] - """A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change.""" diff --git a/foundry/v2/models/_create_link_rule.py b/foundry/v2/models/_create_link_rule.py deleted file mode 100644 index ad54bf2a..00000000 --- a/foundry/v2/models/_create_link_rule.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._create_link_rule_dict import CreateLinkRuleDict -from foundry.v2.models._link_type_api_name import LinkTypeApiName -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class CreateLinkRule(BaseModel): - """CreateLinkRule""" - - link_type_api_name_ato_b: LinkTypeApiName = Field(alias="linkTypeApiNameAtoB") - - link_type_api_name_bto_a: LinkTypeApiName = Field(alias="linkTypeApiNameBtoA") - - a_side_object_type_api_name: ObjectTypeApiName = Field(alias="aSideObjectTypeApiName") - - b_side_object_type_api_name: ObjectTypeApiName = Field(alias="bSideObjectTypeApiName") - - type: Literal["createLink"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateLinkRuleDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CreateLinkRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_create_link_rule_dict.py b/foundry/v2/models/_create_link_rule_dict.py deleted file mode 100644 index b400e934..00000000 --- a/foundry/v2/models/_create_link_rule_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._link_type_api_name import LinkTypeApiName -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class CreateLinkRuleDict(TypedDict): - """CreateLinkRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - linkTypeApiNameAtoB: LinkTypeApiName - - linkTypeApiNameBtoA: LinkTypeApiName - - aSideObjectTypeApiName: ObjectTypeApiName - - bSideObjectTypeApiName: ObjectTypeApiName - - type: Literal["createLink"] diff --git a/foundry/v2/models/_create_object_rule.py b/foundry/v2/models/_create_object_rule.py deleted file mode 100644 index efe741c9..00000000 --- a/foundry/v2/models/_create_object_rule.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._create_object_rule_dict import CreateObjectRuleDict -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class CreateObjectRule(BaseModel): - """CreateObjectRule""" - - object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") - - type: Literal["createObject"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateObjectRuleDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(CreateObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_create_object_rule_dict.py b/foundry/v2/models/_create_object_rule_dict.py deleted file mode 100644 index 28fd7a1d..00000000 --- a/foundry/v2/models/_create_object_rule_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class CreateObjectRuleDict(TypedDict): - """CreateObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectTypeApiName: ObjectTypeApiName - - type: Literal["createObject"] diff --git a/foundry/v2/models/_create_temporary_object_set_request_v2.py b/foundry/v2/models/_create_temporary_object_set_request_v2.py deleted file mode 100644 index 8f0d4d29..00000000 --- a/foundry/v2/models/_create_temporary_object_set_request_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._create_temporary_object_set_request_v2_dict import ( - CreateTemporaryObjectSetRequestV2Dict, -) # NOQA -from foundry.v2.models._object_set import ObjectSet - - -class CreateTemporaryObjectSetRequestV2(BaseModel): - """CreateTemporaryObjectSetRequestV2""" - - object_set: ObjectSet = Field(alias="objectSet") - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateTemporaryObjectSetRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - CreateTemporaryObjectSetRequestV2Dict, - self.model_dump(by_alias=True, exclude_unset=True), - ) diff --git a/foundry/v2/models/_create_temporary_object_set_request_v2_dict.py b/foundry/v2/models/_create_temporary_object_set_request_v2_dict.py deleted file mode 100644 index e3b901c9..00000000 --- a/foundry/v2/models/_create_temporary_object_set_request_v2_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._object_set_dict import ObjectSetDict - - -class CreateTemporaryObjectSetRequestV2Dict(TypedDict): - """CreateTemporaryObjectSetRequestV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict diff --git a/foundry/v2/models/_create_temporary_object_set_response_v2.py b/foundry/v2/models/_create_temporary_object_set_response_v2.py deleted file mode 100644 index 70a171a4..00000000 --- a/foundry/v2/models/_create_temporary_object_set_response_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._create_temporary_object_set_response_v2_dict import ( - CreateTemporaryObjectSetResponseV2Dict, -) # NOQA -from foundry.v2.models._object_set_rid import ObjectSetRid - - -class CreateTemporaryObjectSetResponseV2(BaseModel): - """CreateTemporaryObjectSetResponseV2""" - - object_set_rid: ObjectSetRid = Field(alias="objectSetRid") - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateTemporaryObjectSetResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - CreateTemporaryObjectSetResponseV2Dict, - self.model_dump(by_alias=True, exclude_unset=True), - ) diff --git a/foundry/v2/models/_create_temporary_object_set_response_v2_dict.py b/foundry/v2/models/_create_temporary_object_set_response_v2_dict.py deleted file mode 100644 index 08092553..00000000 --- a/foundry/v2/models/_create_temporary_object_set_response_v2_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._object_set_rid import ObjectSetRid - - -class CreateTemporaryObjectSetResponseV2Dict(TypedDict): - """CreateTemporaryObjectSetResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSetRid: ObjectSetRid diff --git a/foundry/v2/models/_create_transaction_request.py b/foundry/v2/models/_create_transaction_request.py deleted file mode 100644 index e85d9a25..00000000 --- a/foundry/v2/models/_create_transaction_request.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._create_transaction_request_dict import CreateTransactionRequestDict # NOQA -from foundry.v2.models._transaction_type import TransactionType - - -class CreateTransactionRequest(BaseModel): - """CreateTransactionRequest""" - - transaction_type: TransactionType = Field(alias="transactionType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> CreateTransactionRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - CreateTransactionRequestDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_create_transaction_request_dict.py b/foundry/v2/models/_create_transaction_request_dict.py deleted file mode 100644 index 14b37ab1..00000000 --- a/foundry/v2/models/_create_transaction_request_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._transaction_type import TransactionType - - -class CreateTransactionRequestDict(TypedDict): - """CreateTransactionRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - transactionType: TransactionType diff --git a/foundry/v2/models/_custom_type_id.py b/foundry/v2/models/_custom_type_id.py deleted file mode 100644 index 35e38b08..00000000 --- a/foundry/v2/models/_custom_type_id.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -CustomTypeId = StrictStr -"""A UUID representing a custom type in a given Function.""" diff --git a/foundry/v2/models/_dataset.py b/foundry/v2/models/_dataset.py deleted file mode 100644 index 1a73bd58..00000000 --- a/foundry/v2/models/_dataset.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._dataset_dict import DatasetDict -from foundry.v2.models._dataset_name import DatasetName -from foundry.v2.models._dataset_rid import DatasetRid -from foundry.v2.models._folder_rid import FolderRid - - -class Dataset(BaseModel): - """Dataset""" - - rid: DatasetRid - - name: DatasetName - - parent_folder_rid: FolderRid = Field(alias="parentFolderRid") - - model_config = {"extra": "allow"} - - def to_dict(self) -> DatasetDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DatasetDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_dataset_dict.py b/foundry/v2/models/_dataset_dict.py deleted file mode 100644 index 88164e86..00000000 --- a/foundry/v2/models/_dataset_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._dataset_name import DatasetName -from foundry.v2.models._dataset_rid import DatasetRid -from foundry.v2.models._folder_rid import FolderRid - - -class DatasetDict(TypedDict): - """Dataset""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: DatasetRid - - name: DatasetName - - parentFolderRid: FolderRid diff --git a/foundry/v2/models/_date_type.py b/foundry/v2/models/_date_type.py deleted file mode 100644 index b604a490..00000000 --- a/foundry/v2/models/_date_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._date_type_dict import DateTypeDict - - -class DateType(BaseModel): - """DateType""" - - type: Literal["date"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> DateTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DateTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_decimal_type.py b/foundry/v2/models/_decimal_type.py deleted file mode 100644 index 0ef4e194..00000000 --- a/foundry/v2/models/_decimal_type.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictInt - -from foundry.v2.models._decimal_type_dict import DecimalTypeDict - - -class DecimalType(BaseModel): - """DecimalType""" - - precision: Optional[StrictInt] = None - - scale: Optional[StrictInt] = None - - type: Literal["decimal"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> DecimalTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DecimalTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_delete_link_rule.py b/foundry/v2/models/_delete_link_rule.py deleted file mode 100644 index 23ad3e07..00000000 --- a/foundry/v2/models/_delete_link_rule.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._delete_link_rule_dict import DeleteLinkRuleDict -from foundry.v2.models._link_type_api_name import LinkTypeApiName -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class DeleteLinkRule(BaseModel): - """DeleteLinkRule""" - - link_type_api_name_ato_b: LinkTypeApiName = Field(alias="linkTypeApiNameAtoB") - - link_type_api_name_bto_a: LinkTypeApiName = Field(alias="linkTypeApiNameBtoA") - - a_side_object_type_api_name: ObjectTypeApiName = Field(alias="aSideObjectTypeApiName") - - b_side_object_type_api_name: ObjectTypeApiName = Field(alias="bSideObjectTypeApiName") - - type: Literal["deleteLink"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> DeleteLinkRuleDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DeleteLinkRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_delete_link_rule_dict.py b/foundry/v2/models/_delete_link_rule_dict.py deleted file mode 100644 index 813c7d73..00000000 --- a/foundry/v2/models/_delete_link_rule_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._link_type_api_name import LinkTypeApiName -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class DeleteLinkRuleDict(TypedDict): - """DeleteLinkRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - linkTypeApiNameAtoB: LinkTypeApiName - - linkTypeApiNameBtoA: LinkTypeApiName - - aSideObjectTypeApiName: ObjectTypeApiName - - bSideObjectTypeApiName: ObjectTypeApiName - - type: Literal["deleteLink"] diff --git a/foundry/v2/models/_delete_object_rule.py b/foundry/v2/models/_delete_object_rule.py deleted file mode 100644 index cc2963f9..00000000 --- a/foundry/v2/models/_delete_object_rule.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._delete_object_rule_dict import DeleteObjectRuleDict -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class DeleteObjectRule(BaseModel): - """DeleteObjectRule""" - - object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") - - type: Literal["deleteObject"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> DeleteObjectRuleDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DeleteObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_delete_object_rule_dict.py b/foundry/v2/models/_delete_object_rule_dict.py deleted file mode 100644 index e7e07645..00000000 --- a/foundry/v2/models/_delete_object_rule_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class DeleteObjectRuleDict(TypedDict): - """DeleteObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectTypeApiName: ObjectTypeApiName - - type: Literal["deleteObject"] diff --git a/foundry/v2/models/_deploy_website_request.py b/foundry/v2/models/_deploy_website_request.py deleted file mode 100644 index da47341c..00000000 --- a/foundry/v2/models/_deploy_website_request.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._deploy_website_request_dict import DeployWebsiteRequestDict -from foundry.v2.models._version_version import VersionVersion - - -class DeployWebsiteRequest(BaseModel): - """DeployWebsiteRequest""" - - version: VersionVersion - - model_config = {"extra": "allow"} - - def to_dict(self) -> DeployWebsiteRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DeployWebsiteRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_deploy_website_request_dict.py b/foundry/v2/models/_deploy_website_request_dict.py deleted file mode 100644 index d6cd2480..00000000 --- a/foundry/v2/models/_deploy_website_request_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._version_version import VersionVersion - - -class DeployWebsiteRequestDict(TypedDict): - """DeployWebsiteRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - version: VersionVersion diff --git a/foundry/v2/models/_distance.py b/foundry/v2/models/_distance.py deleted file mode 100644 index 0601a1b0..00000000 --- a/foundry/v2/models/_distance.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictFloat - -from foundry.v2.models._distance_dict import DistanceDict -from foundry.v2.models._distance_unit import DistanceUnit - - -class Distance(BaseModel): - """A measurement of distance.""" - - value: StrictFloat - - unit: DistanceUnit - - model_config = {"extra": "allow"} - - def to_dict(self) -> DistanceDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DistanceDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_distance_dict.py b/foundry/v2/models/_distance_dict.py deleted file mode 100644 index 53ef60be..00000000 --- a/foundry/v2/models/_distance_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictFloat -from typing_extensions import TypedDict - -from foundry.v2.models._distance_unit import DistanceUnit - - -class DistanceDict(TypedDict): - """A measurement of distance.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: StrictFloat - - unit: DistanceUnit diff --git a/foundry/v2/models/_distance_unit.py b/foundry/v2/models/_distance_unit.py deleted file mode 100644 index c58ff30b..00000000 --- a/foundry/v2/models/_distance_unit.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -DistanceUnit = Literal[ - "MILLIMETERS", - "CENTIMETERS", - "METERS", - "KILOMETERS", - "INCHES", - "FEET", - "YARDS", - "MILES", - "NAUTICAL_MILES", -] -"""DistanceUnit""" diff --git a/foundry/v2/models/_does_not_intersect_bounding_box_query.py b/foundry/v2/models/_does_not_intersect_bounding_box_query.py deleted file mode 100644 index f0b39312..00000000 --- a/foundry/v2/models/_does_not_intersect_bounding_box_query.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._bounding_box_value import BoundingBoxValue -from foundry.v2.models._does_not_intersect_bounding_box_query_dict import ( - DoesNotIntersectBoundingBoxQueryDict, -) # NOQA -from foundry.v2.models._property_api_name import PropertyApiName - - -class DoesNotIntersectBoundingBoxQuery(BaseModel): - """Returns objects where the specified field does not intersect the bounding box provided.""" - - field: PropertyApiName - - value: BoundingBoxValue - - type: Literal["doesNotIntersectBoundingBox"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> DoesNotIntersectBoundingBoxQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - DoesNotIntersectBoundingBoxQueryDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_does_not_intersect_bounding_box_query_dict.py b/foundry/v2/models/_does_not_intersect_bounding_box_query_dict.py deleted file mode 100644 index 264ee567..00000000 --- a/foundry/v2/models/_does_not_intersect_bounding_box_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._bounding_box_value_dict import BoundingBoxValueDict -from foundry.v2.models._property_api_name import PropertyApiName - - -class DoesNotIntersectBoundingBoxQueryDict(TypedDict): - """Returns objects where the specified field does not intersect the bounding box provided.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: BoundingBoxValueDict - - type: Literal["doesNotIntersectBoundingBox"] diff --git a/foundry/v2/models/_does_not_intersect_polygon_query.py b/foundry/v2/models/_does_not_intersect_polygon_query.py deleted file mode 100644 index a11dae93..00000000 --- a/foundry/v2/models/_does_not_intersect_polygon_query.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._does_not_intersect_polygon_query_dict import ( - DoesNotIntersectPolygonQueryDict, -) # NOQA -from foundry.v2.models._polygon_value import PolygonValue -from foundry.v2.models._property_api_name import PropertyApiName - - -class DoesNotIntersectPolygonQuery(BaseModel): - """Returns objects where the specified field does not intersect the polygon provided.""" - - field: PropertyApiName - - value: PolygonValue - - type: Literal["doesNotIntersectPolygon"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> DoesNotIntersectPolygonQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - DoesNotIntersectPolygonQueryDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_does_not_intersect_polygon_query_dict.py b/foundry/v2/models/_does_not_intersect_polygon_query_dict.py deleted file mode 100644 index cb7421ca..00000000 --- a/foundry/v2/models/_does_not_intersect_polygon_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._polygon_value_dict import PolygonValueDict -from foundry.v2.models._property_api_name import PropertyApiName - - -class DoesNotIntersectPolygonQueryDict(TypedDict): - """Returns objects where the specified field does not intersect the polygon provided.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PolygonValueDict - - type: Literal["doesNotIntersectPolygon"] diff --git a/foundry/v2/models/_double_type.py b/foundry/v2/models/_double_type.py deleted file mode 100644 index 9c1a36f6..00000000 --- a/foundry/v2/models/_double_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._double_type_dict import DoubleTypeDict - - -class DoubleType(BaseModel): - """DoubleType""" - - type: Literal["double"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> DoubleTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(DoubleTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_equals_query.py b/foundry/v2/models/_equals_query.py deleted file mode 100644 index 4945c8b9..00000000 --- a/foundry/v2/models/_equals_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._equals_query_dict import EqualsQueryDict -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._property_value import PropertyValue - - -class EqualsQuery(BaseModel): - """Returns objects where the specified field is equal to a value.""" - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["eq"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> EqualsQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(EqualsQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_equals_query_dict.py b/foundry/v2/models/_equals_query_dict.py deleted file mode 100644 index 5660aa58..00000000 --- a/foundry/v2/models/_equals_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._property_value import PropertyValue - - -class EqualsQueryDict(TypedDict): - """Returns objects where the specified field is equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["eq"] diff --git a/foundry/v2/models/_equals_query_v2.py b/foundry/v2/models/_equals_query_v2.py deleted file mode 100644 index efa27b81..00000000 --- a/foundry/v2/models/_equals_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._equals_query_v2_dict import EqualsQueryV2Dict -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - - -class EqualsQueryV2(BaseModel): - """Returns objects where the specified field is equal to a value.""" - - field: PropertyApiName - - value: PropertyValue - - type: Literal["eq"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> EqualsQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(EqualsQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_equals_query_v2_dict.py b/foundry/v2/models/_equals_query_v2_dict.py deleted file mode 100644 index 1156cd40..00000000 --- a/foundry/v2/models/_equals_query_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - - -class EqualsQueryV2Dict(TypedDict): - """Returns objects where the specified field is equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PropertyValue - - type: Literal["eq"] diff --git a/foundry/v2/models/_error.py b/foundry/v2/models/_error.py deleted file mode 100644 index 157efbc6..00000000 --- a/foundry/v2/models/_error.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._arg import Arg -from foundry.v2.models._error_dict import ErrorDict -from foundry.v2.models._error_name import ErrorName - - -class Error(BaseModel): - """Error""" - - error: ErrorName - - args: List[Arg] - - type: Literal["error"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ErrorDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ErrorDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_error_dict.py b/foundry/v2/models/_error_dict.py deleted file mode 100644 index 00ae3e11..00000000 --- a/foundry/v2/models/_error_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._arg_dict import ArgDict -from foundry.v2.models._error_name import ErrorName - - -class ErrorDict(TypedDict): - """Error""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - error: ErrorName - - args: List[ArgDict] - - type: Literal["error"] diff --git a/foundry/v2/models/_error_name.py b/foundry/v2/models/_error_name.py deleted file mode 100644 index 4bb8b749..00000000 --- a/foundry/v2/models/_error_name.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -ErrorName = StrictStr -"""ErrorName""" diff --git a/foundry/v2/models/_exact_distinct_aggregation_v2.py b/foundry/v2/models/_exact_distinct_aggregation_v2.py deleted file mode 100644 index 0148fe0c..00000000 --- a/foundry/v2/models/_exact_distinct_aggregation_v2.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._exact_distinct_aggregation_v2_dict import ( - ExactDistinctAggregationV2Dict, -) # NOQA -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._property_api_name import PropertyApiName - - -class ExactDistinctAggregationV2(BaseModel): - """Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.""" - - field: PropertyApiName - - name: Optional[AggregationMetricName] = None - - direction: Optional[OrderByDirection] = None - - type: Literal["exactDistinct"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ExactDistinctAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ExactDistinctAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_exact_distinct_aggregation_v2_dict.py b/foundry/v2/models/_exact_distinct_aggregation_v2_dict.py deleted file mode 100644 index f559f5fc..00000000 --- a/foundry/v2/models/_exact_distinct_aggregation_v2_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._property_api_name import PropertyApiName - - -class ExactDistinctAggregationV2Dict(TypedDict): - """Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - name: NotRequired[AggregationMetricName] - - direction: NotRequired[OrderByDirection] - - type: Literal["exactDistinct"] diff --git a/foundry/v2/models/_execute_query_request.py b/foundry/v2/models/_execute_query_request.py deleted file mode 100644 index 032e1cad..00000000 --- a/foundry/v2/models/_execute_query_request.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._execute_query_request_dict import ExecuteQueryRequestDict -from foundry.v2.models._parameter_id import ParameterId - - -class ExecuteQueryRequest(BaseModel): - """ExecuteQueryRequest""" - - parameters: Dict[ParameterId, Optional[DataValue]] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ExecuteQueryRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ExecuteQueryRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_execute_query_request_dict.py b/foundry/v2/models/_execute_query_request_dict.py deleted file mode 100644 index 18d97a36..00000000 --- a/foundry/v2/models/_execute_query_request_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import TypedDict - -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._parameter_id import ParameterId - - -class ExecuteQueryRequestDict(TypedDict): - """ExecuteQueryRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v2/models/_execute_query_response.py b/foundry/v2/models/_execute_query_response.py deleted file mode 100644 index 27cfcab3..00000000 --- a/foundry/v2/models/_execute_query_response.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._execute_query_response_dict import ExecuteQueryResponseDict - - -class ExecuteQueryResponse(BaseModel): - """ExecuteQueryResponse""" - - value: DataValue - - model_config = {"extra": "allow"} - - def to_dict(self) -> ExecuteQueryResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ExecuteQueryResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_execute_query_response_dict.py b/foundry/v2/models/_execute_query_response_dict.py deleted file mode 100644 index e4776c7d..00000000 --- a/foundry/v2/models/_execute_query_response_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._data_value import DataValue - - -class ExecuteQueryResponseDict(TypedDict): - """ExecuteQueryResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: DataValue diff --git a/foundry/v2/models/_feature.py b/foundry/v2/models/_feature.py deleted file mode 100644 index 231c3d01..00000000 --- a/foundry/v2/models/_feature.py +++ /dev/null @@ -1,60 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Dict -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._feature_dict import FeatureDict -from foundry.v2.models._feature_property_key import FeaturePropertyKey -from foundry.v2.models._geometry import Geometry - - -class Feature(BaseModel): - """GeoJSon 'Feature' object""" - - geometry: Optional[Geometry] = None - - properties: Dict[FeaturePropertyKey, Any] - """ - A `Feature` object has a member with the name "properties". The - value of the properties member is an object (any JSON object or a - JSON null value). - """ - - id: Optional[Any] = None - """ - If a `Feature` has a commonly used identifier, that identifier - SHOULD be included as a member of the Feature object with the name - "id", and the value of this member is either a JSON string or - number. - """ - - bbox: Optional[BBox] = None - - type: Literal["Feature"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> FeatureDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(FeatureDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_feature_collection.py b/foundry/v2/models/_feature_collection.py deleted file mode 100644 index 50bf29f3..00000000 --- a/foundry/v2/models/_feature_collection.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._feature_collection_dict import FeatureCollectionDict -from foundry.v2.models._feature_collection_types import FeatureCollectionTypes - - -class FeatureCollection(BaseModel): - """GeoJSon 'FeatureCollection' object""" - - features: List[FeatureCollectionTypes] - - bbox: Optional[BBox] = None - - type: Literal["FeatureCollection"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> FeatureCollectionDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(FeatureCollectionDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_feature_collection_dict.py b/foundry/v2/models/_feature_collection_dict.py deleted file mode 100644 index db776ea6..00000000 --- a/foundry/v2/models/_feature_collection_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._feature_collection_types_dict import FeatureCollectionTypesDict - - -class FeatureCollectionDict(TypedDict): - """GeoJSon 'FeatureCollection' object""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - features: List[FeatureCollectionTypesDict] - - bbox: NotRequired[BBox] - - type: Literal["FeatureCollection"] diff --git a/foundry/v2/models/_feature_collection_types.py b/foundry/v2/models/_feature_collection_types.py deleted file mode 100644 index aeb56534..00000000 --- a/foundry/v2/models/_feature_collection_types.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v2.models._feature import Feature - -FeatureCollectionTypes = Feature -"""FeatureCollectionTypes""" diff --git a/foundry/v2/models/_feature_collection_types_dict.py b/foundry/v2/models/_feature_collection_types_dict.py deleted file mode 100644 index 69283031..00000000 --- a/foundry/v2/models/_feature_collection_types_dict.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v2.models._feature_dict import FeatureDict - -FeatureCollectionTypesDict = FeatureDict -"""FeatureCollectionTypes""" diff --git a/foundry/v2/models/_feature_dict.py b/foundry/v2/models/_feature_dict.py deleted file mode 100644 index d1824faa..00000000 --- a/foundry/v2/models/_feature_dict.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Dict -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._feature_property_key import FeaturePropertyKey -from foundry.v2.models._geometry_dict import GeometryDict - - -class FeatureDict(TypedDict): - """GeoJSon 'Feature' object""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - geometry: NotRequired[GeometryDict] - - properties: Dict[FeaturePropertyKey, Any] - """ - A `Feature` object has a member with the name "properties". The - value of the properties member is an object (any JSON object or a - JSON null value). - """ - - id: NotRequired[Any] - """ - If a `Feature` has a commonly used identifier, that identifier - SHOULD be included as a member of the Feature object with the name - "id", and the value of this member is either a JSON string or - number. - """ - - bbox: NotRequired[BBox] - - type: Literal["Feature"] diff --git a/foundry/v2/models/_feature_property_key.py b/foundry/v2/models/_feature_property_key.py deleted file mode 100644 index f80d3df3..00000000 --- a/foundry/v2/models/_feature_property_key.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -FeaturePropertyKey = StrictStr -"""FeaturePropertyKey""" diff --git a/foundry/v2/models/_field_name_v1.py b/foundry/v2/models/_field_name_v1.py deleted file mode 100644 index bf8ee27d..00000000 --- a/foundry/v2/models/_field_name_v1.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -FieldNameV1 = StrictStr -"""A reference to an Ontology object property with the form `properties.{propertyApiName}`.""" diff --git a/foundry/v2/models/_file.py b/foundry/v2/models/_file.py deleted file mode 100644 index 117b1d09..00000000 --- a/foundry/v2/models/_file.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._file_dict import FileDict -from foundry.v2.models._file_path import FilePath -from foundry.v2.models._file_updated_time import FileUpdatedTime -from foundry.v2.models._transaction_rid import TransactionRid - - -class File(BaseModel): - """File""" - - path: FilePath - - transaction_rid: TransactionRid = Field(alias="transactionRid") - - size_bytes: Optional[StrictStr] = Field(alias="sizeBytes", default=None) - - updated_time: FileUpdatedTime = Field(alias="updatedTime") - - model_config = {"extra": "allow"} - - def to_dict(self) -> FileDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(FileDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_file_dict.py b/foundry/v2/models/_file_dict.py deleted file mode 100644 index 53cb1605..00000000 --- a/foundry/v2/models/_file_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._file_path import FilePath -from foundry.v2.models._file_updated_time import FileUpdatedTime -from foundry.v2.models._transaction_rid import TransactionRid - - -class FileDict(TypedDict): - """File""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - path: FilePath - - transactionRid: TransactionRid - - sizeBytes: NotRequired[StrictStr] - - updatedTime: FileUpdatedTime diff --git a/foundry/v2/models/_filename.py b/foundry/v2/models/_filename.py deleted file mode 100644 index cb6ee046..00000000 --- a/foundry/v2/models/_filename.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -Filename = StrictStr -"""The name of a File within Foundry. Examples: `my-file.txt`, `my-file.jpg`, `dataframe.snappy.parquet`.""" diff --git a/foundry/v2/models/_filesystem_resource.py b/foundry/v2/models/_filesystem_resource.py deleted file mode 100644 index 6d72f9f5..00000000 --- a/foundry/v2/models/_filesystem_resource.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._filesystem_resource_dict import FilesystemResourceDict - - -class FilesystemResource(BaseModel): - """FilesystemResource""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> FilesystemResourceDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(FilesystemResourceDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_filesystem_resource_dict.py b/foundry/v2/models/_filesystem_resource_dict.py deleted file mode 100644 index 44208d20..00000000 --- a/foundry/v2/models/_filesystem_resource_dict.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - - -class FilesystemResourceDict(TypedDict): - """FilesystemResource""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/models/_filter_value.py b/foundry/v2/models/_filter_value.py deleted file mode 100644 index 69c6cae4..00000000 --- a/foundry/v2/models/_filter_value.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -FilterValue = StrictStr -""" -Represents the value of a property filter. For instance, false is the FilterValue in -`properties.{propertyApiName}.isNull=false`. -""" diff --git a/foundry/v2/models/_float_type.py b/foundry/v2/models/_float_type.py deleted file mode 100644 index 65cf225d..00000000 --- a/foundry/v2/models/_float_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._float_type_dict import FloatTypeDict - - -class FloatType(BaseModel): - """FloatType""" - - type: Literal["float"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> FloatTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(FloatTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_folder.py b/foundry/v2/models/_folder.py deleted file mode 100644 index 5083c1b6..00000000 --- a/foundry/v2/models/_folder.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._folder_dict import FolderDict -from foundry.v2.models._folder_rid import FolderRid - - -class Folder(BaseModel): - """Folder""" - - rid: FolderRid - - model_config = {"extra": "allow"} - - def to_dict(self) -> FolderDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(FolderDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_folder_dict.py b/foundry/v2/models/_folder_dict.py deleted file mode 100644 index c0900ea6..00000000 --- a/foundry/v2/models/_folder_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._folder_rid import FolderRid - - -class FolderDict(TypedDict): - """Folder""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: FolderRid diff --git a/foundry/v2/models/_fuzzy.py b/foundry/v2/models/_fuzzy.py deleted file mode 100644 index 4ccc16ff..00000000 --- a/foundry/v2/models/_fuzzy.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictBool - -Fuzzy = StrictBool -"""Setting fuzzy to `true` allows approximate matching in search queries that support it.""" diff --git a/foundry/v2/models/_fuzzy_v2.py b/foundry/v2/models/_fuzzy_v2.py deleted file mode 100644 index f68b3419..00000000 --- a/foundry/v2/models/_fuzzy_v2.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictBool - -FuzzyV2 = StrictBool -"""Setting fuzzy to `true` allows approximate matching in search queries that support it.""" diff --git a/foundry/v2/models/_geo_json_object.py b/foundry/v2/models/_geo_json_object.py deleted file mode 100644 index 76485a77..00000000 --- a/foundry/v2/models/_geo_json_object.py +++ /dev/null @@ -1,60 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._feature import Feature -from foundry.v2.models._feature_collection import FeatureCollection -from foundry.v2.models._geo_point import GeoPoint -from foundry.v2.models._geometry import GeometryCollection -from foundry.v2.models._line_string import LineString -from foundry.v2.models._multi_line_string import MultiLineString -from foundry.v2.models._multi_point import MultiPoint -from foundry.v2.models._multi_polygon import MultiPolygon -from foundry.v2.models._polygon import Polygon - -GeoJsonObject = Annotated[ - Union[ - Feature, - FeatureCollection, - GeoPoint, - MultiPoint, - LineString, - MultiLineString, - Polygon, - MultiPolygon, - GeometryCollection, - ], - Field(discriminator="type"), -] -""" -GeoJSon object - -The coordinate reference system for all GeoJSON coordinates is a -geographic coordinate reference system, using the World Geodetic System -1984 (WGS 84) datum, with longitude and latitude units of decimal -degrees. -This is equivalent to the coordinate reference system identified by the -Open Geospatial Consortium (OGC) URN -An OPTIONAL third-position element SHALL be the height in meters above -or below the WGS 84 reference ellipsoid. -In the absence of elevation values, applications sensitive to height or -depth SHOULD interpret positions as being at local ground or sea level. -""" diff --git a/foundry/v2/models/_geo_json_object_dict.py b/foundry/v2/models/_geo_json_object_dict.py deleted file mode 100644 index 0bdbbbee..00000000 --- a/foundry/v2/models/_geo_json_object_dict.py +++ /dev/null @@ -1,60 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._feature_collection_dict import FeatureCollectionDict -from foundry.v2.models._feature_dict import FeatureDict -from foundry.v2.models._geo_point_dict import GeoPointDict -from foundry.v2.models._geometry_dict import GeometryCollectionDict -from foundry.v2.models._line_string_dict import LineStringDict -from foundry.v2.models._multi_line_string_dict import MultiLineStringDict -from foundry.v2.models._multi_point_dict import MultiPointDict -from foundry.v2.models._multi_polygon_dict import MultiPolygonDict -from foundry.v2.models._polygon_dict import PolygonDict - -GeoJsonObjectDict = Annotated[ - Union[ - FeatureDict, - FeatureCollectionDict, - GeoPointDict, - MultiPointDict, - LineStringDict, - MultiLineStringDict, - PolygonDict, - MultiPolygonDict, - GeometryCollectionDict, - ], - Field(discriminator="type"), -] -""" -GeoJSon object - -The coordinate reference system for all GeoJSON coordinates is a -geographic coordinate reference system, using the World Geodetic System -1984 (WGS 84) datum, with longitude and latitude units of decimal -degrees. -This is equivalent to the coordinate reference system identified by the -Open Geospatial Consortium (OGC) URN -An OPTIONAL third-position element SHALL be the height in meters above -or below the WGS 84 reference ellipsoid. -In the absence of elevation values, applications sensitive to height or -depth SHOULD interpret positions as being at local ground or sea level. -""" diff --git a/foundry/v2/models/_geo_point.py b/foundry/v2/models/_geo_point.py deleted file mode 100644 index 01f14b65..00000000 --- a/foundry/v2/models/_geo_point.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._geo_point_dict import GeoPointDict -from foundry.v2.models._position import Position - - -class GeoPoint(BaseModel): - """GeoPoint""" - - coordinates: Position - - bbox: Optional[BBox] = None - - type: Literal["Point"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GeoPointDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GeoPointDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_geo_point_dict.py b/foundry/v2/models/_geo_point_dict.py deleted file mode 100644 index 68f478bd..00000000 --- a/foundry/v2/models/_geo_point_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._position import Position - - -class GeoPointDict(TypedDict): - """GeoPoint""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: Position - - bbox: NotRequired[BBox] - - type: Literal["Point"] diff --git a/foundry/v2/models/_geo_point_type.py b/foundry/v2/models/_geo_point_type.py deleted file mode 100644 index 97359e00..00000000 --- a/foundry/v2/models/_geo_point_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._geo_point_type_dict import GeoPointTypeDict - - -class GeoPointType(BaseModel): - """GeoPointType""" - - type: Literal["geopoint"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GeoPointTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GeoPointTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_geo_point_type_dict.py b/foundry/v2/models/_geo_point_type_dict.py deleted file mode 100644 index b3a320f3..00000000 --- a/foundry/v2/models/_geo_point_type_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - - -class GeoPointTypeDict(TypedDict): - """GeoPointType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: Literal["geopoint"] diff --git a/foundry/v2/models/_geo_shape_type.py b/foundry/v2/models/_geo_shape_type.py deleted file mode 100644 index b3c78e6b..00000000 --- a/foundry/v2/models/_geo_shape_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._geo_shape_type_dict import GeoShapeTypeDict - - -class GeoShapeType(BaseModel): - """GeoShapeType""" - - type: Literal["geoshape"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GeoShapeTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GeoShapeTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_geo_shape_type_dict.py b/foundry/v2/models/_geo_shape_type_dict.py deleted file mode 100644 index 31e25e28..00000000 --- a/foundry/v2/models/_geo_shape_type_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - - -class GeoShapeTypeDict(TypedDict): - """GeoShapeType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: Literal["geoshape"] diff --git a/foundry/v2/models/_geometry.py b/foundry/v2/models/_geometry.py deleted file mode 100644 index c8e0c073..00000000 --- a/foundry/v2/models/_geometry.py +++ /dev/null @@ -1,67 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Optional -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._geo_point import GeoPoint -from foundry.v2.models._geometry_dict import GeometryCollectionDict -from foundry.v2.models._line_string import LineString -from foundry.v2.models._multi_line_string import MultiLineString -from foundry.v2.models._multi_point import MultiPoint -from foundry.v2.models._multi_polygon import MultiPolygon -from foundry.v2.models._polygon import Polygon - - -class GeometryCollection(BaseModel): - """ - GeoJSon geometry collection - - GeometryCollections composed of a single part or a number of parts of a - single type SHOULD be avoided when that single part or a single object - of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could - be used instead. - """ - - geometries: List[Geometry] - - bbox: Optional[BBox] = None - - type: Literal["GeometryCollection"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GeometryCollectionDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GeometryCollectionDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -Geometry = Annotated[ - Union[ - GeoPoint, MultiPoint, LineString, MultiLineString, Polygon, MultiPolygon, GeometryCollection - ], - Field(discriminator="type"), -] -"""Abstract type for all GeoJSon object except Feature and FeatureCollection""" diff --git a/foundry/v2/models/_geometry_dict.py b/foundry/v2/models/_geometry_dict.py deleted file mode 100644 index 23544ed3..00000000 --- a/foundry/v2/models/_geometry_dict.py +++ /dev/null @@ -1,67 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._geo_point_dict import GeoPointDict -from foundry.v2.models._line_string_dict import LineStringDict -from foundry.v2.models._multi_line_string_dict import MultiLineStringDict -from foundry.v2.models._multi_point_dict import MultiPointDict -from foundry.v2.models._multi_polygon_dict import MultiPolygonDict -from foundry.v2.models._polygon_dict import PolygonDict - - -class GeometryCollectionDict(TypedDict): - """ - GeoJSon geometry collection - - GeometryCollections composed of a single part or a number of parts of a - single type SHOULD be avoided when that single part or a single object - of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could - be used instead. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - geometries: List[GeometryDict] - - bbox: NotRequired[BBox] - - type: Literal["GeometryCollection"] - - -GeometryDict = Annotated[ - Union[ - GeoPointDict, - MultiPointDict, - LineStringDict, - MultiLineStringDict, - PolygonDict, - MultiPolygonDict, - GeometryCollectionDict, - ], - Field(discriminator="type"), -] -"""Abstract type for all GeoJSon object except Feature and FeatureCollection""" diff --git a/foundry/v2/models/_geotime_series_value.py b/foundry/v2/models/_geotime_series_value.py deleted file mode 100644 index 44a329aa..00000000 --- a/foundry/v2/models/_geotime_series_value.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._geotime_series_value_dict import GeotimeSeriesValueDict -from foundry.v2.models._position import Position - - -class GeotimeSeriesValue(BaseModel): - """The underlying data values pointed to by a GeotimeSeriesReference.""" - - position: Position - - timestamp: datetime - - type: Literal["geotimeSeriesValue"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GeotimeSeriesValueDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GeotimeSeriesValueDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_geotime_series_value_dict.py b/foundry/v2/models/_geotime_series_value_dict.py deleted file mode 100644 index 2b39c5e9..00000000 --- a/foundry/v2/models/_geotime_series_value_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._position import Position - - -class GeotimeSeriesValueDict(TypedDict): - """The underlying data values pointed to by a GeotimeSeriesReference.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - position: Position - - timestamp: datetime - - type: Literal["geotimeSeriesValue"] diff --git a/foundry/v2/models/_get_groups_batch_request_element.py b/foundry/v2/models/_get_groups_batch_request_element.py deleted file mode 100644 index dc86ec15..00000000 --- a/foundry/v2/models/_get_groups_batch_request_element.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._get_groups_batch_request_element_dict import ( - GetGroupsBatchRequestElementDict, -) # NOQA -from foundry.v2.models._principal_id import PrincipalId - - -class GetGroupsBatchRequestElement(BaseModel): - """GetGroupsBatchRequestElement""" - - group_id: PrincipalId = Field(alias="groupId") - - model_config = {"extra": "allow"} - - def to_dict(self) -> GetGroupsBatchRequestElementDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - GetGroupsBatchRequestElementDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_get_users_batch_request_element.py b/foundry/v2/models/_get_users_batch_request_element.py deleted file mode 100644 index c091a57e..00000000 --- a/foundry/v2/models/_get_users_batch_request_element.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._get_users_batch_request_element_dict import ( - GetUsersBatchRequestElementDict, -) # NOQA -from foundry.v2.models._principal_id import PrincipalId - - -class GetUsersBatchRequestElement(BaseModel): - """GetUsersBatchRequestElement""" - - user_id: PrincipalId = Field(alias="userId") - - model_config = {"extra": "allow"} - - def to_dict(self) -> GetUsersBatchRequestElementDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - GetUsersBatchRequestElementDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_group_member_constraint.py b/foundry/v2/models/_group_member_constraint.py deleted file mode 100644 index cc8ff85b..00000000 --- a/foundry/v2/models/_group_member_constraint.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._group_member_constraint_dict import GroupMemberConstraintDict - - -class GroupMemberConstraint(BaseModel): - """The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.""" - - type: Literal["groupMember"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GroupMemberConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GroupMemberConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_group_search_filter.py b/foundry/v2/models/_group_search_filter.py deleted file mode 100644 index 3c880f29..00000000 --- a/foundry/v2/models/_group_search_filter.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._group_search_filter_dict import GroupSearchFilterDict -from foundry.v2.models._principal_filter_type import PrincipalFilterType - - -class GroupSearchFilter(BaseModel): - """GroupSearchFilter""" - - type: PrincipalFilterType - - value: StrictStr - - model_config = {"extra": "allow"} - - def to_dict(self) -> GroupSearchFilterDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GroupSearchFilterDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_gt_query.py b/foundry/v2/models/_gt_query.py deleted file mode 100644 index 08895d28..00000000 --- a/foundry/v2/models/_gt_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._gt_query_dict import GtQueryDict -from foundry.v2.models._property_value import PropertyValue - - -class GtQuery(BaseModel): - """Returns objects where the specified field is greater than a value.""" - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["gt"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GtQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GtQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_gt_query_dict.py b/foundry/v2/models/_gt_query_dict.py deleted file mode 100644 index 99863fb2..00000000 --- a/foundry/v2/models/_gt_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._property_value import PropertyValue - - -class GtQueryDict(TypedDict): - """Returns objects where the specified field is greater than a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["gt"] diff --git a/foundry/v2/models/_gt_query_v2.py b/foundry/v2/models/_gt_query_v2.py deleted file mode 100644 index 9d00224b..00000000 --- a/foundry/v2/models/_gt_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._gt_query_v2_dict import GtQueryV2Dict -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - - -class GtQueryV2(BaseModel): - """Returns objects where the specified field is greater than a value.""" - - field: PropertyApiName - - value: PropertyValue - - type: Literal["gt"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GtQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GtQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_gt_query_v2_dict.py b/foundry/v2/models/_gt_query_v2_dict.py deleted file mode 100644 index 64e8ec03..00000000 --- a/foundry/v2/models/_gt_query_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - - -class GtQueryV2Dict(TypedDict): - """Returns objects where the specified field is greater than a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PropertyValue - - type: Literal["gt"] diff --git a/foundry/v2/models/_gte_query.py b/foundry/v2/models/_gte_query.py deleted file mode 100644 index 81701420..00000000 --- a/foundry/v2/models/_gte_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._gte_query_dict import GteQueryDict -from foundry.v2.models._property_value import PropertyValue - - -class GteQuery(BaseModel): - """Returns objects where the specified field is greater than or equal to a value.""" - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["gte"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GteQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GteQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_gte_query_dict.py b/foundry/v2/models/_gte_query_dict.py deleted file mode 100644 index cba0d2ec..00000000 --- a/foundry/v2/models/_gte_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._property_value import PropertyValue - - -class GteQueryDict(TypedDict): - """Returns objects where the specified field is greater than or equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["gte"] diff --git a/foundry/v2/models/_gte_query_v2.py b/foundry/v2/models/_gte_query_v2.py deleted file mode 100644 index 9a71042f..00000000 --- a/foundry/v2/models/_gte_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._gte_query_v2_dict import GteQueryV2Dict -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - - -class GteQueryV2(BaseModel): - """Returns objects where the specified field is greater than or equal to a value.""" - - field: PropertyApiName - - value: PropertyValue - - type: Literal["gte"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> GteQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(GteQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_gte_query_v2_dict.py b/foundry/v2/models/_gte_query_v2_dict.py deleted file mode 100644 index 5f5c3243..00000000 --- a/foundry/v2/models/_gte_query_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - - -class GteQueryV2Dict(TypedDict): - """Returns objects where the specified field is greater than or equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PropertyValue - - type: Literal["gte"] diff --git a/foundry/v2/models/_icon.py b/foundry/v2/models/_icon.py deleted file mode 100644 index a3b88430..00000000 --- a/foundry/v2/models/_icon.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v2.models._blueprint_icon import BlueprintIcon - -Icon = BlueprintIcon -"""A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).""" diff --git a/foundry/v2/models/_icon_dict.py b/foundry/v2/models/_icon_dict.py deleted file mode 100644 index 07f13efc..00000000 --- a/foundry/v2/models/_icon_dict.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v2.models._blueprint_icon_dict import BlueprintIconDict - -IconDict = BlueprintIconDict -"""A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).""" diff --git a/foundry/v2/models/_integer_type.py b/foundry/v2/models/_integer_type.py deleted file mode 100644 index 183f08b2..00000000 --- a/foundry/v2/models/_integer_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._integer_type_dict import IntegerTypeDict - - -class IntegerType(BaseModel): - """IntegerType""" - - type: Literal["integer"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> IntegerTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(IntegerTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_interface_link_type.py b/foundry/v2/models/_interface_link_type.py deleted file mode 100644 index ca663c57..00000000 --- a/foundry/v2/models/_interface_link_type.py +++ /dev/null @@ -1,64 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool -from pydantic import StrictStr - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._interface_link_type_api_name import InterfaceLinkTypeApiName -from foundry.v2.models._interface_link_type_cardinality import InterfaceLinkTypeCardinality # NOQA -from foundry.v2.models._interface_link_type_dict import InterfaceLinkTypeDict -from foundry.v2.models._interface_link_type_linked_entity_api_name import ( - InterfaceLinkTypeLinkedEntityApiName, -) # NOQA -from foundry.v2.models._interface_link_type_rid import InterfaceLinkTypeRid - - -class InterfaceLinkType(BaseModel): - """ - A link type constraint defined at the interface level where the implementation of the links is provided - by the implementing object types. - """ - - rid: InterfaceLinkTypeRid - - api_name: InterfaceLinkTypeApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - description: Optional[StrictStr] = None - """The description of the interface link type.""" - - linked_entity_api_name: InterfaceLinkTypeLinkedEntityApiName = Field( - alias="linkedEntityApiName" - ) - - cardinality: InterfaceLinkTypeCardinality - - required: StrictBool - """Whether each implementing object type must declare at least one implementation of this link.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> InterfaceLinkTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(InterfaceLinkTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_interface_link_type_api_name.py b/foundry/v2/models/_interface_link_type_api_name.py deleted file mode 100644 index fb275caa..00000000 --- a/foundry/v2/models/_interface_link_type_api_name.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -InterfaceLinkTypeApiName = StrictStr -"""A string indicating the API name to use for the interface link.""" diff --git a/foundry/v2/models/_interface_link_type_cardinality.py b/foundry/v2/models/_interface_link_type_cardinality.py deleted file mode 100644 index a0d7bce9..00000000 --- a/foundry/v2/models/_interface_link_type_cardinality.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -InterfaceLinkTypeCardinality = Literal["ONE", "MANY"] -""" -The cardinality of the link in the given direction. Cardinality can be "ONE", meaning an object can -link to zero or one other objects, or "MANY", meaning an object can link to any number of other objects. -""" diff --git a/foundry/v2/models/_interface_link_type_dict.py b/foundry/v2/models/_interface_link_type_dict.py deleted file mode 100644 index 9b631f83..00000000 --- a/foundry/v2/models/_interface_link_type_dict.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictBool -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._interface_link_type_api_name import InterfaceLinkTypeApiName -from foundry.v2.models._interface_link_type_cardinality import InterfaceLinkTypeCardinality # NOQA -from foundry.v2.models._interface_link_type_linked_entity_api_name_dict import ( - InterfaceLinkTypeLinkedEntityApiNameDict, -) # NOQA -from foundry.v2.models._interface_link_type_rid import InterfaceLinkTypeRid - - -class InterfaceLinkTypeDict(TypedDict): - """ - A link type constraint defined at the interface level where the implementation of the links is provided - by the implementing object types. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: InterfaceLinkTypeRid - - apiName: InterfaceLinkTypeApiName - - displayName: DisplayName - - description: NotRequired[StrictStr] - """The description of the interface link type.""" - - linkedEntityApiName: InterfaceLinkTypeLinkedEntityApiNameDict - - cardinality: InterfaceLinkTypeCardinality - - required: StrictBool - """Whether each implementing object type must declare at least one implementation of this link.""" diff --git a/foundry/v2/models/_interface_link_type_linked_entity_api_name.py b/foundry/v2/models/_interface_link_type_linked_entity_api_name.py deleted file mode 100644 index d90814b3..00000000 --- a/foundry/v2/models/_interface_link_type_linked_entity_api_name.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._linked_interface_type_api_name import LinkedInterfaceTypeApiName -from foundry.v2.models._linked_object_type_api_name import LinkedObjectTypeApiName - -InterfaceLinkTypeLinkedEntityApiName = Annotated[ - Union[LinkedInterfaceTypeApiName, LinkedObjectTypeApiName], Field(discriminator="type") -] -"""A reference to the linked entity. This can either be an object or an interface type.""" diff --git a/foundry/v2/models/_interface_link_type_linked_entity_api_name_dict.py b/foundry/v2/models/_interface_link_type_linked_entity_api_name_dict.py deleted file mode 100644 index a7ca0dce..00000000 --- a/foundry/v2/models/_interface_link_type_linked_entity_api_name_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._linked_interface_type_api_name_dict import ( - LinkedInterfaceTypeApiNameDict, -) # NOQA -from foundry.v2.models._linked_object_type_api_name_dict import LinkedObjectTypeApiNameDict # NOQA - -InterfaceLinkTypeLinkedEntityApiNameDict = Annotated[ - Union[LinkedInterfaceTypeApiNameDict, LinkedObjectTypeApiNameDict], Field(discriminator="type") -] -"""A reference to the linked entity. This can either be an object or an interface type.""" diff --git a/foundry/v2/models/_interface_link_type_rid.py b/foundry/v2/models/_interface_link_type_rid.py deleted file mode 100644 index d1e890c1..00000000 --- a/foundry/v2/models/_interface_link_type_rid.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import RID - -InterfaceLinkTypeRid = RID -"""The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs.""" diff --git a/foundry/v2/models/_interface_type.py b/foundry/v2/models/_interface_type.py deleted file mode 100644 index c96021da..00000000 --- a/foundry/v2/models/_interface_type.py +++ /dev/null @@ -1,71 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._interface_link_type import InterfaceLinkType -from foundry.v2.models._interface_link_type_api_name import InterfaceLinkTypeApiName -from foundry.v2.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v2.models._interface_type_dict import InterfaceTypeDict -from foundry.v2.models._interface_type_rid import InterfaceTypeRid -from foundry.v2.models._shared_property_type import SharedPropertyType -from foundry.v2.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class InterfaceType(BaseModel): - """Represents an interface type in the Ontology.""" - - rid: InterfaceTypeRid - - api_name: InterfaceTypeApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - description: Optional[StrictStr] = None - """The description of the interface.""" - - properties: Dict[SharedPropertyTypeApiName, SharedPropertyType] - """ - A map from a shared property type API name to the corresponding shared property type. The map describes the - set of properties the interface has. A shared property type must be unique across all of the properties. - """ - - extends_interfaces: List[InterfaceTypeApiName] = Field(alias="extendsInterfaces") - """ - A list of interface API names that this interface extends. An interface can extend other interfaces to - inherit their properties. - """ - - links: Dict[InterfaceLinkTypeApiName, InterfaceLinkType] - """ - A map from an interface link type API name to the corresponding interface link type. The map describes the - set of link types the interface has. - """ - - model_config = {"extra": "allow"} - - def to_dict(self) -> InterfaceTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(InterfaceTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_interface_type_api_name.py b/foundry/v2/models/_interface_type_api_name.py deleted file mode 100644 index 6704f681..00000000 --- a/foundry/v2/models/_interface_type_api_name.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -InterfaceTypeApiName = StrictStr -""" -The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface -type, use the `List interface types` endpoint or check the **Ontology Manager**. -""" diff --git a/foundry/v2/models/_interface_type_dict.py b/foundry/v2/models/_interface_type_dict.py deleted file mode 100644 index ca0feac6..00000000 --- a/foundry/v2/models/_interface_type_dict.py +++ /dev/null @@ -1,64 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._interface_link_type_api_name import InterfaceLinkTypeApiName -from foundry.v2.models._interface_link_type_dict import InterfaceLinkTypeDict -from foundry.v2.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v2.models._interface_type_rid import InterfaceTypeRid -from foundry.v2.models._shared_property_type_api_name import SharedPropertyTypeApiName -from foundry.v2.models._shared_property_type_dict import SharedPropertyTypeDict - - -class InterfaceTypeDict(TypedDict): - """Represents an interface type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: InterfaceTypeRid - - apiName: InterfaceTypeApiName - - displayName: DisplayName - - description: NotRequired[StrictStr] - """The description of the interface.""" - - properties: Dict[SharedPropertyTypeApiName, SharedPropertyTypeDict] - """ - A map from a shared property type API name to the corresponding shared property type. The map describes the - set of properties the interface has. A shared property type must be unique across all of the properties. - """ - - extendsInterfaces: List[InterfaceTypeApiName] - """ - A list of interface API names that this interface extends. An interface can extend other interfaces to - inherit their properties. - """ - - links: Dict[InterfaceLinkTypeApiName, InterfaceLinkTypeDict] - """ - A map from an interface link type API name to the corresponding interface link type. The map describes the - set of link types the interface has. - """ diff --git a/foundry/v2/models/_interface_type_rid.py b/foundry/v2/models/_interface_type_rid.py deleted file mode 100644 index c36ac046..00000000 --- a/foundry/v2/models/_interface_type_rid.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import RID - -InterfaceTypeRid = RID -"""The unique resource identifier of an interface, useful for interacting with other Foundry APIs.""" diff --git a/foundry/v2/models/_intersects_bounding_box_query.py b/foundry/v2/models/_intersects_bounding_box_query.py deleted file mode 100644 index 7c604709..00000000 --- a/foundry/v2/models/_intersects_bounding_box_query.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._bounding_box_value import BoundingBoxValue -from foundry.v2.models._intersects_bounding_box_query_dict import ( - IntersectsBoundingBoxQueryDict, -) # NOQA -from foundry.v2.models._property_api_name import PropertyApiName - - -class IntersectsBoundingBoxQuery(BaseModel): - """Returns objects where the specified field intersects the bounding box provided.""" - - field: PropertyApiName - - value: BoundingBoxValue - - type: Literal["intersectsBoundingBox"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> IntersectsBoundingBoxQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - IntersectsBoundingBoxQueryDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_intersects_bounding_box_query_dict.py b/foundry/v2/models/_intersects_bounding_box_query_dict.py deleted file mode 100644 index e41eb9df..00000000 --- a/foundry/v2/models/_intersects_bounding_box_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._bounding_box_value_dict import BoundingBoxValueDict -from foundry.v2.models._property_api_name import PropertyApiName - - -class IntersectsBoundingBoxQueryDict(TypedDict): - """Returns objects where the specified field intersects the bounding box provided.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: BoundingBoxValueDict - - type: Literal["intersectsBoundingBox"] diff --git a/foundry/v2/models/_intersects_polygon_query.py b/foundry/v2/models/_intersects_polygon_query.py deleted file mode 100644 index caa008c8..00000000 --- a/foundry/v2/models/_intersects_polygon_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._intersects_polygon_query_dict import IntersectsPolygonQueryDict -from foundry.v2.models._polygon_value import PolygonValue -from foundry.v2.models._property_api_name import PropertyApiName - - -class IntersectsPolygonQuery(BaseModel): - """Returns objects where the specified field intersects the polygon provided.""" - - field: PropertyApiName - - value: PolygonValue - - type: Literal["intersectsPolygon"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> IntersectsPolygonQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(IntersectsPolygonQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_intersects_polygon_query_dict.py b/foundry/v2/models/_intersects_polygon_query_dict.py deleted file mode 100644 index 96345d91..00000000 --- a/foundry/v2/models/_intersects_polygon_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._polygon_value_dict import PolygonValueDict -from foundry.v2.models._property_api_name import PropertyApiName - - -class IntersectsPolygonQueryDict(TypedDict): - """Returns objects where the specified field intersects the polygon provided.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PolygonValueDict - - type: Literal["intersectsPolygon"] diff --git a/foundry/v2/models/_ir_version.py b/foundry/v2/models/_ir_version.py deleted file mode 100644 index 6730c8c0..00000000 --- a/foundry/v2/models/_ir_version.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -IrVersion = Literal["v1"] -"""IrVersion""" diff --git a/foundry/v2/models/_is_null_query.py b/foundry/v2/models/_is_null_query.py deleted file mode 100644 index 892d0bf1..00000000 --- a/foundry/v2/models/_is_null_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictBool - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._is_null_query_dict import IsNullQueryDict - - -class IsNullQuery(BaseModel): - """Returns objects based on the existence of the specified field.""" - - field: FieldNameV1 - - value: StrictBool - - type: Literal["isNull"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> IsNullQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(IsNullQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_is_null_query_dict.py b/foundry/v2/models/_is_null_query_dict.py deleted file mode 100644 index 5a10261b..00000000 --- a/foundry/v2/models/_is_null_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictBool -from typing_extensions import TypedDict - -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class IsNullQueryDict(TypedDict): - """Returns objects based on the existence of the specified field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: StrictBool - - type: Literal["isNull"] diff --git a/foundry/v2/models/_is_null_query_v2.py b/foundry/v2/models/_is_null_query_v2.py deleted file mode 100644 index b940cf28..00000000 --- a/foundry/v2/models/_is_null_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictBool - -from foundry.v2.models._is_null_query_v2_dict import IsNullQueryV2Dict -from foundry.v2.models._property_api_name import PropertyApiName - - -class IsNullQueryV2(BaseModel): - """Returns objects based on the existence of the specified field.""" - - field: PropertyApiName - - value: StrictBool - - type: Literal["isNull"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> IsNullQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(IsNullQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_is_null_query_v2_dict.py b/foundry/v2/models/_is_null_query_v2_dict.py deleted file mode 100644 index 719edf38..00000000 --- a/foundry/v2/models/_is_null_query_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictBool -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName - - -class IsNullQueryV2Dict(TypedDict): - """Returns objects based on the existence of the specified field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: StrictBool - - type: Literal["isNull"] diff --git a/foundry/v2/models/_line_string.py b/foundry/v2/models/_line_string.py deleted file mode 100644 index 7238c0dd..00000000 --- a/foundry/v2/models/_line_string.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._line_string_coordinates import LineStringCoordinates -from foundry.v2.models._line_string_dict import LineStringDict - - -class LineString(BaseModel): - """LineString""" - - coordinates: Optional[LineStringCoordinates] = None - - bbox: Optional[BBox] = None - - type: Literal["LineString"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LineStringDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LineStringDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_line_string_coordinates.py b/foundry/v2/models/_line_string_coordinates.py deleted file mode 100644 index 7fdf07e6..00000000 --- a/foundry/v2/models/_line_string_coordinates.py +++ /dev/null @@ -1,23 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from foundry.v2.models._position import Position - -LineStringCoordinates = List[Position] -"""GeoJSon fundamental geometry construct, array of two or more positions.""" diff --git a/foundry/v2/models/_line_string_dict.py b/foundry/v2/models/_line_string_dict.py deleted file mode 100644 index d93ab041..00000000 --- a/foundry/v2/models/_line_string_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._line_string_coordinates import LineStringCoordinates - - -class LineStringDict(TypedDict): - """LineString""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: NotRequired[LineStringCoordinates] - - bbox: NotRequired[BBox] - - type: Literal["LineString"] diff --git a/foundry/v2/models/_linear_ring.py b/foundry/v2/models/_linear_ring.py deleted file mode 100644 index 9cd14985..00000000 --- a/foundry/v2/models/_linear_ring.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from foundry.v2.models._position import Position - -LinearRing = List[Position] -""" -A linear ring is a closed LineString with four or more positions. - -The first and last positions are equivalent, and they MUST contain -identical values; their representation SHOULD also be identical. - -A linear ring is the boundary of a surface or the boundary of a hole in -a surface. - -A linear ring MUST follow the right-hand rule with respect to the area -it bounds, i.e., exterior rings are counterclockwise, and holes are -clockwise. -""" diff --git a/foundry/v2/models/_link_side_object.py b/foundry/v2/models/_link_side_object.py deleted file mode 100644 index 4a7d5293..00000000 --- a/foundry/v2/models/_link_side_object.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._link_side_object_dict import LinkSideObjectDict -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._property_value import PropertyValue - - -class LinkSideObject(BaseModel): - """LinkSideObject""" - - primary_key: PropertyValue = Field(alias="primaryKey") - - object_type: ObjectTypeApiName = Field(alias="objectType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> LinkSideObjectDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LinkSideObjectDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_link_side_object_dict.py b/foundry/v2/models/_link_side_object_dict.py deleted file mode 100644 index 6d06d14d..00000000 --- a/foundry/v2/models/_link_side_object_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._property_value import PropertyValue - - -class LinkSideObjectDict(TypedDict): - """LinkSideObject""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - primaryKey: PropertyValue - - objectType: ObjectTypeApiName diff --git a/foundry/v2/models/_link_type_rid.py b/foundry/v2/models/_link_type_rid.py deleted file mode 100644 index 2b6b1933..00000000 --- a/foundry/v2/models/_link_type_rid.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import RID - -LinkTypeRid = RID -"""LinkTypeRid""" diff --git a/foundry/v2/models/_link_type_side.py b/foundry/v2/models/_link_type_side.py deleted file mode 100644 index 47722a31..00000000 --- a/foundry/v2/models/_link_type_side.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._link_type_api_name import LinkTypeApiName -from foundry.v2.models._link_type_side_cardinality import LinkTypeSideCardinality -from foundry.v2.models._link_type_side_dict import LinkTypeSideDict -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._release_status import ReleaseStatus - - -class LinkTypeSide(BaseModel): - """LinkTypeSide""" - - api_name: LinkTypeApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - status: ReleaseStatus - - object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") - - cardinality: LinkTypeSideCardinality - - foreign_key_property_api_name: Optional[PropertyApiName] = Field( - alias="foreignKeyPropertyApiName", default=None - ) - - model_config = {"extra": "allow"} - - def to_dict(self) -> LinkTypeSideDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LinkTypeSideDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_link_type_side_dict.py b/foundry/v2/models/_link_type_side_dict.py deleted file mode 100644 index ba6eeb67..00000000 --- a/foundry/v2/models/_link_type_side_dict.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._link_type_api_name import LinkTypeApiName -from foundry.v2.models._link_type_side_cardinality import LinkTypeSideCardinality -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._release_status import ReleaseStatus - - -class LinkTypeSideDict(TypedDict): - """LinkTypeSide""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: LinkTypeApiName - - displayName: DisplayName - - status: ReleaseStatus - - objectTypeApiName: ObjectTypeApiName - - cardinality: LinkTypeSideCardinality - - foreignKeyPropertyApiName: NotRequired[PropertyApiName] diff --git a/foundry/v2/models/_link_type_side_v2.py b/foundry/v2/models/_link_type_side_v2.py deleted file mode 100644 index 7116f931..00000000 --- a/foundry/v2/models/_link_type_side_v2.py +++ /dev/null @@ -1,57 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._link_type_api_name import LinkTypeApiName -from foundry.v2.models._link_type_rid import LinkTypeRid -from foundry.v2.models._link_type_side_cardinality import LinkTypeSideCardinality -from foundry.v2.models._link_type_side_v2_dict import LinkTypeSideV2Dict -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._release_status import ReleaseStatus - - -class LinkTypeSideV2(BaseModel): - """LinkTypeSideV2""" - - api_name: LinkTypeApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - status: ReleaseStatus - - object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") - - cardinality: LinkTypeSideCardinality - - foreign_key_property_api_name: Optional[PropertyApiName] = Field( - alias="foreignKeyPropertyApiName", default=None - ) - - link_type_rid: LinkTypeRid = Field(alias="linkTypeRid") - - model_config = {"extra": "allow"} - - def to_dict(self) -> LinkTypeSideV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LinkTypeSideV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_link_type_side_v2_dict.py b/foundry/v2/models/_link_type_side_v2_dict.py deleted file mode 100644 index b33a4d9d..00000000 --- a/foundry/v2/models/_link_type_side_v2_dict.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._link_type_api_name import LinkTypeApiName -from foundry.v2.models._link_type_rid import LinkTypeRid -from foundry.v2.models._link_type_side_cardinality import LinkTypeSideCardinality -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._release_status import ReleaseStatus - - -class LinkTypeSideV2Dict(TypedDict): - """LinkTypeSideV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: LinkTypeApiName - - displayName: DisplayName - - status: ReleaseStatus - - objectTypeApiName: ObjectTypeApiName - - cardinality: LinkTypeSideCardinality - - foreignKeyPropertyApiName: NotRequired[PropertyApiName] - - linkTypeRid: LinkTypeRid diff --git a/foundry/v2/models/_linked_interface_type_api_name.py b/foundry/v2/models/_linked_interface_type_api_name.py deleted file mode 100644 index e34bc0c8..00000000 --- a/foundry/v2/models/_linked_interface_type_api_name.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v2.models._linked_interface_type_api_name_dict import ( - LinkedInterfaceTypeApiNameDict, -) # NOQA - - -class LinkedInterfaceTypeApiName(BaseModel): - """A reference to the linked interface type.""" - - api_name: InterfaceTypeApiName = Field(alias="apiName") - - type: Literal["interfaceTypeApiName"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LinkedInterfaceTypeApiNameDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - LinkedInterfaceTypeApiNameDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_linked_interface_type_api_name_dict.py b/foundry/v2/models/_linked_interface_type_api_name_dict.py deleted file mode 100644 index 373d92c8..00000000 --- a/foundry/v2/models/_linked_interface_type_api_name_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._interface_type_api_name import InterfaceTypeApiName - - -class LinkedInterfaceTypeApiNameDict(TypedDict): - """A reference to the linked interface type.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: InterfaceTypeApiName - - type: Literal["interfaceTypeApiName"] diff --git a/foundry/v2/models/_linked_object_type_api_name.py b/foundry/v2/models/_linked_object_type_api_name.py deleted file mode 100644 index 175818c5..00000000 --- a/foundry/v2/models/_linked_object_type_api_name.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._linked_object_type_api_name_dict import LinkedObjectTypeApiNameDict # NOQA -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class LinkedObjectTypeApiName(BaseModel): - """A reference to the linked object type.""" - - api_name: ObjectTypeApiName = Field(alias="apiName") - - type: Literal["objectTypeApiName"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LinkedObjectTypeApiNameDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LinkedObjectTypeApiNameDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_linked_object_type_api_name_dict.py b/foundry/v2/models/_linked_object_type_api_name_dict.py deleted file mode 100644 index 038501ad..00000000 --- a/foundry/v2/models/_linked_object_type_api_name_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class LinkedObjectTypeApiNameDict(TypedDict): - """A reference to the linked object type.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ObjectTypeApiName - - type: Literal["objectTypeApiName"] diff --git a/foundry/v2/models/_list_action_types_response.py b/foundry/v2/models/_list_action_types_response.py deleted file mode 100644 index 8b9347e2..00000000 --- a/foundry/v2/models/_list_action_types_response.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._action_type import ActionType -from foundry.v2.models._list_action_types_response_dict import ListActionTypesResponseDict # NOQA -from foundry.v2.models._page_token import PageToken - - -class ListActionTypesResponse(BaseModel): - """ListActionTypesResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[ActionType] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListActionTypesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListActionTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_list_action_types_response_dict.py b/foundry/v2/models/_list_action_types_response_dict.py deleted file mode 100644 index 9be9ae59..00000000 --- a/foundry/v2/models/_list_action_types_response_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._action_type_dict import ActionTypeDict -from foundry.v2.models._page_token import PageToken - - -class ListActionTypesResponseDict(TypedDict): - """ListActionTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[ActionTypeDict] diff --git a/foundry/v2/models/_list_action_types_response_v2.py b/foundry/v2/models/_list_action_types_response_v2.py deleted file mode 100644 index b7485327..00000000 --- a/foundry/v2/models/_list_action_types_response_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._action_type_v2 import ActionTypeV2 -from foundry.v2.models._list_action_types_response_v2_dict import ( - ListActionTypesResponseV2Dict, -) # NOQA -from foundry.v2.models._page_token import PageToken - - -class ListActionTypesResponseV2(BaseModel): - """ListActionTypesResponseV2""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[ActionTypeV2] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListActionTypesResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListActionTypesResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_list_action_types_response_v2_dict.py b/foundry/v2/models/_list_action_types_response_v2_dict.py deleted file mode 100644 index 27f2b2d7..00000000 --- a/foundry/v2/models/_list_action_types_response_v2_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._action_type_v2_dict import ActionTypeV2Dict -from foundry.v2.models._page_token import PageToken - - -class ListActionTypesResponseV2Dict(TypedDict): - """ListActionTypesResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[ActionTypeV2Dict] diff --git a/foundry/v2/models/_list_attachments_response_v2.py b/foundry/v2/models/_list_attachments_response_v2.py deleted file mode 100644 index be15a3f1..00000000 --- a/foundry/v2/models/_list_attachments_response_v2.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._attachment_v2 import AttachmentV2 -from foundry.v2.models._list_attachments_response_v2_dict import ( - ListAttachmentsResponseV2Dict, -) # NOQA -from foundry.v2.models._page_token import PageToken - - -class ListAttachmentsResponseV2(BaseModel): - """ListAttachmentsResponseV2""" - - data: List[AttachmentV2] - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - type: Literal["multiple"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListAttachmentsResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListAttachmentsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_list_attachments_response_v2_dict.py b/foundry/v2/models/_list_attachments_response_v2_dict.py deleted file mode 100644 index 8375b33e..00000000 --- a/foundry/v2/models/_list_attachments_response_v2_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._attachment_v2_dict import AttachmentV2Dict -from foundry.v2.models._page_token import PageToken - - -class ListAttachmentsResponseV2Dict(TypedDict): - """ListAttachmentsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[AttachmentV2Dict] - - nextPageToken: NotRequired[PageToken] - - type: Literal["multiple"] diff --git a/foundry/v2/models/_list_branches_response.py b/foundry/v2/models/_list_branches_response.py deleted file mode 100644 index 410fbcdb..00000000 --- a/foundry/v2/models/_list_branches_response.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._branch import Branch -from foundry.v2.models._list_branches_response_dict import ListBranchesResponseDict -from foundry.v2.models._page_token import PageToken - - -class ListBranchesResponse(BaseModel): - """ListBranchesResponse""" - - data: List[Branch] - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListBranchesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListBranchesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_list_branches_response_dict.py b/foundry/v2/models/_list_branches_response_dict.py deleted file mode 100644 index 703cf908..00000000 --- a/foundry/v2/models/_list_branches_response_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._branch_dict import BranchDict -from foundry.v2.models._page_token import PageToken - - -class ListBranchesResponseDict(TypedDict): - """ListBranchesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[BranchDict] - - nextPageToken: NotRequired[PageToken] diff --git a/foundry/v2/models/_list_files_response.py b/foundry/v2/models/_list_files_response.py deleted file mode 100644 index 62c683cf..00000000 --- a/foundry/v2/models/_list_files_response.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._file import File -from foundry.v2.models._list_files_response_dict import ListFilesResponseDict -from foundry.v2.models._page_token import PageToken - - -class ListFilesResponse(BaseModel): - """ListFilesResponse""" - - data: List[File] - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListFilesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListFilesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_list_files_response_dict.py b/foundry/v2/models/_list_files_response_dict.py deleted file mode 100644 index ea2e982c..00000000 --- a/foundry/v2/models/_list_files_response_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._file_dict import FileDict -from foundry.v2.models._page_token import PageToken - - -class ListFilesResponseDict(TypedDict): - """ListFilesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[FileDict] - - nextPageToken: NotRequired[PageToken] diff --git a/foundry/v2/models/_list_interface_types_response.py b/foundry/v2/models/_list_interface_types_response.py deleted file mode 100644 index 6936c39d..00000000 --- a/foundry/v2/models/_list_interface_types_response.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._interface_type import InterfaceType -from foundry.v2.models._list_interface_types_response_dict import ( - ListInterfaceTypesResponseDict, -) # NOQA -from foundry.v2.models._page_token import PageToken - - -class ListInterfaceTypesResponse(BaseModel): - """ListInterfaceTypesResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[InterfaceType] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListInterfaceTypesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListInterfaceTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_list_interface_types_response_dict.py b/foundry/v2/models/_list_interface_types_response_dict.py deleted file mode 100644 index a3549fa8..00000000 --- a/foundry/v2/models/_list_interface_types_response_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._interface_type_dict import InterfaceTypeDict -from foundry.v2.models._page_token import PageToken - - -class ListInterfaceTypesResponseDict(TypedDict): - """ListInterfaceTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[InterfaceTypeDict] diff --git a/foundry/v2/models/_list_linked_objects_response.py b/foundry/v2/models/_list_linked_objects_response.py deleted file mode 100644 index 2594d7d6..00000000 --- a/foundry/v2/models/_list_linked_objects_response.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._list_linked_objects_response_dict import ( - ListLinkedObjectsResponseDict, -) # NOQA -from foundry.v2.models._ontology_object import OntologyObject -from foundry.v2.models._page_token import PageToken - - -class ListLinkedObjectsResponse(BaseModel): - """ListLinkedObjectsResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[OntologyObject] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListLinkedObjectsResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListLinkedObjectsResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_list_linked_objects_response_dict.py b/foundry/v2/models/_list_linked_objects_response_dict.py deleted file mode 100644 index 21433ba8..00000000 --- a/foundry/v2/models/_list_linked_objects_response_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._ontology_object_dict import OntologyObjectDict -from foundry.v2.models._page_token import PageToken - - -class ListLinkedObjectsResponseDict(TypedDict): - """ListLinkedObjectsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[OntologyObjectDict] diff --git a/foundry/v2/models/_list_linked_objects_response_v2.py b/foundry/v2/models/_list_linked_objects_response_v2.py deleted file mode 100644 index 4499d159..00000000 --- a/foundry/v2/models/_list_linked_objects_response_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._list_linked_objects_response_v2_dict import ( - ListLinkedObjectsResponseV2Dict, -) # NOQA -from foundry.v2.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v2.models._page_token import PageToken - - -class ListLinkedObjectsResponseV2(BaseModel): - """ListLinkedObjectsResponseV2""" - - data: List[OntologyObjectV2] - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListLinkedObjectsResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListLinkedObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_list_linked_objects_response_v2_dict.py b/foundry/v2/models/_list_linked_objects_response_v2_dict.py deleted file mode 100644 index 06c96bff..00000000 --- a/foundry/v2/models/_list_linked_objects_response_v2_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v2.models._page_token import PageToken - - -class ListLinkedObjectsResponseV2Dict(TypedDict): - """ListLinkedObjectsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[OntologyObjectV2] - - nextPageToken: NotRequired[PageToken] diff --git a/foundry/v2/models/_list_object_types_response.py b/foundry/v2/models/_list_object_types_response.py deleted file mode 100644 index ad94158d..00000000 --- a/foundry/v2/models/_list_object_types_response.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._list_object_types_response_dict import ListObjectTypesResponseDict # NOQA -from foundry.v2.models._object_type import ObjectType -from foundry.v2.models._page_token import PageToken - - -class ListObjectTypesResponse(BaseModel): - """ListObjectTypesResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[ObjectType] - """The list of object types in the current page.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListObjectTypesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListObjectTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_list_object_types_response_dict.py b/foundry/v2/models/_list_object_types_response_dict.py deleted file mode 100644 index 774f0fcd..00000000 --- a/foundry/v2/models/_list_object_types_response_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._object_type_dict import ObjectTypeDict -from foundry.v2.models._page_token import PageToken - - -class ListObjectTypesResponseDict(TypedDict): - """ListObjectTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[ObjectTypeDict] - """The list of object types in the current page.""" diff --git a/foundry/v2/models/_list_object_types_v2_response.py b/foundry/v2/models/_list_object_types_v2_response.py deleted file mode 100644 index 43920c7e..00000000 --- a/foundry/v2/models/_list_object_types_v2_response.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._list_object_types_v2_response_dict import ( - ListObjectTypesV2ResponseDict, -) # NOQA -from foundry.v2.models._object_type_v2 import ObjectTypeV2 -from foundry.v2.models._page_token import PageToken - - -class ListObjectTypesV2Response(BaseModel): - """ListObjectTypesV2Response""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[ObjectTypeV2] - """The list of object types in the current page.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListObjectTypesV2ResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListObjectTypesV2ResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_list_object_types_v2_response_dict.py b/foundry/v2/models/_list_object_types_v2_response_dict.py deleted file mode 100644 index 5dd9a974..00000000 --- a/foundry/v2/models/_list_object_types_v2_response_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._object_type_v2_dict import ObjectTypeV2Dict -from foundry.v2.models._page_token import PageToken - - -class ListObjectTypesV2ResponseDict(TypedDict): - """ListObjectTypesV2Response""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[ObjectTypeV2Dict] - """The list of object types in the current page.""" diff --git a/foundry/v2/models/_list_objects_response.py b/foundry/v2/models/_list_objects_response.py deleted file mode 100644 index ab1cd8b4..00000000 --- a/foundry/v2/models/_list_objects_response.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._list_objects_response_dict import ListObjectsResponseDict -from foundry.v2.models._ontology_object import OntologyObject -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._total_count import TotalCount - - -class ListObjectsResponse(BaseModel): - """ListObjectsResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[OntologyObject] - """The list of objects in the current page.""" - - total_count: TotalCount = Field(alias="totalCount") - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListObjectsResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListObjectsResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_list_objects_response_dict.py b/foundry/v2/models/_list_objects_response_dict.py deleted file mode 100644 index afaf8c0a..00000000 --- a/foundry/v2/models/_list_objects_response_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._ontology_object_dict import OntologyObjectDict -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._total_count import TotalCount - - -class ListObjectsResponseDict(TypedDict): - """ListObjectsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[OntologyObjectDict] - """The list of objects in the current page.""" - - totalCount: TotalCount diff --git a/foundry/v2/models/_list_objects_response_v2.py b/foundry/v2/models/_list_objects_response_v2.py deleted file mode 100644 index e80b73a0..00000000 --- a/foundry/v2/models/_list_objects_response_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._list_objects_response_v2_dict import ListObjectsResponseV2Dict -from foundry.v2.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._total_count import TotalCount - - -class ListObjectsResponseV2(BaseModel): - """ListObjectsResponseV2""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[OntologyObjectV2] - """The list of objects in the current page.""" - - total_count: TotalCount = Field(alias="totalCount") - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListObjectsResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_list_objects_response_v2_dict.py b/foundry/v2/models/_list_objects_response_v2_dict.py deleted file mode 100644 index acaf5048..00000000 --- a/foundry/v2/models/_list_objects_response_v2_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._total_count import TotalCount - - -class ListObjectsResponseV2Dict(TypedDict): - """ListObjectsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[OntologyObjectV2] - """The list of objects in the current page.""" - - totalCount: TotalCount diff --git a/foundry/v2/models/_list_ontologies_response.py b/foundry/v2/models/_list_ontologies_response.py deleted file mode 100644 index 8ff14f10..00000000 --- a/foundry/v2/models/_list_ontologies_response.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._list_ontologies_response_dict import ListOntologiesResponseDict -from foundry.v2.models._ontology import Ontology - - -class ListOntologiesResponse(BaseModel): - """ListOntologiesResponse""" - - data: List[Ontology] - """The list of Ontologies the user has access to.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListOntologiesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListOntologiesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_list_ontologies_response_dict.py b/foundry/v2/models/_list_ontologies_response_dict.py deleted file mode 100644 index 997d3913..00000000 --- a/foundry/v2/models/_list_ontologies_response_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._ontology_dict import OntologyDict - - -class ListOntologiesResponseDict(TypedDict): - """ListOntologiesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[OntologyDict] - """The list of Ontologies the user has access to.""" diff --git a/foundry/v2/models/_list_ontologies_v2_response.py b/foundry/v2/models/_list_ontologies_v2_response.py deleted file mode 100644 index f4c57ec9..00000000 --- a/foundry/v2/models/_list_ontologies_v2_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._list_ontologies_v2_response_dict import ListOntologiesV2ResponseDict # NOQA -from foundry.v2.models._ontology_v2 import OntologyV2 - - -class ListOntologiesV2Response(BaseModel): - """ListOntologiesV2Response""" - - data: List[OntologyV2] - """The list of Ontologies the user has access to.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListOntologiesV2ResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListOntologiesV2ResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_list_ontologies_v2_response_dict.py b/foundry/v2/models/_list_ontologies_v2_response_dict.py deleted file mode 100644 index 6a07c159..00000000 --- a/foundry/v2/models/_list_ontologies_v2_response_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._ontology_v2_dict import OntologyV2Dict - - -class ListOntologiesV2ResponseDict(TypedDict): - """ListOntologiesV2Response""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[OntologyV2Dict] - """The list of Ontologies the user has access to.""" diff --git a/foundry/v2/models/_list_outgoing_link_types_response.py b/foundry/v2/models/_list_outgoing_link_types_response.py deleted file mode 100644 index ae3a9b3c..00000000 --- a/foundry/v2/models/_list_outgoing_link_types_response.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._link_type_side import LinkTypeSide -from foundry.v2.models._list_outgoing_link_types_response_dict import ( - ListOutgoingLinkTypesResponseDict, -) # NOQA -from foundry.v2.models._page_token import PageToken - - -class ListOutgoingLinkTypesResponse(BaseModel): - """ListOutgoingLinkTypesResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[LinkTypeSide] - """The list of link type sides in the current page.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListOutgoingLinkTypesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListOutgoingLinkTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_list_outgoing_link_types_response_dict.py b/foundry/v2/models/_list_outgoing_link_types_response_dict.py deleted file mode 100644 index 6927b49a..00000000 --- a/foundry/v2/models/_list_outgoing_link_types_response_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._link_type_side_dict import LinkTypeSideDict -from foundry.v2.models._page_token import PageToken - - -class ListOutgoingLinkTypesResponseDict(TypedDict): - """ListOutgoingLinkTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[LinkTypeSideDict] - """The list of link type sides in the current page.""" diff --git a/foundry/v2/models/_list_outgoing_link_types_response_v2.py b/foundry/v2/models/_list_outgoing_link_types_response_v2.py deleted file mode 100644 index 003eab09..00000000 --- a/foundry/v2/models/_list_outgoing_link_types_response_v2.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._link_type_side_v2 import LinkTypeSideV2 -from foundry.v2.models._list_outgoing_link_types_response_v2_dict import ( - ListOutgoingLinkTypesResponseV2Dict, -) # NOQA -from foundry.v2.models._page_token import PageToken - - -class ListOutgoingLinkTypesResponseV2(BaseModel): - """ListOutgoingLinkTypesResponseV2""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[LinkTypeSideV2] - """The list of link type sides in the current page.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListOutgoingLinkTypesResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListOutgoingLinkTypesResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_list_outgoing_link_types_response_v2_dict.py b/foundry/v2/models/_list_outgoing_link_types_response_v2_dict.py deleted file mode 100644 index 1228b84f..00000000 --- a/foundry/v2/models/_list_outgoing_link_types_response_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._link_type_side_v2_dict import LinkTypeSideV2Dict -from foundry.v2.models._page_token import PageToken - - -class ListOutgoingLinkTypesResponseV2Dict(TypedDict): - """ListOutgoingLinkTypesResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[LinkTypeSideV2Dict] - """The list of link type sides in the current page.""" diff --git a/foundry/v2/models/_list_query_types_response.py b/foundry/v2/models/_list_query_types_response.py deleted file mode 100644 index 0514fe9e..00000000 --- a/foundry/v2/models/_list_query_types_response.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._list_query_types_response_dict import ListQueryTypesResponseDict -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._query_type import QueryType - - -class ListQueryTypesResponse(BaseModel): - """ListQueryTypesResponse""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[QueryType] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListQueryTypesResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ListQueryTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_list_query_types_response_dict.py b/foundry/v2/models/_list_query_types_response_dict.py deleted file mode 100644 index c3a2dc35..00000000 --- a/foundry/v2/models/_list_query_types_response_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._query_type_dict import QueryTypeDict - - -class ListQueryTypesResponseDict(TypedDict): - """ListQueryTypesResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[QueryTypeDict] diff --git a/foundry/v2/models/_list_query_types_response_v2.py b/foundry/v2/models/_list_query_types_response_v2.py deleted file mode 100644 index 6d9c2e87..00000000 --- a/foundry/v2/models/_list_query_types_response_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._list_query_types_response_v2_dict import ( - ListQueryTypesResponseV2Dict, -) # NOQA -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._query_type_v2 import QueryTypeV2 - - -class ListQueryTypesResponseV2(BaseModel): - """ListQueryTypesResponseV2""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - data: List[QueryTypeV2] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ListQueryTypesResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ListQueryTypesResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_list_query_types_response_v2_dict.py b/foundry/v2/models/_list_query_types_response_v2_dict.py deleted file mode 100644 index 65872920..00000000 --- a/foundry/v2/models/_list_query_types_response_v2_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._query_type_v2_dict import QueryTypeV2Dict - - -class ListQueryTypesResponseV2Dict(TypedDict): - """ListQueryTypesResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - nextPageToken: NotRequired[PageToken] - - data: List[QueryTypeV2Dict] diff --git a/foundry/v2/models/_load_object_set_request_v2.py b/foundry/v2/models/_load_object_set_request_v2.py deleted file mode 100644 index d1db1f02..00000000 --- a/foundry/v2/models/_load_object_set_request_v2.py +++ /dev/null @@ -1,57 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool - -from foundry.v2.models._load_object_set_request_v2_dict import LoadObjectSetRequestV2Dict # NOQA -from foundry.v2.models._object_set import ObjectSet -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._search_order_by_v2 import SearchOrderByV2 -from foundry.v2.models._selected_property_api_name import SelectedPropertyApiName - - -class LoadObjectSetRequestV2(BaseModel): - """Represents the API POST body when loading an `ObjectSet`.""" - - object_set: ObjectSet = Field(alias="objectSet") - - order_by: Optional[SearchOrderByV2] = Field(alias="orderBy", default=None) - - select: List[SelectedPropertyApiName] - - page_token: Optional[PageToken] = Field(alias="pageToken", default=None) - - page_size: Optional[PageSize] = Field(alias="pageSize", default=None) - - exclude_rid: Optional[StrictBool] = Field(alias="excludeRid", default=None) - """ - A flag to exclude the retrieval of the `__rid` property. - Setting this to true may improve performance of this endpoint for object types in OSV2. - """ - - model_config = {"extra": "allow"} - - def to_dict(self) -> LoadObjectSetRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LoadObjectSetRequestV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_load_object_set_request_v2_dict.py b/foundry/v2/models/_load_object_set_request_v2_dict.py deleted file mode 100644 index 2a75a972..00000000 --- a/foundry/v2/models/_load_object_set_request_v2_dict.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from pydantic import StrictBool -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._object_set_dict import ObjectSetDict -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._search_order_by_v2_dict import SearchOrderByV2Dict -from foundry.v2.models._selected_property_api_name import SelectedPropertyApiName - - -class LoadObjectSetRequestV2Dict(TypedDict): - """Represents the API POST body when loading an `ObjectSet`.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict - - orderBy: NotRequired[SearchOrderByV2Dict] - - select: List[SelectedPropertyApiName] - - pageToken: NotRequired[PageToken] - - pageSize: NotRequired[PageSize] - - excludeRid: NotRequired[StrictBool] - """ - A flag to exclude the retrieval of the `__rid` property. - Setting this to true may improve performance of this endpoint for object types in OSV2. - """ diff --git a/foundry/v2/models/_load_object_set_response_v2.py b/foundry/v2/models/_load_object_set_response_v2.py deleted file mode 100644 index 22e6effe..00000000 --- a/foundry/v2/models/_load_object_set_response_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._load_object_set_response_v2_dict import LoadObjectSetResponseV2Dict # NOQA -from foundry.v2.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._total_count import TotalCount - - -class LoadObjectSetResponseV2(BaseModel): - """Represents the API response when loading an `ObjectSet`.""" - - data: List[OntologyObjectV2] - """The list of objects in the current Page.""" - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - total_count: TotalCount = Field(alias="totalCount") - - model_config = {"extra": "allow"} - - def to_dict(self) -> LoadObjectSetResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LoadObjectSetResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_load_object_set_response_v2_dict.py b/foundry/v2/models/_load_object_set_response_v2_dict.py deleted file mode 100644 index 77404c43..00000000 --- a/foundry/v2/models/_load_object_set_response_v2_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._total_count import TotalCount - - -class LoadObjectSetResponseV2Dict(TypedDict): - """Represents the API response when loading an `ObjectSet`.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[OntologyObjectV2] - """The list of objects in the current Page.""" - - nextPageToken: NotRequired[PageToken] - - totalCount: TotalCount diff --git a/foundry/v2/models/_local_file_path.py b/foundry/v2/models/_local_file_path.py deleted file mode 100644 index 45558835..00000000 --- a/foundry/v2/models/_local_file_path.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._local_file_path_dict import LocalFilePathDict - - -class LocalFilePath(BaseModel): - """LocalFilePath""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> LocalFilePathDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LocalFilePathDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_local_file_path_dict.py b/foundry/v2/models/_local_file_path_dict.py deleted file mode 100644 index 1771cd51..00000000 --- a/foundry/v2/models/_local_file_path_dict.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - - -class LocalFilePathDict(TypedDict): - """LocalFilePath""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/models/_logic_rule.py b/foundry/v2/models/_logic_rule.py deleted file mode 100644 index 6b612528..00000000 --- a/foundry/v2/models/_logic_rule.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._create_link_rule import CreateLinkRule -from foundry.v2.models._create_object_rule import CreateObjectRule -from foundry.v2.models._delete_link_rule import DeleteLinkRule -from foundry.v2.models._delete_object_rule import DeleteObjectRule -from foundry.v2.models._modify_object_rule import ModifyObjectRule - -LogicRule = Annotated[ - Union[CreateObjectRule, ModifyObjectRule, DeleteObjectRule, CreateLinkRule, DeleteLinkRule], - Field(discriminator="type"), -] -"""LogicRule""" diff --git a/foundry/v2/models/_logic_rule_dict.py b/foundry/v2/models/_logic_rule_dict.py deleted file mode 100644 index a028a11d..00000000 --- a/foundry/v2/models/_logic_rule_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._create_link_rule_dict import CreateLinkRuleDict -from foundry.v2.models._create_object_rule_dict import CreateObjectRuleDict -from foundry.v2.models._delete_link_rule_dict import DeleteLinkRuleDict -from foundry.v2.models._delete_object_rule_dict import DeleteObjectRuleDict -from foundry.v2.models._modify_object_rule_dict import ModifyObjectRuleDict - -LogicRuleDict = Annotated[ - Union[ - CreateObjectRuleDict, - ModifyObjectRuleDict, - DeleteObjectRuleDict, - CreateLinkRuleDict, - DeleteLinkRuleDict, - ], - Field(discriminator="type"), -] -"""LogicRule""" diff --git a/foundry/v2/models/_long_type.py b/foundry/v2/models/_long_type.py deleted file mode 100644 index 259c7953..00000000 --- a/foundry/v2/models/_long_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._long_type_dict import LongTypeDict - - -class LongType(BaseModel): - """LongType""" - - type: Literal["long"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LongTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LongTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_lt_query.py b/foundry/v2/models/_lt_query.py deleted file mode 100644 index 35e08e01..00000000 --- a/foundry/v2/models/_lt_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._lt_query_dict import LtQueryDict -from foundry.v2.models._property_value import PropertyValue - - -class LtQuery(BaseModel): - """Returns objects where the specified field is less than a value.""" - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["lt"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LtQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LtQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_lt_query_dict.py b/foundry/v2/models/_lt_query_dict.py deleted file mode 100644 index f5f4786b..00000000 --- a/foundry/v2/models/_lt_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._property_value import PropertyValue - - -class LtQueryDict(TypedDict): - """Returns objects where the specified field is less than a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["lt"] diff --git a/foundry/v2/models/_lt_query_v2.py b/foundry/v2/models/_lt_query_v2.py deleted file mode 100644 index 006d6599..00000000 --- a/foundry/v2/models/_lt_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._lt_query_v2_dict import LtQueryV2Dict -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - - -class LtQueryV2(BaseModel): - """Returns objects where the specified field is less than a value.""" - - field: PropertyApiName - - value: PropertyValue - - type: Literal["lt"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LtQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LtQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_lt_query_v2_dict.py b/foundry/v2/models/_lt_query_v2_dict.py deleted file mode 100644 index dd6e798c..00000000 --- a/foundry/v2/models/_lt_query_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - - -class LtQueryV2Dict(TypedDict): - """Returns objects where the specified field is less than a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PropertyValue - - type: Literal["lt"] diff --git a/foundry/v2/models/_lte_query.py b/foundry/v2/models/_lte_query.py deleted file mode 100644 index 6c15cb31..00000000 --- a/foundry/v2/models/_lte_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._lte_query_dict import LteQueryDict -from foundry.v2.models._property_value import PropertyValue - - -class LteQuery(BaseModel): - """Returns objects where the specified field is less than or equal to a value.""" - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["lte"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LteQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LteQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_lte_query_dict.py b/foundry/v2/models/_lte_query_dict.py deleted file mode 100644 index 6a17a881..00000000 --- a/foundry/v2/models/_lte_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._property_value import PropertyValue - - -class LteQueryDict(TypedDict): - """Returns objects where the specified field is less than or equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: PropertyValue - - type: Literal["lte"] diff --git a/foundry/v2/models/_lte_query_v2.py b/foundry/v2/models/_lte_query_v2.py deleted file mode 100644 index e8f9ec6b..00000000 --- a/foundry/v2/models/_lte_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._lte_query_v2_dict import LteQueryV2Dict -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - - -class LteQueryV2(BaseModel): - """Returns objects where the specified field is less than or equal to a value.""" - - field: PropertyApiName - - value: PropertyValue - - type: Literal["lte"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> LteQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(LteQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_lte_query_v2_dict.py b/foundry/v2/models/_lte_query_v2_dict.py deleted file mode 100644 index e5808eb0..00000000 --- a/foundry/v2/models/_lte_query_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - - -class LteQueryV2Dict(TypedDict): - """Returns objects where the specified field is less than or equal to a value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PropertyValue - - type: Literal["lte"] diff --git a/foundry/v2/models/_marking_type.py b/foundry/v2/models/_marking_type.py deleted file mode 100644 index 4660d336..00000000 --- a/foundry/v2/models/_marking_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._marking_type_dict import MarkingTypeDict - - -class MarkingType(BaseModel): - """MarkingType""" - - type: Literal["marking"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MarkingTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MarkingTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_max_aggregation.py b/foundry/v2/models/_max_aggregation.py deleted file mode 100644 index 1ac9f191..00000000 --- a/foundry/v2/models/_max_aggregation.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._max_aggregation_dict import MaxAggregationDict - - -class MaxAggregation(BaseModel): - """Computes the maximum value for the provided field.""" - - field: FieldNameV1 - - name: Optional[AggregationMetricName] = None - - type: Literal["max"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MaxAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MaxAggregationDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_max_aggregation_dict.py b/foundry/v2/models/_max_aggregation_dict.py deleted file mode 100644 index 46bdb295..00000000 --- a/foundry/v2/models/_max_aggregation_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class MaxAggregationDict(TypedDict): - """Computes the maximum value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - name: NotRequired[AggregationMetricName] - - type: Literal["max"] diff --git a/foundry/v2/models/_max_aggregation_v2.py b/foundry/v2/models/_max_aggregation_v2.py deleted file mode 100644 index c454bf6d..00000000 --- a/foundry/v2/models/_max_aggregation_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._max_aggregation_v2_dict import MaxAggregationV2Dict -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._property_api_name import PropertyApiName - - -class MaxAggregationV2(BaseModel): - """Computes the maximum value for the provided field.""" - - field: PropertyApiName - - name: Optional[AggregationMetricName] = None - - direction: Optional[OrderByDirection] = None - - type: Literal["max"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MaxAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MaxAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_max_aggregation_v2_dict.py b/foundry/v2/models/_max_aggregation_v2_dict.py deleted file mode 100644 index 313d4bef..00000000 --- a/foundry/v2/models/_max_aggregation_v2_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._property_api_name import PropertyApiName - - -class MaxAggregationV2Dict(TypedDict): - """Computes the maximum value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - name: NotRequired[AggregationMetricName] - - direction: NotRequired[OrderByDirection] - - type: Literal["max"] diff --git a/foundry/v2/models/_media_type.py b/foundry/v2/models/_media_type.py deleted file mode 100644 index add71261..00000000 --- a/foundry/v2/models/_media_type.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -MediaType = StrictStr -""" -The [media type](https://www.iana.org/assignments/media-types/media-types.xhtml) of the file or attachment. -Examples: `application/json`, `application/pdf`, `application/octet-stream`, `image/jpeg` -""" diff --git a/foundry/v2/models/_min_aggregation.py b/foundry/v2/models/_min_aggregation.py deleted file mode 100644 index 38ad7d62..00000000 --- a/foundry/v2/models/_min_aggregation.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._min_aggregation_dict import MinAggregationDict - - -class MinAggregation(BaseModel): - """Computes the minimum value for the provided field.""" - - field: FieldNameV1 - - name: Optional[AggregationMetricName] = None - - type: Literal["min"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MinAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MinAggregationDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_min_aggregation_dict.py b/foundry/v2/models/_min_aggregation_dict.py deleted file mode 100644 index 6690468a..00000000 --- a/foundry/v2/models/_min_aggregation_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class MinAggregationDict(TypedDict): - """Computes the minimum value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - name: NotRequired[AggregationMetricName] - - type: Literal["min"] diff --git a/foundry/v2/models/_min_aggregation_v2.py b/foundry/v2/models/_min_aggregation_v2.py deleted file mode 100644 index 775454cb..00000000 --- a/foundry/v2/models/_min_aggregation_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._min_aggregation_v2_dict import MinAggregationV2Dict -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._property_api_name import PropertyApiName - - -class MinAggregationV2(BaseModel): - """Computes the minimum value for the provided field.""" - - field: PropertyApiName - - name: Optional[AggregationMetricName] = None - - direction: Optional[OrderByDirection] = None - - type: Literal["min"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MinAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MinAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_min_aggregation_v2_dict.py b/foundry/v2/models/_min_aggregation_v2_dict.py deleted file mode 100644 index d181316b..00000000 --- a/foundry/v2/models/_min_aggregation_v2_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._property_api_name import PropertyApiName - - -class MinAggregationV2Dict(TypedDict): - """Computes the minimum value for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - name: NotRequired[AggregationMetricName] - - direction: NotRequired[OrderByDirection] - - type: Literal["min"] diff --git a/foundry/v2/models/_modify_object.py b/foundry/v2/models/_modify_object.py deleted file mode 100644 index 8dde034b..00000000 --- a/foundry/v2/models/_modify_object.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._modify_object_dict import ModifyObjectDict -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._property_value import PropertyValue - - -class ModifyObject(BaseModel): - """ModifyObject""" - - primary_key: PropertyValue = Field(alias="primaryKey") - - object_type: ObjectTypeApiName = Field(alias="objectType") - - type: Literal["modifyObject"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ModifyObjectDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ModifyObjectDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_modify_object_dict.py b/foundry/v2/models/_modify_object_dict.py deleted file mode 100644 index 75b74f2d..00000000 --- a/foundry/v2/models/_modify_object_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._property_value import PropertyValue - - -class ModifyObjectDict(TypedDict): - """ModifyObject""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - primaryKey: PropertyValue - - objectType: ObjectTypeApiName - - type: Literal["modifyObject"] diff --git a/foundry/v2/models/_modify_object_rule.py b/foundry/v2/models/_modify_object_rule.py deleted file mode 100644 index 6bf2b478..00000000 --- a/foundry/v2/models/_modify_object_rule.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._modify_object_rule_dict import ModifyObjectRuleDict -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class ModifyObjectRule(BaseModel): - """ModifyObjectRule""" - - object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") - - type: Literal["modifyObject"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ModifyObjectRuleDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ModifyObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_modify_object_rule_dict.py b/foundry/v2/models/_modify_object_rule_dict.py deleted file mode 100644 index 330599b0..00000000 --- a/foundry/v2/models/_modify_object_rule_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class ModifyObjectRuleDict(TypedDict): - """ModifyObjectRule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectTypeApiName: ObjectTypeApiName - - type: Literal["modifyObject"] diff --git a/foundry/v2/models/_multi_line_string.py b/foundry/v2/models/_multi_line_string.py deleted file mode 100644 index f7488fed..00000000 --- a/foundry/v2/models/_multi_line_string.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._line_string_coordinates import LineStringCoordinates -from foundry.v2.models._multi_line_string_dict import MultiLineStringDict - - -class MultiLineString(BaseModel): - """MultiLineString""" - - coordinates: List[LineStringCoordinates] - - bbox: Optional[BBox] = None - - type: Literal["MultiLineString"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MultiLineStringDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MultiLineStringDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_multi_line_string_dict.py b/foundry/v2/models/_multi_line_string_dict.py deleted file mode 100644 index 77233221..00000000 --- a/foundry/v2/models/_multi_line_string_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._line_string_coordinates import LineStringCoordinates - - -class MultiLineStringDict(TypedDict): - """MultiLineString""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: List[LineStringCoordinates] - - bbox: NotRequired[BBox] - - type: Literal["MultiLineString"] diff --git a/foundry/v2/models/_multi_point.py b/foundry/v2/models/_multi_point.py deleted file mode 100644 index 786a83b2..00000000 --- a/foundry/v2/models/_multi_point.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._multi_point_dict import MultiPointDict -from foundry.v2.models._position import Position - - -class MultiPoint(BaseModel): - """MultiPoint""" - - coordinates: List[Position] - - bbox: Optional[BBox] = None - - type: Literal["MultiPoint"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MultiPointDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MultiPointDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_multi_point_dict.py b/foundry/v2/models/_multi_point_dict.py deleted file mode 100644 index df0a69d0..00000000 --- a/foundry/v2/models/_multi_point_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._position import Position - - -class MultiPointDict(TypedDict): - """MultiPoint""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: List[Position] - - bbox: NotRequired[BBox] - - type: Literal["MultiPoint"] diff --git a/foundry/v2/models/_multi_polygon.py b/foundry/v2/models/_multi_polygon.py deleted file mode 100644 index e1d116c9..00000000 --- a/foundry/v2/models/_multi_polygon.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._linear_ring import LinearRing -from foundry.v2.models._multi_polygon_dict import MultiPolygonDict - - -class MultiPolygon(BaseModel): - """MultiPolygon""" - - coordinates: List[List[LinearRing]] - - bbox: Optional[BBox] = None - - type: Literal["MultiPolygon"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> MultiPolygonDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(MultiPolygonDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_multi_polygon_dict.py b/foundry/v2/models/_multi_polygon_dict.py deleted file mode 100644 index fce6876f..00000000 --- a/foundry/v2/models/_multi_polygon_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._linear_ring import LinearRing - - -class MultiPolygonDict(TypedDict): - """MultiPolygon""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: List[List[LinearRing]] - - bbox: NotRequired[BBox] - - type: Literal["MultiPolygon"] diff --git a/foundry/v2/models/_nested_query_aggregation.py b/foundry/v2/models/_nested_query_aggregation.py deleted file mode 100644 index cabad004..00000000 --- a/foundry/v2/models/_nested_query_aggregation.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._nested_query_aggregation_dict import NestedQueryAggregationDict -from foundry.v2.models._query_aggregation import QueryAggregation - - -class NestedQueryAggregation(BaseModel): - """NestedQueryAggregation""" - - key: Any - - groups: List[QueryAggregation] - - model_config = {"extra": "allow"} - - def to_dict(self) -> NestedQueryAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(NestedQueryAggregationDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_nested_query_aggregation_dict.py b/foundry/v2/models/_nested_query_aggregation_dict.py deleted file mode 100644 index 72a9f1ca..00000000 --- a/foundry/v2/models/_nested_query_aggregation_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._query_aggregation_dict import QueryAggregationDict - - -class NestedQueryAggregationDict(TypedDict): - """NestedQueryAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - key: Any - - groups: List[QueryAggregationDict] diff --git a/foundry/v2/models/_null_type.py b/foundry/v2/models/_null_type.py deleted file mode 100644 index f9814b88..00000000 --- a/foundry/v2/models/_null_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._null_type_dict import NullTypeDict - - -class NullType(BaseModel): - """NullType""" - - type: Literal["null"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> NullTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(NullTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_null_type_dict.py b/foundry/v2/models/_null_type_dict.py deleted file mode 100644 index 844f654a..00000000 --- a/foundry/v2/models/_null_type_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - - -class NullTypeDict(TypedDict): - """NullType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: Literal["null"] diff --git a/foundry/v2/models/_object_edit.py b/foundry/v2/models/_object_edit.py deleted file mode 100644 index fa79bdad..00000000 --- a/foundry/v2/models/_object_edit.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._add_link import AddLink -from foundry.v2.models._add_object import AddObject -from foundry.v2.models._modify_object import ModifyObject - -ObjectEdit = Annotated[Union[AddObject, ModifyObject, AddLink], Field(discriminator="type")] -"""ObjectEdit""" diff --git a/foundry/v2/models/_object_edit_dict.py b/foundry/v2/models/_object_edit_dict.py deleted file mode 100644 index 36ea12c1..00000000 --- a/foundry/v2/models/_object_edit_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._add_link_dict import AddLinkDict -from foundry.v2.models._add_object_dict import AddObjectDict -from foundry.v2.models._modify_object_dict import ModifyObjectDict - -ObjectEditDict = Annotated[ - Union[AddObjectDict, ModifyObjectDict, AddLinkDict], Field(discriminator="type") -] -"""ObjectEdit""" diff --git a/foundry/v2/models/_object_edits.py b/foundry/v2/models/_object_edits.py deleted file mode 100644 index 53980267..00000000 --- a/foundry/v2/models/_object_edits.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictInt - -from foundry.v2.models._object_edit import ObjectEdit -from foundry.v2.models._object_edits_dict import ObjectEditsDict - - -class ObjectEdits(BaseModel): - """ObjectEdits""" - - edits: List[ObjectEdit] - - added_object_count: StrictInt = Field(alias="addedObjectCount") - - modified_objects_count: StrictInt = Field(alias="modifiedObjectsCount") - - deleted_objects_count: StrictInt = Field(alias="deletedObjectsCount") - - added_links_count: StrictInt = Field(alias="addedLinksCount") - - deleted_links_count: StrictInt = Field(alias="deletedLinksCount") - - type: Literal["edits"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectEditsDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectEditsDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_object_edits_dict.py b/foundry/v2/models/_object_edits_dict.py deleted file mode 100644 index 7e958ba7..00000000 --- a/foundry/v2/models/_object_edits_dict.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from pydantic import StrictInt -from typing_extensions import TypedDict - -from foundry.v2.models._object_edit_dict import ObjectEditDict - - -class ObjectEditsDict(TypedDict): - """ObjectEdits""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - edits: List[ObjectEditDict] - - addedObjectCount: StrictInt - - modifiedObjectsCount: StrictInt - - deletedObjectsCount: StrictInt - - addedLinksCount: StrictInt - - deletedLinksCount: StrictInt - - type: Literal["edits"] diff --git a/foundry/v2/models/_object_primary_key.py b/foundry/v2/models/_object_primary_key.py deleted file mode 100644 index 8fcb80e2..00000000 --- a/foundry/v2/models/_object_primary_key.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict - -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - -ObjectPrimaryKey = Dict[PropertyApiName, PropertyValue] -"""ObjectPrimaryKey""" diff --git a/foundry/v2/models/_object_property_type.py b/foundry/v2/models/_object_property_type.py deleted file mode 100644 index 07bc36ee..00000000 --- a/foundry/v2/models/_object_property_type.py +++ /dev/null @@ -1,81 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._attachment_type import AttachmentType -from foundry.v2.models._boolean_type import BooleanType -from foundry.v2.models._byte_type import ByteType -from foundry.v2.models._date_type import DateType -from foundry.v2.models._decimal_type import DecimalType -from foundry.v2.models._double_type import DoubleType -from foundry.v2.models._float_type import FloatType -from foundry.v2.models._geo_point_type import GeoPointType -from foundry.v2.models._geo_shape_type import GeoShapeType -from foundry.v2.models._integer_type import IntegerType -from foundry.v2.models._long_type import LongType -from foundry.v2.models._marking_type import MarkingType -from foundry.v2.models._object_property_type_dict import OntologyObjectArrayTypeDict -from foundry.v2.models._short_type import ShortType -from foundry.v2.models._string_type import StringType -from foundry.v2.models._timeseries_type import TimeseriesType -from foundry.v2.models._timestamp_type import TimestampType - - -class OntologyObjectArrayType(BaseModel): - """OntologyObjectArrayType""" - - sub_type: ObjectPropertyType = Field(alias="subType") - - type: Literal["array"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyObjectArrayTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyObjectArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -ObjectPropertyType = Annotated[ - Union[ - OntologyObjectArrayType, - AttachmentType, - BooleanType, - ByteType, - DateType, - DecimalType, - DoubleType, - FloatType, - GeoPointType, - GeoShapeType, - IntegerType, - LongType, - MarkingType, - ShortType, - StringType, - TimestampType, - TimeseriesType, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Object properties.""" diff --git a/foundry/v2/models/_object_property_type_dict.py b/foundry/v2/models/_object_property_type_dict.py deleted file mode 100644 index eb09bae3..00000000 --- a/foundry/v2/models/_object_property_type_dict.py +++ /dev/null @@ -1,75 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import TypedDict - -from foundry.v2.models._attachment_type_dict import AttachmentTypeDict -from foundry.v2.models._boolean_type_dict import BooleanTypeDict -from foundry.v2.models._byte_type_dict import ByteTypeDict -from foundry.v2.models._date_type_dict import DateTypeDict -from foundry.v2.models._decimal_type_dict import DecimalTypeDict -from foundry.v2.models._double_type_dict import DoubleTypeDict -from foundry.v2.models._float_type_dict import FloatTypeDict -from foundry.v2.models._geo_point_type_dict import GeoPointTypeDict -from foundry.v2.models._geo_shape_type_dict import GeoShapeTypeDict -from foundry.v2.models._integer_type_dict import IntegerTypeDict -from foundry.v2.models._long_type_dict import LongTypeDict -from foundry.v2.models._marking_type_dict import MarkingTypeDict -from foundry.v2.models._short_type_dict import ShortTypeDict -from foundry.v2.models._string_type_dict import StringTypeDict -from foundry.v2.models._timeseries_type_dict import TimeseriesTypeDict -from foundry.v2.models._timestamp_type_dict import TimestampTypeDict - - -class OntologyObjectArrayTypeDict(TypedDict): - """OntologyObjectArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: ObjectPropertyTypeDict - - type: Literal["array"] - - -ObjectPropertyTypeDict = Annotated[ - Union[ - OntologyObjectArrayTypeDict, - AttachmentTypeDict, - BooleanTypeDict, - ByteTypeDict, - DateTypeDict, - DecimalTypeDict, - DoubleTypeDict, - FloatTypeDict, - GeoPointTypeDict, - GeoShapeTypeDict, - IntegerTypeDict, - LongTypeDict, - MarkingTypeDict, - ShortTypeDict, - StringTypeDict, - TimestampTypeDict, - TimeseriesTypeDict, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Object properties.""" diff --git a/foundry/v2/models/_object_property_value_constraint.py b/foundry/v2/models/_object_property_value_constraint.py deleted file mode 100644 index 3891941f..00000000 --- a/foundry/v2/models/_object_property_value_constraint.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._object_property_value_constraint_dict import ( - ObjectPropertyValueConstraintDict, -) # NOQA - - -class ObjectPropertyValueConstraint(BaseModel): - """The parameter value must be a property value of an object found within an object set.""" - - type: Literal["objectPropertyValue"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectPropertyValueConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectPropertyValueConstraintDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_object_query_result_constraint.py b/foundry/v2/models/_object_query_result_constraint.py deleted file mode 100644 index 53545238..00000000 --- a/foundry/v2/models/_object_query_result_constraint.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._object_query_result_constraint_dict import ( - ObjectQueryResultConstraintDict, -) # NOQA - - -class ObjectQueryResultConstraint(BaseModel): - """The parameter value must be the primary key of an object found within an object set.""" - - type: Literal["objectQueryResult"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectQueryResultConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectQueryResultConstraintDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_object_set.py b/foundry/v2/models/_object_set.py deleted file mode 100644 index 3b8e7d38..00000000 --- a/foundry/v2/models/_object_set.py +++ /dev/null @@ -1,130 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._link_type_api_name import LinkTypeApiName -from foundry.v2.models._object_set_base_type import ObjectSetBaseType -from foundry.v2.models._object_set_dict import ObjectSetFilterTypeDict -from foundry.v2.models._object_set_dict import ObjectSetIntersectionTypeDict -from foundry.v2.models._object_set_dict import ObjectSetSearchAroundTypeDict -from foundry.v2.models._object_set_dict import ObjectSetSubtractTypeDict -from foundry.v2.models._object_set_dict import ObjectSetUnionTypeDict -from foundry.v2.models._object_set_reference_type import ObjectSetReferenceType -from foundry.v2.models._object_set_static_type import ObjectSetStaticType -from foundry.v2.models._search_json_query_v2 import SearchJsonQueryV2 - - -class ObjectSetFilterType(BaseModel): - """ObjectSetFilterType""" - - object_set: ObjectSet = Field(alias="objectSet") - - where: SearchJsonQueryV2 - - type: Literal["filter"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetFilterTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectSetFilterTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class ObjectSetUnionType(BaseModel): - """ObjectSetUnionType""" - - object_sets: List[ObjectSet] = Field(alias="objectSets") - - type: Literal["union"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetUnionTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectSetUnionTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class ObjectSetIntersectionType(BaseModel): - """ObjectSetIntersectionType""" - - object_sets: List[ObjectSet] = Field(alias="objectSets") - - type: Literal["intersect"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetIntersectionTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectSetIntersectionTypeDict, self.model_dump(by_alias=True, exclude_unset=True) - ) - - -class ObjectSetSubtractType(BaseModel): - """ObjectSetSubtractType""" - - object_sets: List[ObjectSet] = Field(alias="objectSets") - - type: Literal["subtract"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetSubtractTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectSetSubtractTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class ObjectSetSearchAroundType(BaseModel): - """ObjectSetSearchAroundType""" - - object_set: ObjectSet = Field(alias="objectSet") - - link: LinkTypeApiName - - type: Literal["searchAround"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetSearchAroundTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectSetSearchAroundTypeDict, self.model_dump(by_alias=True, exclude_unset=True) - ) - - -ObjectSet = Annotated[ - Union[ - ObjectSetBaseType, - ObjectSetStaticType, - ObjectSetReferenceType, - ObjectSetFilterType, - ObjectSetUnionType, - ObjectSetIntersectionType, - ObjectSetSubtractType, - ObjectSetSearchAroundType, - ], - Field(discriminator="type"), -] -"""Represents the definition of an `ObjectSet` in the `Ontology`.""" diff --git a/foundry/v2/models/_object_set_base_type.py b/foundry/v2/models/_object_set_base_type.py deleted file mode 100644 index a7b94680..00000000 --- a/foundry/v2/models/_object_set_base_type.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._object_set_base_type_dict import ObjectSetBaseTypeDict - - -class ObjectSetBaseType(BaseModel): - """ObjectSetBaseType""" - - object_type: StrictStr = Field(alias="objectType") - - type: Literal["base"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetBaseTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectSetBaseTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_object_set_base_type_dict.py b/foundry/v2/models/_object_set_base_type_dict.py deleted file mode 100644 index 88190d98..00000000 --- a/foundry/v2/models/_object_set_base_type_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import TypedDict - - -class ObjectSetBaseTypeDict(TypedDict): - """ObjectSetBaseType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectType: StrictStr - - type: Literal["base"] diff --git a/foundry/v2/models/_object_set_dict.py b/foundry/v2/models/_object_set_dict.py deleted file mode 100644 index c810ce42..00000000 --- a/foundry/v2/models/_object_set_dict.py +++ /dev/null @@ -1,100 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import TypedDict - -from foundry.v2.models._link_type_api_name import LinkTypeApiName -from foundry.v2.models._object_set_base_type_dict import ObjectSetBaseTypeDict -from foundry.v2.models._object_set_reference_type_dict import ObjectSetReferenceTypeDict -from foundry.v2.models._object_set_static_type_dict import ObjectSetStaticTypeDict -from foundry.v2.models._search_json_query_v2_dict import SearchJsonQueryV2Dict - - -class ObjectSetFilterTypeDict(TypedDict): - """ObjectSetFilterType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict - - where: SearchJsonQueryV2Dict - - type: Literal["filter"] - - -class ObjectSetUnionTypeDict(TypedDict): - """ObjectSetUnionType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSets: List[ObjectSetDict] - - type: Literal["union"] - - -class ObjectSetIntersectionTypeDict(TypedDict): - """ObjectSetIntersectionType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSets: List[ObjectSetDict] - - type: Literal["intersect"] - - -class ObjectSetSubtractTypeDict(TypedDict): - """ObjectSetSubtractType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSets: List[ObjectSetDict] - - type: Literal["subtract"] - - -class ObjectSetSearchAroundTypeDict(TypedDict): - """ObjectSetSearchAroundType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict - - link: LinkTypeApiName - - type: Literal["searchAround"] - - -ObjectSetDict = Annotated[ - Union[ - ObjectSetBaseTypeDict, - ObjectSetStaticTypeDict, - ObjectSetReferenceTypeDict, - ObjectSetFilterTypeDict, - ObjectSetUnionTypeDict, - ObjectSetIntersectionTypeDict, - ObjectSetSubtractTypeDict, - ObjectSetSearchAroundTypeDict, - ], - Field(discriminator="type"), -] -"""Represents the definition of an `ObjectSet` in the `Ontology`.""" diff --git a/foundry/v2/models/_object_set_reference_type.py b/foundry/v2/models/_object_set_reference_type.py deleted file mode 100644 index b3be661c..00000000 --- a/foundry/v2/models/_object_set_reference_type.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry._core.utils import RID -from foundry.v2.models._object_set_reference_type_dict import ObjectSetReferenceTypeDict - - -class ObjectSetReferenceType(BaseModel): - """ObjectSetReferenceType""" - - reference: RID - - type: Literal["reference"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetReferenceTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectSetReferenceTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_object_set_reference_type_dict.py b/foundry/v2/models/_object_set_reference_type_dict.py deleted file mode 100644 index b130eb02..00000000 --- a/foundry/v2/models/_object_set_reference_type_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry._core.utils import RID - - -class ObjectSetReferenceTypeDict(TypedDict): - """ObjectSetReferenceType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - reference: RID - - type: Literal["reference"] diff --git a/foundry/v2/models/_object_set_rid.py b/foundry/v2/models/_object_set_rid.py deleted file mode 100644 index a5817267..00000000 --- a/foundry/v2/models/_object_set_rid.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import RID - -ObjectSetRid = RID -"""ObjectSetRid""" diff --git a/foundry/v2/models/_object_set_static_type.py b/foundry/v2/models/_object_set_static_type.py deleted file mode 100644 index 00c8ffb6..00000000 --- a/foundry/v2/models/_object_set_static_type.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._object_rid import ObjectRid -from foundry.v2.models._object_set_static_type_dict import ObjectSetStaticTypeDict - - -class ObjectSetStaticType(BaseModel): - """ObjectSetStaticType""" - - objects: List[ObjectRid] - - type: Literal["static"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetStaticTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectSetStaticTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_object_set_static_type_dict.py b/foundry/v2/models/_object_set_static_type_dict.py deleted file mode 100644 index 0f8bc5ba..00000000 --- a/foundry/v2/models/_object_set_static_type_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._object_rid import ObjectRid - - -class ObjectSetStaticTypeDict(TypedDict): - """ObjectSetStaticType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objects: List[ObjectRid] - - type: Literal["static"] diff --git a/foundry/v2/models/_object_set_stream_subscribe_request.py b/foundry/v2/models/_object_set_stream_subscribe_request.py deleted file mode 100644 index 72ec57b4..00000000 --- a/foundry/v2/models/_object_set_stream_subscribe_request.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._object_set import ObjectSet -from foundry.v2.models._object_set_stream_subscribe_request_dict import ( - ObjectSetStreamSubscribeRequestDict, -) # NOQA -from foundry.v2.models._selected_property_api_name import SelectedPropertyApiName - - -class ObjectSetStreamSubscribeRequest(BaseModel): - """ObjectSetStreamSubscribeRequest""" - - object_set: ObjectSet = Field(alias="objectSet") - - property_set: List[SelectedPropertyApiName] = Field(alias="propertySet") - - reference_set: List[SelectedPropertyApiName] = Field(alias="referenceSet") - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetStreamSubscribeRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectSetStreamSubscribeRequestDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_object_set_stream_subscribe_request_dict.py b/foundry/v2/models/_object_set_stream_subscribe_request_dict.py deleted file mode 100644 index a479de3f..00000000 --- a/foundry/v2/models/_object_set_stream_subscribe_request_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._object_set_dict import ObjectSetDict -from foundry.v2.models._selected_property_api_name import SelectedPropertyApiName - - -class ObjectSetStreamSubscribeRequestDict(TypedDict): - """ObjectSetStreamSubscribeRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectSet: ObjectSetDict - - propertySet: List[SelectedPropertyApiName] - - referenceSet: List[SelectedPropertyApiName] diff --git a/foundry/v2/models/_object_set_stream_subscribe_requests.py b/foundry/v2/models/_object_set_stream_subscribe_requests.py deleted file mode 100644 index 3d527efc..00000000 --- a/foundry/v2/models/_object_set_stream_subscribe_requests.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._object_set_stream_subscribe_request import ( - ObjectSetStreamSubscribeRequest, -) # NOQA -from foundry.v2.models._object_set_stream_subscribe_requests_dict import ( - ObjectSetStreamSubscribeRequestsDict, -) # NOQA -from foundry.v2.models._request_id import RequestId - - -class ObjectSetStreamSubscribeRequests(BaseModel): - """ - The list of object sets that should be subscribed to. A client can stop subscribing to an object set - by removing the request from subsequent ObjectSetStreamSubscribeRequests. - """ - - id: RequestId - - requests: List[ObjectSetStreamSubscribeRequest] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetStreamSubscribeRequestsDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectSetStreamSubscribeRequestsDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_object_set_stream_subscribe_requests_dict.py b/foundry/v2/models/_object_set_stream_subscribe_requests_dict.py deleted file mode 100644 index b3236a3c..00000000 --- a/foundry/v2/models/_object_set_stream_subscribe_requests_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._object_set_stream_subscribe_request_dict import ( - ObjectSetStreamSubscribeRequestDict, -) # NOQA -from foundry.v2.models._request_id import RequestId - - -class ObjectSetStreamSubscribeRequestsDict(TypedDict): - """ - The list of object sets that should be subscribed to. A client can stop subscribing to an object set - by removing the request from subsequent ObjectSetStreamSubscribeRequests. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - id: RequestId - - requests: List[ObjectSetStreamSubscribeRequestDict] diff --git a/foundry/v2/models/_object_set_subscribe_response.py b/foundry/v2/models/_object_set_subscribe_response.py deleted file mode 100644 index 093a3a7e..00000000 --- a/foundry/v2/models/_object_set_subscribe_response.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._qos_error import QosError -from foundry.v2.models._subscription_error import SubscriptionError -from foundry.v2.models._subscription_success import SubscriptionSuccess - -ObjectSetSubscribeResponse = Annotated[ - Union[SubscriptionSuccess, SubscriptionError, QosError], Field(discriminator="type") -] -"""ObjectSetSubscribeResponse""" diff --git a/foundry/v2/models/_object_set_subscribe_response_dict.py b/foundry/v2/models/_object_set_subscribe_response_dict.py deleted file mode 100644 index 1d283056..00000000 --- a/foundry/v2/models/_object_set_subscribe_response_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._qos_error_dict import QosErrorDict -from foundry.v2.models._subscription_error_dict import SubscriptionErrorDict -from foundry.v2.models._subscription_success_dict import SubscriptionSuccessDict - -ObjectSetSubscribeResponseDict = Annotated[ - Union[SubscriptionSuccessDict, SubscriptionErrorDict, QosErrorDict], Field(discriminator="type") -] -"""ObjectSetSubscribeResponse""" diff --git a/foundry/v2/models/_object_set_subscribe_responses.py b/foundry/v2/models/_object_set_subscribe_responses.py deleted file mode 100644 index 02dd8013..00000000 --- a/foundry/v2/models/_object_set_subscribe_responses.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._object_set_subscribe_response import ObjectSetSubscribeResponse -from foundry.v2.models._object_set_subscribe_responses_dict import ( - ObjectSetSubscribeResponsesDict, -) # NOQA -from foundry.v2.models._request_id import RequestId - - -class ObjectSetSubscribeResponses(BaseModel): - """Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId.""" - - responses: List[ObjectSetSubscribeResponse] - - id: RequestId - - type: Literal["subscribeResponses"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetSubscribeResponsesDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectSetSubscribeResponsesDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_object_set_subscribe_responses_dict.py b/foundry/v2/models/_object_set_subscribe_responses_dict.py deleted file mode 100644 index 03aee1ba..00000000 --- a/foundry/v2/models/_object_set_subscribe_responses_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._object_set_subscribe_response_dict import ( - ObjectSetSubscribeResponseDict, -) # NOQA -from foundry.v2.models._request_id import RequestId - - -class ObjectSetSubscribeResponsesDict(TypedDict): - """Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - responses: List[ObjectSetSubscribeResponseDict] - - id: RequestId - - type: Literal["subscribeResponses"] diff --git a/foundry/v2/models/_object_set_update.py b/foundry/v2/models/_object_set_update.py deleted file mode 100644 index 05e683c2..00000000 --- a/foundry/v2/models/_object_set_update.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._object_update import ObjectUpdate -from foundry.v2.models._reference_update import ReferenceUpdate - -ObjectSetUpdate = Annotated[Union[ObjectUpdate, ReferenceUpdate], Field(discriminator="type")] -"""ObjectSetUpdate""" diff --git a/foundry/v2/models/_object_set_update_dict.py b/foundry/v2/models/_object_set_update_dict.py deleted file mode 100644 index 2e1de65a..00000000 --- a/foundry/v2/models/_object_set_update_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._object_update_dict import ObjectUpdateDict -from foundry.v2.models._reference_update_dict import ReferenceUpdateDict - -ObjectSetUpdateDict = Annotated[ - Union[ObjectUpdateDict, ReferenceUpdateDict], Field(discriminator="type") -] -"""ObjectSetUpdate""" diff --git a/foundry/v2/models/_object_set_updates.py b/foundry/v2/models/_object_set_updates.py deleted file mode 100644 index 70b80e97..00000000 --- a/foundry/v2/models/_object_set_updates.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._object_set_update import ObjectSetUpdate -from foundry.v2.models._object_set_updates_dict import ObjectSetUpdatesDict -from foundry.v2.models._subscription_id import SubscriptionId - - -class ObjectSetUpdates(BaseModel): - """ObjectSetUpdates""" - - id: SubscriptionId - - updates: List[ObjectSetUpdate] - - type: Literal["objectSetChanged"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectSetUpdatesDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectSetUpdatesDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_object_set_updates_dict.py b/foundry/v2/models/_object_set_updates_dict.py deleted file mode 100644 index 03a28b88..00000000 --- a/foundry/v2/models/_object_set_updates_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._object_set_update_dict import ObjectSetUpdateDict -from foundry.v2.models._subscription_id import SubscriptionId - - -class ObjectSetUpdatesDict(TypedDict): - """ObjectSetUpdates""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - id: SubscriptionId - - updates: List[ObjectSetUpdateDict] - - type: Literal["objectSetChanged"] diff --git a/foundry/v2/models/_object_state.py b/foundry/v2/models/_object_state.py deleted file mode 100644 index 3f5d4340..00000000 --- a/foundry/v2/models/_object_state.py +++ /dev/null @@ -1,26 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -ObjectState = Literal["ADDED_OR_UPDATED", "REMOVED"] -""" -Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was -added to the set or the object has updated and was previously in the set. REMOVED indicates that the object -was removed from the set due to the object being deleted or the object no longer meets the object set -definition. -""" diff --git a/foundry/v2/models/_object_type.py b/foundry/v2/models/_object_type.py deleted file mode 100644 index 2e8cc4d0..00000000 --- a/foundry/v2/models/_object_type.py +++ /dev/null @@ -1,63 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._object_type_dict import ObjectTypeDict -from foundry.v2.models._object_type_rid import ObjectTypeRid -from foundry.v2.models._object_type_visibility import ObjectTypeVisibility -from foundry.v2.models._property import Property -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._release_status import ReleaseStatus - - -class ObjectType(BaseModel): - """Represents an object type in the Ontology.""" - - api_name: ObjectTypeApiName = Field(alias="apiName") - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - status: ReleaseStatus - - description: Optional[StrictStr] = None - """The description of the object type.""" - - visibility: Optional[ObjectTypeVisibility] = None - - primary_key: List[PropertyApiName] = Field(alias="primaryKey") - """The primary key of the object. This is a list of properties that can be used to uniquely identify the object.""" - - properties: Dict[PropertyApiName, Property] - """A map of the properties of the object type.""" - - rid: ObjectTypeRid - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_object_type_dict.py b/foundry/v2/models/_object_type_dict.py deleted file mode 100644 index ae9cda18..00000000 --- a/foundry/v2/models/_object_type_dict.py +++ /dev/null @@ -1,56 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._object_type_rid import ObjectTypeRid -from foundry.v2.models._object_type_visibility import ObjectTypeVisibility -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_dict import PropertyDict -from foundry.v2.models._release_status import ReleaseStatus - - -class ObjectTypeDict(TypedDict): - """Represents an object type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ObjectTypeApiName - - displayName: NotRequired[DisplayName] - - status: ReleaseStatus - - description: NotRequired[StrictStr] - """The description of the object type.""" - - visibility: NotRequired[ObjectTypeVisibility] - - primaryKey: List[PropertyApiName] - """The primary key of the object. This is a list of properties that can be used to uniquely identify the object.""" - - properties: Dict[PropertyApiName, PropertyDict] - """A map of the properties of the object type.""" - - rid: ObjectTypeRid diff --git a/foundry/v2/models/_object_type_edits.py b/foundry/v2/models/_object_type_edits.py deleted file mode 100644 index b4f26932..00000000 --- a/foundry/v2/models/_object_type_edits.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._object_type_edits_dict import ObjectTypeEditsDict - - -class ObjectTypeEdits(BaseModel): - """ObjectTypeEdits""" - - edited_object_types: List[ObjectTypeApiName] = Field(alias="editedObjectTypes") - - type: Literal["largeScaleEdits"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectTypeEditsDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectTypeEditsDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_object_type_edits_dict.py b/foundry/v2/models/_object_type_edits_dict.py deleted file mode 100644 index 34645d24..00000000 --- a/foundry/v2/models/_object_type_edits_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class ObjectTypeEditsDict(TypedDict): - """ObjectTypeEdits""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - editedObjectTypes: List[ObjectTypeApiName] - - type: Literal["largeScaleEdits"] diff --git a/foundry/v2/models/_object_type_full_metadata.py b/foundry/v2/models/_object_type_full_metadata.py deleted file mode 100644 index 9643ce49..00000000 --- a/foundry/v2/models/_object_type_full_metadata.py +++ /dev/null @@ -1,63 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v2.models._link_type_side_v2 import LinkTypeSideV2 -from foundry.v2.models._object_type_full_metadata_dict import ObjectTypeFullMetadataDict -from foundry.v2.models._object_type_interface_implementation import ( - ObjectTypeInterfaceImplementation, -) # NOQA -from foundry.v2.models._object_type_v2 import ObjectTypeV2 -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class ObjectTypeFullMetadata(BaseModel): - """ObjectTypeFullMetadata""" - - object_type: ObjectTypeV2 = Field(alias="objectType") - - link_types: List[LinkTypeSideV2] = Field(alias="linkTypes") - - implements_interfaces: List[InterfaceTypeApiName] = Field(alias="implementsInterfaces") - """A list of interfaces that this object type implements.""" - - implements_interfaces2: Dict[InterfaceTypeApiName, ObjectTypeInterfaceImplementation] = Field( - alias="implementsInterfaces2" - ) - """A list of interfaces that this object type implements and how it implements them.""" - - shared_property_type_mapping: Dict[SharedPropertyTypeApiName, PropertyApiName] = Field( - alias="sharedPropertyTypeMapping" - ) - """ - A map from shared property type API name to backing local property API name for the shared property types - present on this object type. - """ - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectTypeFullMetadataDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectTypeFullMetadataDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_object_type_full_metadata_dict.py b/foundry/v2/models/_object_type_full_metadata_dict.py deleted file mode 100644 index 5f686fce..00000000 --- a/foundry/v2/models/_object_type_full_metadata_dict.py +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v2.models._link_type_side_v2_dict import LinkTypeSideV2Dict -from foundry.v2.models._object_type_interface_implementation_dict import ( - ObjectTypeInterfaceImplementationDict, -) # NOQA -from foundry.v2.models._object_type_v2_dict import ObjectTypeV2Dict -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class ObjectTypeFullMetadataDict(TypedDict): - """ObjectTypeFullMetadata""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectType: ObjectTypeV2Dict - - linkTypes: List[LinkTypeSideV2Dict] - - implementsInterfaces: List[InterfaceTypeApiName] - """A list of interfaces that this object type implements.""" - - implementsInterfaces2: Dict[InterfaceTypeApiName, ObjectTypeInterfaceImplementationDict] - """A list of interfaces that this object type implements and how it implements them.""" - - sharedPropertyTypeMapping: Dict[SharedPropertyTypeApiName, PropertyApiName] - """ - A map from shared property type API name to backing local property API name for the shared property types - present on this object type. - """ diff --git a/foundry/v2/models/_object_type_interface_implementation.py b/foundry/v2/models/_object_type_interface_implementation.py deleted file mode 100644 index 2baeeee9..00000000 --- a/foundry/v2/models/_object_type_interface_implementation.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._object_type_interface_implementation_dict import ( - ObjectTypeInterfaceImplementationDict, -) # NOQA -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class ObjectTypeInterfaceImplementation(BaseModel): - """ObjectTypeInterfaceImplementation""" - - properties: Dict[SharedPropertyTypeApiName, PropertyApiName] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectTypeInterfaceImplementationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ObjectTypeInterfaceImplementationDict, - self.model_dump(by_alias=True, exclude_unset=True), - ) diff --git a/foundry/v2/models/_object_type_interface_implementation_dict.py b/foundry/v2/models/_object_type_interface_implementation_dict.py deleted file mode 100644 index 70638a66..00000000 --- a/foundry/v2/models/_object_type_interface_implementation_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict - -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class ObjectTypeInterfaceImplementationDict(TypedDict): - """ObjectTypeInterfaceImplementation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - properties: Dict[SharedPropertyTypeApiName, PropertyApiName] diff --git a/foundry/v2/models/_object_type_v2.py b/foundry/v2/models/_object_type_v2.py deleted file mode 100644 index 610e1fca..00000000 --- a/foundry/v2/models/_object_type_v2.py +++ /dev/null @@ -1,69 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._icon import Icon -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._object_type_rid import ObjectTypeRid -from foundry.v2.models._object_type_v2_dict import ObjectTypeV2Dict -from foundry.v2.models._object_type_visibility import ObjectTypeVisibility -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_v2 import PropertyV2 -from foundry.v2.models._release_status import ReleaseStatus - - -class ObjectTypeV2(BaseModel): - """Represents an object type in the Ontology.""" - - api_name: ObjectTypeApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - status: ReleaseStatus - - description: Optional[StrictStr] = None - """The description of the object type.""" - - plural_display_name: StrictStr = Field(alias="pluralDisplayName") - """The plural display name of the object type.""" - - icon: Icon - - primary_key: PropertyApiName = Field(alias="primaryKey") - - properties: Dict[PropertyApiName, PropertyV2] - """A map of the properties of the object type.""" - - rid: ObjectTypeRid - - title_property: PropertyApiName = Field(alias="titleProperty") - - visibility: Optional[ObjectTypeVisibility] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectTypeV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectTypeV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_object_type_v2_dict.py b/foundry/v2/models/_object_type_v2_dict.py deleted file mode 100644 index ba6026f2..00000000 --- a/foundry/v2/models/_object_type_v2_dict.py +++ /dev/null @@ -1,62 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._icon_dict import IconDict -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._object_type_rid import ObjectTypeRid -from foundry.v2.models._object_type_visibility import ObjectTypeVisibility -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_v2_dict import PropertyV2Dict -from foundry.v2.models._release_status import ReleaseStatus - - -class ObjectTypeV2Dict(TypedDict): - """Represents an object type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: ObjectTypeApiName - - displayName: DisplayName - - status: ReleaseStatus - - description: NotRequired[StrictStr] - """The description of the object type.""" - - pluralDisplayName: StrictStr - """The plural display name of the object type.""" - - icon: IconDict - - primaryKey: PropertyApiName - - properties: Dict[PropertyApiName, PropertyV2Dict] - """A map of the properties of the object type.""" - - rid: ObjectTypeRid - - titleProperty: PropertyApiName - - visibility: NotRequired[ObjectTypeVisibility] diff --git a/foundry/v2/models/_object_update.py b/foundry/v2/models/_object_update.py deleted file mode 100644 index c651344a..00000000 --- a/foundry/v2/models/_object_update.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._object_state import ObjectState -from foundry.v2.models._object_update_dict import ObjectUpdateDict -from foundry.v2.models._ontology_object_v2 import OntologyObjectV2 - - -class ObjectUpdate(BaseModel): - """ObjectUpdate""" - - object: OntologyObjectV2 - - state: ObjectState - - type: Literal["object"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ObjectUpdateDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ObjectUpdateDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_object_update_dict.py b/foundry/v2/models/_object_update_dict.py deleted file mode 100644 index 81dae66a..00000000 --- a/foundry/v2/models/_object_update_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._object_state import ObjectState -from foundry.v2.models._ontology_object_v2 import OntologyObjectV2 - - -class ObjectUpdateDict(TypedDict): - """ObjectUpdate""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - object: OntologyObjectV2 - - state: ObjectState - - type: Literal["object"] diff --git a/foundry/v2/models/_one_of_constraint.py b/foundry/v2/models/_one_of_constraint.py deleted file mode 100644 index 0fee0a34..00000000 --- a/foundry/v2/models/_one_of_constraint.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool - -from foundry.v2.models._one_of_constraint_dict import OneOfConstraintDict -from foundry.v2.models._parameter_option import ParameterOption - - -class OneOfConstraint(BaseModel): - """The parameter has a manually predefined set of options.""" - - options: List[ParameterOption] - - other_values_allowed: StrictBool = Field(alias="otherValuesAllowed") - """A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**.""" - - type: Literal["oneOf"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OneOfConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OneOfConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_one_of_constraint_dict.py b/foundry/v2/models/_one_of_constraint_dict.py deleted file mode 100644 index 441b1b08..00000000 --- a/foundry/v2/models/_one_of_constraint_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from pydantic import StrictBool -from typing_extensions import TypedDict - -from foundry.v2.models._parameter_option_dict import ParameterOptionDict - - -class OneOfConstraintDict(TypedDict): - """The parameter has a manually predefined set of options.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - options: List[ParameterOptionDict] - - otherValuesAllowed: StrictBool - """A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**.""" - - type: Literal["oneOf"] diff --git a/foundry/v2/models/_ontology.py b/foundry/v2/models/_ontology.py deleted file mode 100644 index 7b76cfb7..00000000 --- a/foundry/v2/models/_ontology.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._ontology_api_name import OntologyApiName -from foundry.v2.models._ontology_dict import OntologyDict -from foundry.v2.models._ontology_rid import OntologyRid - - -class Ontology(BaseModel): - """Metadata about an Ontology.""" - - api_name: OntologyApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - description: StrictStr - - rid: OntologyRid - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_ontology_data_type.py b/foundry/v2/models/_ontology_data_type.py deleted file mode 100644 index 09a1c72e..00000000 --- a/foundry/v2/models/_ontology_data_type.py +++ /dev/null @@ -1,153 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool - -from foundry.v2.models._any_type import AnyType -from foundry.v2.models._binary_type import BinaryType -from foundry.v2.models._boolean_type import BooleanType -from foundry.v2.models._byte_type import ByteType -from foundry.v2.models._date_type import DateType -from foundry.v2.models._decimal_type import DecimalType -from foundry.v2.models._double_type import DoubleType -from foundry.v2.models._float_type import FloatType -from foundry.v2.models._integer_type import IntegerType -from foundry.v2.models._long_type import LongType -from foundry.v2.models._marking_type import MarkingType -from foundry.v2.models._ontology_data_type_dict import OntologyArrayTypeDict -from foundry.v2.models._ontology_data_type_dict import OntologyMapTypeDict -from foundry.v2.models._ontology_data_type_dict import OntologySetTypeDict -from foundry.v2.models._ontology_data_type_dict import OntologyStructFieldDict -from foundry.v2.models._ontology_data_type_dict import OntologyStructTypeDict -from foundry.v2.models._ontology_object_set_type import OntologyObjectSetType -from foundry.v2.models._ontology_object_type import OntologyObjectType -from foundry.v2.models._short_type import ShortType -from foundry.v2.models._string_type import StringType -from foundry.v2.models._struct_field_name import StructFieldName -from foundry.v2.models._timestamp_type import TimestampType -from foundry.v2.models._unsupported_type import UnsupportedType - - -class OntologyArrayType(BaseModel): - """OntologyArrayType""" - - item_type: OntologyDataType = Field(alias="itemType") - - type: Literal["array"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyArrayTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class OntologyMapType(BaseModel): - """OntologyMapType""" - - key_type: OntologyDataType = Field(alias="keyType") - - value_type: OntologyDataType = Field(alias="valueType") - - type: Literal["map"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyMapTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyMapTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class OntologySetType(BaseModel): - """OntologySetType""" - - item_type: OntologyDataType = Field(alias="itemType") - - type: Literal["set"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologySetTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologySetTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class OntologyStructField(BaseModel): - """OntologyStructField""" - - name: StructFieldName - - field_type: OntologyDataType = Field(alias="fieldType") - - required: StrictBool - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyStructFieldDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyStructFieldDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class OntologyStructType(BaseModel): - """OntologyStructType""" - - fields: List[OntologyStructField] - - type: Literal["struct"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyStructTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyStructTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -OntologyDataType = Annotated[ - Union[ - AnyType, - BinaryType, - BooleanType, - ByteType, - DateType, - DecimalType, - DoubleType, - FloatType, - IntegerType, - LongType, - MarkingType, - ShortType, - StringType, - TimestampType, - OntologyArrayType, - OntologyMapType, - OntologySetType, - OntologyStructType, - OntologyObjectType, - OntologyObjectSetType, - UnsupportedType, - ], - Field(discriminator="type"), -] -"""A union of all the primitive types used by Palantir's Ontology-based products.""" diff --git a/foundry/v2/models/_ontology_data_type_dict.py b/foundry/v2/models/_ontology_data_type_dict.py deleted file mode 100644 index 668a34d9..00000000 --- a/foundry/v2/models/_ontology_data_type_dict.py +++ /dev/null @@ -1,127 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union - -from pydantic import Field -from pydantic import StrictBool -from typing_extensions import TypedDict - -from foundry.v2.models._any_type_dict import AnyTypeDict -from foundry.v2.models._binary_type_dict import BinaryTypeDict -from foundry.v2.models._boolean_type_dict import BooleanTypeDict -from foundry.v2.models._byte_type_dict import ByteTypeDict -from foundry.v2.models._date_type_dict import DateTypeDict -from foundry.v2.models._decimal_type_dict import DecimalTypeDict -from foundry.v2.models._double_type_dict import DoubleTypeDict -from foundry.v2.models._float_type_dict import FloatTypeDict -from foundry.v2.models._integer_type_dict import IntegerTypeDict -from foundry.v2.models._long_type_dict import LongTypeDict -from foundry.v2.models._marking_type_dict import MarkingTypeDict -from foundry.v2.models._ontology_object_set_type_dict import OntologyObjectSetTypeDict -from foundry.v2.models._ontology_object_type_dict import OntologyObjectTypeDict -from foundry.v2.models._short_type_dict import ShortTypeDict -from foundry.v2.models._string_type_dict import StringTypeDict -from foundry.v2.models._struct_field_name import StructFieldName -from foundry.v2.models._timestamp_type_dict import TimestampTypeDict -from foundry.v2.models._unsupported_type_dict import UnsupportedTypeDict - - -class OntologyArrayTypeDict(TypedDict): - """OntologyArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - itemType: OntologyDataTypeDict - - type: Literal["array"] - - -class OntologyMapTypeDict(TypedDict): - """OntologyMapType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyType: OntologyDataTypeDict - - valueType: OntologyDataTypeDict - - type: Literal["map"] - - -class OntologySetTypeDict(TypedDict): - """OntologySetType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - itemType: OntologyDataTypeDict - - type: Literal["set"] - - -class OntologyStructFieldDict(TypedDict): - """OntologyStructField""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: StructFieldName - - fieldType: OntologyDataTypeDict - - required: StrictBool - - -class OntologyStructTypeDict(TypedDict): - """OntologyStructType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: List[OntologyStructFieldDict] - - type: Literal["struct"] - - -OntologyDataTypeDict = Annotated[ - Union[ - AnyTypeDict, - BinaryTypeDict, - BooleanTypeDict, - ByteTypeDict, - DateTypeDict, - DecimalTypeDict, - DoubleTypeDict, - FloatTypeDict, - IntegerTypeDict, - LongTypeDict, - MarkingTypeDict, - ShortTypeDict, - StringTypeDict, - TimestampTypeDict, - OntologyArrayTypeDict, - OntologyMapTypeDict, - OntologySetTypeDict, - OntologyStructTypeDict, - OntologyObjectTypeDict, - OntologyObjectSetTypeDict, - UnsupportedTypeDict, - ], - Field(discriminator="type"), -] -"""A union of all the primitive types used by Palantir's Ontology-based products.""" diff --git a/foundry/v2/models/_ontology_dict.py b/foundry/v2/models/_ontology_dict.py deleted file mode 100644 index ed5baddc..00000000 --- a/foundry/v2/models/_ontology_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import TypedDict - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._ontology_api_name import OntologyApiName -from foundry.v2.models._ontology_rid import OntologyRid - - -class OntologyDict(TypedDict): - """Metadata about an Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: OntologyApiName - - displayName: DisplayName - - description: StrictStr - - rid: OntologyRid diff --git a/foundry/v2/models/_ontology_full_metadata.py b/foundry/v2/models/_ontology_full_metadata.py deleted file mode 100644 index dac16685..00000000 --- a/foundry/v2/models/_ontology_full_metadata.py +++ /dev/null @@ -1,59 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._action_type_api_name import ActionTypeApiName -from foundry.v2.models._action_type_v2 import ActionTypeV2 -from foundry.v2.models._interface_type import InterfaceType -from foundry.v2.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._object_type_full_metadata import ObjectTypeFullMetadata -from foundry.v2.models._ontology_full_metadata_dict import OntologyFullMetadataDict -from foundry.v2.models._ontology_v2 import OntologyV2 -from foundry.v2.models._query_api_name import QueryApiName -from foundry.v2.models._query_type_v2 import QueryTypeV2 -from foundry.v2.models._shared_property_type import SharedPropertyType -from foundry.v2.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class OntologyFullMetadata(BaseModel): - """OntologyFullMetadata""" - - ontology: OntologyV2 - - object_types: Dict[ObjectTypeApiName, ObjectTypeFullMetadata] = Field(alias="objectTypes") - - action_types: Dict[ActionTypeApiName, ActionTypeV2] = Field(alias="actionTypes") - - query_types: Dict[QueryApiName, QueryTypeV2] = Field(alias="queryTypes") - - interface_types: Dict[InterfaceTypeApiName, InterfaceType] = Field(alias="interfaceTypes") - - shared_property_types: Dict[SharedPropertyTypeApiName, SharedPropertyType] = Field( - alias="sharedPropertyTypes" - ) - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyFullMetadataDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyFullMetadataDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_ontology_full_metadata_dict.py b/foundry/v2/models/_ontology_full_metadata_dict.py deleted file mode 100644 index f06c09e4..00000000 --- a/foundry/v2/models/_ontology_full_metadata_dict.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict - -from typing_extensions import TypedDict - -from foundry.v2.models._action_type_api_name import ActionTypeApiName -from foundry.v2.models._action_type_v2_dict import ActionTypeV2Dict -from foundry.v2.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v2.models._interface_type_dict import InterfaceTypeDict -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._object_type_full_metadata_dict import ObjectTypeFullMetadataDict -from foundry.v2.models._ontology_v2_dict import OntologyV2Dict -from foundry.v2.models._query_api_name import QueryApiName -from foundry.v2.models._query_type_v2_dict import QueryTypeV2Dict -from foundry.v2.models._shared_property_type_api_name import SharedPropertyTypeApiName -from foundry.v2.models._shared_property_type_dict import SharedPropertyTypeDict - - -class OntologyFullMetadataDict(TypedDict): - """OntologyFullMetadata""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - ontology: OntologyV2Dict - - objectTypes: Dict[ObjectTypeApiName, ObjectTypeFullMetadataDict] - - actionTypes: Dict[ActionTypeApiName, ActionTypeV2Dict] - - queryTypes: Dict[QueryApiName, QueryTypeV2Dict] - - interfaceTypes: Dict[InterfaceTypeApiName, InterfaceTypeDict] - - sharedPropertyTypes: Dict[SharedPropertyTypeApiName, SharedPropertyTypeDict] diff --git a/foundry/v2/models/_ontology_identifier.py b/foundry/v2/models/_ontology_identifier.py deleted file mode 100644 index fa4de3c1..00000000 --- a/foundry/v2/models/_ontology_identifier.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -OntologyIdentifier = StrictStr -"""Either an ontology rid or an ontology api name.""" diff --git a/foundry/v2/models/_ontology_object.py b/foundry/v2/models/_ontology_object.py deleted file mode 100644 index b3054cab..00000000 --- a/foundry/v2/models/_ontology_object.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._object_rid import ObjectRid -from foundry.v2.models._ontology_object_dict import OntologyObjectDict -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - - -class OntologyObject(BaseModel): - """Represents an object in the Ontology.""" - - properties: Dict[PropertyApiName, Optional[PropertyValue]] - """A map of the property values of the object.""" - - rid: ObjectRid - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyObjectDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyObjectDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_ontology_object_dict.py b/foundry/v2/models/_ontology_object_dict.py deleted file mode 100644 index 96932751..00000000 --- a/foundry/v2/models/_ontology_object_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import TypedDict - -from foundry.v2.models._object_rid import ObjectRid -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - - -class OntologyObjectDict(TypedDict): - """Represents an object in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - properties: Dict[PropertyApiName, Optional[PropertyValue]] - """A map of the property values of the object.""" - - rid: ObjectRid diff --git a/foundry/v2/models/_ontology_object_set_type.py b/foundry/v2/models/_ontology_object_set_type.py deleted file mode 100644 index f91a3c6a..00000000 --- a/foundry/v2/models/_ontology_object_set_type.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._ontology_object_set_type_dict import OntologyObjectSetTypeDict - - -class OntologyObjectSetType(BaseModel): - """OntologyObjectSetType""" - - object_api_name: Optional[ObjectTypeApiName] = Field(alias="objectApiName", default=None) - - object_type_api_name: Optional[ObjectTypeApiName] = Field( - alias="objectTypeApiName", default=None - ) - - type: Literal["objectSet"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyObjectSetTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyObjectSetTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_ontology_object_set_type_dict.py b/foundry/v2/models/_ontology_object_set_type_dict.py deleted file mode 100644 index 477c4677..00000000 --- a/foundry/v2/models/_ontology_object_set_type_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class OntologyObjectSetTypeDict(TypedDict): - """OntologyObjectSetType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectApiName: NotRequired[ObjectTypeApiName] - - objectTypeApiName: NotRequired[ObjectTypeApiName] - - type: Literal["objectSet"] diff --git a/foundry/v2/models/_ontology_object_type.py b/foundry/v2/models/_ontology_object_type.py deleted file mode 100644 index 1fc61e05..00000000 --- a/foundry/v2/models/_ontology_object_type.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._ontology_object_type_dict import OntologyObjectTypeDict - - -class OntologyObjectType(BaseModel): - """OntologyObjectType""" - - object_api_name: ObjectTypeApiName = Field(alias="objectApiName") - - object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") - - type: Literal["object"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyObjectTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyObjectTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_ontology_object_type_dict.py b/foundry/v2/models/_ontology_object_type_dict.py deleted file mode 100644 index de01bce8..00000000 --- a/foundry/v2/models/_ontology_object_type_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName - - -class OntologyObjectTypeDict(TypedDict): - """OntologyObjectType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectApiName: ObjectTypeApiName - - objectTypeApiName: ObjectTypeApiName - - type: Literal["object"] diff --git a/foundry/v2/models/_ontology_object_v2.py b/foundry/v2/models/_ontology_object_v2.py deleted file mode 100644 index bcf8d000..00000000 --- a/foundry/v2/models/_ontology_object_v2.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict - -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._property_value import PropertyValue - -OntologyObjectV2 = Dict[PropertyApiName, PropertyValue] -"""Represents an object in the Ontology.""" diff --git a/foundry/v2/models/_ontology_v2.py b/foundry/v2/models/_ontology_v2.py deleted file mode 100644 index e98cca42..00000000 --- a/foundry/v2/models/_ontology_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._ontology_api_name import OntologyApiName -from foundry.v2.models._ontology_rid import OntologyRid -from foundry.v2.models._ontology_v2_dict import OntologyV2Dict - - -class OntologyV2(BaseModel): - """Metadata about an Ontology.""" - - api_name: OntologyApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - description: StrictStr - - rid: OntologyRid - - model_config = {"extra": "allow"} - - def to_dict(self) -> OntologyV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OntologyV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_ontology_v2_dict.py b/foundry/v2/models/_ontology_v2_dict.py deleted file mode 100644 index 3bf3aee6..00000000 --- a/foundry/v2/models/_ontology_v2_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import TypedDict - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._ontology_api_name import OntologyApiName -from foundry.v2.models._ontology_rid import OntologyRid - - -class OntologyV2Dict(TypedDict): - """Metadata about an Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: OntologyApiName - - displayName: DisplayName - - description: StrictStr - - rid: OntologyRid diff --git a/foundry/v2/models/_order_by_direction.py b/foundry/v2/models/_order_by_direction.py deleted file mode 100644 index e00563f6..00000000 --- a/foundry/v2/models/_order_by_direction.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -OrderByDirection = Literal["ASC", "DESC"] -"""OrderByDirection""" diff --git a/foundry/v2/models/_parameter.py b/foundry/v2/models/_parameter.py deleted file mode 100644 index bdce99b2..00000000 --- a/foundry/v2/models/_parameter.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool -from pydantic import StrictStr - -from foundry.v2.models._ontology_data_type import OntologyDataType -from foundry.v2.models._parameter_dict import ParameterDict -from foundry.v2.models._value_type import ValueType - - -class Parameter(BaseModel): - """Details about a parameter of an action or query.""" - - description: Optional[StrictStr] = None - - base_type: ValueType = Field(alias="baseType") - - data_type: Optional[OntologyDataType] = Field(alias="dataType", default=None) - - required: StrictBool - - model_config = {"extra": "allow"} - - def to_dict(self) -> ParameterDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ParameterDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_parameter_dict.py b/foundry/v2/models/_parameter_dict.py deleted file mode 100644 index 748a6faa..00000000 --- a/foundry/v2/models/_parameter_dict.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictBool -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._ontology_data_type_dict import OntologyDataTypeDict -from foundry.v2.models._value_type import ValueType - - -class ParameterDict(TypedDict): - """Details about a parameter of an action or query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: NotRequired[StrictStr] - - baseType: ValueType - - dataType: NotRequired[OntologyDataTypeDict] - - required: StrictBool diff --git a/foundry/v2/models/_parameter_evaluated_constraint.py b/foundry/v2/models/_parameter_evaluated_constraint.py deleted file mode 100644 index 521a2c48..00000000 --- a/foundry/v2/models/_parameter_evaluated_constraint.py +++ /dev/null @@ -1,67 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._array_size_constraint import ArraySizeConstraint -from foundry.v2.models._group_member_constraint import GroupMemberConstraint -from foundry.v2.models._object_property_value_constraint import ( - ObjectPropertyValueConstraint, -) # NOQA -from foundry.v2.models._object_query_result_constraint import ObjectQueryResultConstraint # NOQA -from foundry.v2.models._one_of_constraint import OneOfConstraint -from foundry.v2.models._range_constraint import RangeConstraint -from foundry.v2.models._string_length_constraint import StringLengthConstraint -from foundry.v2.models._string_regex_match_constraint import StringRegexMatchConstraint -from foundry.v2.models._unevaluable_constraint import UnevaluableConstraint - -ParameterEvaluatedConstraint = Annotated[ - Union[ - ArraySizeConstraint, - GroupMemberConstraint, - ObjectPropertyValueConstraint, - ObjectQueryResultConstraint, - OneOfConstraint, - RangeConstraint, - StringLengthConstraint, - StringRegexMatchConstraint, - UnevaluableConstraint, - ], - Field(discriminator="type"), -] -""" -A constraint that an action parameter value must satisfy in order to be considered valid. -Constraints can be configured on action parameters in the **Ontology Manager**. -Applicable constraints are determined dynamically based on parameter inputs. -Parameter values are evaluated against the final set of constraints. - -The type of the constraint. -| Type | Description | -|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | -| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | -| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | -| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | -| `oneOf` | The parameter has a manually predefined set of options. | -| `range` | The parameter value must be within the defined range. | -| `stringLength` | The parameter value must have a length within the defined range. | -| `stringRegexMatch` | The parameter value must match a predefined regular expression. | -| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | -""" diff --git a/foundry/v2/models/_parameter_evaluated_constraint_dict.py b/foundry/v2/models/_parameter_evaluated_constraint_dict.py deleted file mode 100644 index d2acccb2..00000000 --- a/foundry/v2/models/_parameter_evaluated_constraint_dict.py +++ /dev/null @@ -1,71 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._array_size_constraint_dict import ArraySizeConstraintDict -from foundry.v2.models._group_member_constraint_dict import GroupMemberConstraintDict -from foundry.v2.models._object_property_value_constraint_dict import ( - ObjectPropertyValueConstraintDict, -) # NOQA -from foundry.v2.models._object_query_result_constraint_dict import ( - ObjectQueryResultConstraintDict, -) # NOQA -from foundry.v2.models._one_of_constraint_dict import OneOfConstraintDict -from foundry.v2.models._range_constraint_dict import RangeConstraintDict -from foundry.v2.models._string_length_constraint_dict import StringLengthConstraintDict -from foundry.v2.models._string_regex_match_constraint_dict import ( - StringRegexMatchConstraintDict, -) # NOQA -from foundry.v2.models._unevaluable_constraint_dict import UnevaluableConstraintDict - -ParameterEvaluatedConstraintDict = Annotated[ - Union[ - ArraySizeConstraintDict, - GroupMemberConstraintDict, - ObjectPropertyValueConstraintDict, - ObjectQueryResultConstraintDict, - OneOfConstraintDict, - RangeConstraintDict, - StringLengthConstraintDict, - StringRegexMatchConstraintDict, - UnevaluableConstraintDict, - ], - Field(discriminator="type"), -] -""" -A constraint that an action parameter value must satisfy in order to be considered valid. -Constraints can be configured on action parameters in the **Ontology Manager**. -Applicable constraints are determined dynamically based on parameter inputs. -Parameter values are evaluated against the final set of constraints. - -The type of the constraint. -| Type | Description | -|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | -| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | -| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | -| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | -| `oneOf` | The parameter has a manually predefined set of options. | -| `range` | The parameter value must be within the defined range. | -| `stringLength` | The parameter value must have a length within the defined range. | -| `stringRegexMatch` | The parameter value must match a predefined regular expression. | -| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | -""" diff --git a/foundry/v2/models/_parameter_evaluation_result.py b/foundry/v2/models/_parameter_evaluation_result.py deleted file mode 100644 index bbde61e6..00000000 --- a/foundry/v2/models/_parameter_evaluation_result.py +++ /dev/null @@ -1,48 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool - -from foundry.v2.models._parameter_evaluated_constraint import ParameterEvaluatedConstraint # NOQA -from foundry.v2.models._parameter_evaluation_result_dict import ( - ParameterEvaluationResultDict, -) # NOQA -from foundry.v2.models._validation_result import ValidationResult - - -class ParameterEvaluationResult(BaseModel): - """Represents the validity of a parameter against the configured constraints.""" - - result: ValidationResult - - evaluated_constraints: List[ParameterEvaluatedConstraint] = Field(alias="evaluatedConstraints") - - required: StrictBool - """Represents whether the parameter is a required input to the action.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ParameterEvaluationResultDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ParameterEvaluationResultDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_parameter_evaluation_result_dict.py b/foundry/v2/models/_parameter_evaluation_result_dict.py deleted file mode 100644 index af8d6e8e..00000000 --- a/foundry/v2/models/_parameter_evaluation_result_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from pydantic import StrictBool -from typing_extensions import TypedDict - -from foundry.v2.models._parameter_evaluated_constraint_dict import ( - ParameterEvaluatedConstraintDict, -) # NOQA -from foundry.v2.models._validation_result import ValidationResult - - -class ParameterEvaluationResultDict(TypedDict): - """Represents the validity of a parameter against the configured constraints.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - result: ValidationResult - - evaluatedConstraints: List[ParameterEvaluatedConstraintDict] - - required: StrictBool - """Represents whether the parameter is a required input to the action.""" diff --git a/foundry/v2/models/_parameter_option.py b/foundry/v2/models/_parameter_option.py deleted file mode 100644 index 2019b597..00000000 --- a/foundry/v2/models/_parameter_option.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._parameter_option_dict import ParameterOptionDict - - -class ParameterOption(BaseModel): - """A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.""" - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - value: Optional[Any] = None - """An allowed configured value for a parameter within an action.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ParameterOptionDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ParameterOptionDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_parameter_option_dict.py b/foundry/v2/models/_parameter_option_dict.py deleted file mode 100644 index 7657707d..00000000 --- a/foundry/v2/models/_parameter_option_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._display_name import DisplayName - - -class ParameterOptionDict(TypedDict): - """A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - displayName: NotRequired[DisplayName] - - value: NotRequired[Any] - """An allowed configured value for a parameter within an action.""" diff --git a/foundry/v2/models/_phrase_query.py b/foundry/v2/models/_phrase_query.py deleted file mode 100644 index 3a964556..00000000 --- a/foundry/v2/models/_phrase_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._phrase_query_dict import PhraseQueryDict - - -class PhraseQuery(BaseModel): - """Returns objects where the specified field contains the provided value as a substring.""" - - field: FieldNameV1 - - value: StrictStr - - type: Literal["phrase"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> PhraseQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(PhraseQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_phrase_query_dict.py b/foundry/v2/models/_phrase_query_dict.py deleted file mode 100644 index b33476df..00000000 --- a/foundry/v2/models/_phrase_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import TypedDict - -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class PhraseQueryDict(TypedDict): - """Returns objects where the specified field contains the provided value as a substring.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: StrictStr - - type: Literal["phrase"] diff --git a/foundry/v2/models/_polygon.py b/foundry/v2/models/_polygon.py deleted file mode 100644 index bd3c8f2a..00000000 --- a/foundry/v2/models/_polygon.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._linear_ring import LinearRing -from foundry.v2.models._polygon_dict import PolygonDict - - -class Polygon(BaseModel): - """Polygon""" - - coordinates: List[LinearRing] - - bbox: Optional[BBox] = None - - type: Literal["Polygon"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> PolygonDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(PolygonDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_polygon_dict.py b/foundry/v2/models/_polygon_dict.py deleted file mode 100644 index a237b77a..00000000 --- a/foundry/v2/models/_polygon_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._b_box import BBox -from foundry.v2.models._linear_ring import LinearRing - - -class PolygonDict(TypedDict): - """Polygon""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - coordinates: List[LinearRing] - - bbox: NotRequired[BBox] - - type: Literal["Polygon"] diff --git a/foundry/v2/models/_polygon_value.py b/foundry/v2/models/_polygon_value.py deleted file mode 100644 index 1bd4086e..00000000 --- a/foundry/v2/models/_polygon_value.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v2.models._polygon import Polygon - -PolygonValue = Polygon -"""PolygonValue""" diff --git a/foundry/v2/models/_polygon_value_dict.py b/foundry/v2/models/_polygon_value_dict.py deleted file mode 100644 index f77ca529..00000000 --- a/foundry/v2/models/_polygon_value_dict.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v2.models._polygon_dict import PolygonDict - -PolygonValueDict = PolygonDict -"""PolygonValue""" diff --git a/foundry/v2/models/_position.py b/foundry/v2/models/_position.py deleted file mode 100644 index 2d0faed3..00000000 --- a/foundry/v2/models/_position.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from foundry.v2.models._coordinate import Coordinate - -Position = List[Coordinate] -""" -GeoJSon fundamental geometry construct. - -A position is an array of numbers. There MUST be two or more elements. -The first two elements are longitude and latitude, precisely in that order and using decimal numbers. -Altitude or elevation MAY be included as an optional third element. - -Implementations SHOULD NOT extend positions beyond three elements -because the semantics of extra elements are unspecified and ambiguous. -Historically, some implementations have used a fourth element to carry -a linear referencing measure (sometimes denoted as "M") or a numerical -timestamp, but in most situations a parser will not be able to properly -interpret these values. The interpretation and meaning of additional -elements is beyond the scope of this specification, and additional -elements MAY be ignored by parsers. -""" diff --git a/foundry/v2/models/_prefix_query.py b/foundry/v2/models/_prefix_query.py deleted file mode 100644 index 2dfd75d5..00000000 --- a/foundry/v2/models/_prefix_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._prefix_query_dict import PrefixQueryDict - - -class PrefixQuery(BaseModel): - """Returns objects where the specified field starts with the provided value.""" - - field: FieldNameV1 - - value: StrictStr - - type: Literal["prefix"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> PrefixQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(PrefixQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_prefix_query_dict.py b/foundry/v2/models/_prefix_query_dict.py deleted file mode 100644 index 0c164fce..00000000 --- a/foundry/v2/models/_prefix_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import TypedDict - -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class PrefixQueryDict(TypedDict): - """Returns objects where the specified field starts with the provided value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - value: StrictStr - - type: Literal["prefix"] diff --git a/foundry/v2/models/_primary_key_value.py b/foundry/v2/models/_primary_key_value.py deleted file mode 100644 index 2afd2acb..00000000 --- a/foundry/v2/models/_primary_key_value.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any - -PrimaryKeyValue = Any -"""Represents the primary key value that is used as a unique identifier for an object.""" diff --git a/foundry/v2/models/_project.py b/foundry/v2/models/_project.py deleted file mode 100644 index 391b65f7..00000000 --- a/foundry/v2/models/_project.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._project_dict import ProjectDict -from foundry.v2.models._project_rid import ProjectRid - - -class Project(BaseModel): - """Project""" - - rid: ProjectRid - - model_config = {"extra": "allow"} - - def to_dict(self) -> ProjectDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ProjectDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_project_dict.py b/foundry/v2/models/_project_dict.py deleted file mode 100644 index 045a2c29..00000000 --- a/foundry/v2/models/_project_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._project_rid import ProjectRid - - -class ProjectDict(TypedDict): - """Project""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ProjectRid diff --git a/foundry/v2/models/_property.py b/foundry/v2/models/_property.py deleted file mode 100644 index 1c2a070e..00000000 --- a/foundry/v2/models/_property.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._property_dict import PropertyDict -from foundry.v2.models._value_type import ValueType - - -class Property(BaseModel): - """Details about some property of an object.""" - - description: Optional[StrictStr] = None - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - base_type: ValueType = Field(alias="baseType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> PropertyDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(PropertyDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_property_dict.py b/foundry/v2/models/_property_dict.py deleted file mode 100644 index 2f582176..00000000 --- a/foundry/v2/models/_property_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._value_type import ValueType - - -class PropertyDict(TypedDict): - """Details about some property of an object.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: NotRequired[StrictStr] - - displayName: NotRequired[DisplayName] - - baseType: ValueType diff --git a/foundry/v2/models/_property_filter.py b/foundry/v2/models/_property_filter.py deleted file mode 100644 index 37e776de..00000000 --- a/foundry/v2/models/_property_filter.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -PropertyFilter = StrictStr -""" -Represents a filter used on properties. - -Endpoints that accept this supports optional parameters that have the form: -`properties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString}` to filter the returned objects. -For instance, you may use `properties.firstName.eq=John` to find objects that contain a property called -"firstName" that has the exact value of "John". - -The following are a list of supported property filters: - -- `properties.{propertyApiName}.contains` - supported on arrays and can be used to filter array properties - that have at least one of the provided values. If multiple query parameters are provided, then objects - that have any of the given values for the specified property will be matched. -- `properties.{propertyApiName}.eq` - used to filter objects that have the exact value for the provided - property. If multiple query parameters are provided, then objects that have any of the given values - will be matched. For instance, if the user provides a request by doing - `?properties.firstName.eq=John&properties.firstName.eq=Anna`, then objects that have a firstName property - of either John or Anna will be matched. This filter is supported on all property types except Arrays. -- `properties.{propertyApiName}.neq` - used to filter objects that do not have the provided property values. - Similar to the `eq` filter, if multiple values are provided, then objects that have any of the given values - will be excluded from the result. -- `properties.{propertyApiName}.lt`, `properties.{propertyApiName}.lte`, `properties.{propertyApiName}.gt` - `properties.{propertyApiName}.gte` - represent less than, less than or equal to, greater than, and greater - than or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal. -- `properties.{propertyApiName}.isNull` - used to filter objects where the provided property is (or is not) null. - This filter is supported on all property types. -""" diff --git a/foundry/v2/models/_property_id.py b/foundry/v2/models/_property_id.py deleted file mode 100644 index d2eef827..00000000 --- a/foundry/v2/models/_property_id.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -PropertyId = StrictStr -""" -The immutable ID of a property. Property IDs are only used to identify properties in the **Ontology Manager** -application and assign them API names. In every other case, API names should be used instead of property IDs. -""" diff --git a/foundry/v2/models/_property_v2.py b/foundry/v2/models/_property_v2.py deleted file mode 100644 index 668182e2..00000000 --- a/foundry/v2/models/_property_v2.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._object_property_type import ObjectPropertyType -from foundry.v2.models._property_v2_dict import PropertyV2Dict - - -class PropertyV2(BaseModel): - """Details about some property of an object.""" - - description: Optional[StrictStr] = None - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - data_type: ObjectPropertyType = Field(alias="dataType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> PropertyV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(PropertyV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_property_v2_dict.py b/foundry/v2/models/_property_v2_dict.py deleted file mode 100644 index 7f5ecfbc..00000000 --- a/foundry/v2/models/_property_v2_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._object_property_type_dict import ObjectPropertyTypeDict - - -class PropertyV2Dict(TypedDict): - """Details about some property of an object.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: NotRequired[StrictStr] - - displayName: NotRequired[DisplayName] - - dataType: ObjectPropertyTypeDict diff --git a/foundry/v2/models/_qos_error.py b/foundry/v2/models/_qos_error.py deleted file mode 100644 index 9f612c5a..00000000 --- a/foundry/v2/models/_qos_error.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._qos_error_dict import QosErrorDict - - -class QosError(BaseModel): - """An error indicating that the subscribe request should be attempted on a different node.""" - - type: Literal["qos"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QosErrorDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QosErrorDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_qos_error_dict.py b/foundry/v2/models/_qos_error_dict.py deleted file mode 100644 index 36ae0c72..00000000 --- a/foundry/v2/models/_qos_error_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - - -class QosErrorDict(TypedDict): - """An error indicating that the subscribe request should be attempted on a different node.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - type: Literal["qos"] diff --git a/foundry/v2/models/_query_aggregation.py b/foundry/v2/models/_query_aggregation.py deleted file mode 100644 index 98903cb6..00000000 --- a/foundry/v2/models/_query_aggregation.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._query_aggregation_dict import QueryAggregationDict - - -class QueryAggregation(BaseModel): - """QueryAggregation""" - - key: Any - - value: Any - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryAggregationDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_query_aggregation_dict.py b/foundry/v2/models/_query_aggregation_dict.py deleted file mode 100644 index 53ddcfeb..00000000 --- a/foundry/v2/models/_query_aggregation_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any - -from typing_extensions import TypedDict - - -class QueryAggregationDict(TypedDict): - """QueryAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - key: Any - - value: Any diff --git a/foundry/v2/models/_query_aggregation_key_type.py b/foundry/v2/models/_query_aggregation_key_type.py deleted file mode 100644 index 327cc1bf..00000000 --- a/foundry/v2/models/_query_aggregation_key_type.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._boolean_type import BooleanType -from foundry.v2.models._date_type import DateType -from foundry.v2.models._double_type import DoubleType -from foundry.v2.models._integer_type import IntegerType -from foundry.v2.models._query_aggregation_range_type import QueryAggregationRangeType -from foundry.v2.models._string_type import StringType -from foundry.v2.models._timestamp_type import TimestampType - -QueryAggregationKeyType = Annotated[ - Union[ - BooleanType, - DateType, - DoubleType, - IntegerType, - StringType, - TimestampType, - QueryAggregationRangeType, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by query aggregation keys.""" diff --git a/foundry/v2/models/_query_aggregation_key_type_dict.py b/foundry/v2/models/_query_aggregation_key_type_dict.py deleted file mode 100644 index ac646926..00000000 --- a/foundry/v2/models/_query_aggregation_key_type_dict.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._boolean_type_dict import BooleanTypeDict -from foundry.v2.models._date_type_dict import DateTypeDict -from foundry.v2.models._double_type_dict import DoubleTypeDict -from foundry.v2.models._integer_type_dict import IntegerTypeDict -from foundry.v2.models._query_aggregation_range_type_dict import ( - QueryAggregationRangeTypeDict, -) # NOQA -from foundry.v2.models._string_type_dict import StringTypeDict -from foundry.v2.models._timestamp_type_dict import TimestampTypeDict - -QueryAggregationKeyTypeDict = Annotated[ - Union[ - BooleanTypeDict, - DateTypeDict, - DoubleTypeDict, - IntegerTypeDict, - StringTypeDict, - TimestampTypeDict, - QueryAggregationRangeTypeDict, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by query aggregation keys.""" diff --git a/foundry/v2/models/_query_aggregation_range.py b/foundry/v2/models/_query_aggregation_range.py deleted file mode 100644 index 749c7579..00000000 --- a/foundry/v2/models/_query_aggregation_range.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._query_aggregation_range_dict import QueryAggregationRangeDict - - -class QueryAggregationRange(BaseModel): - """Specifies a range from an inclusive start value to an exclusive end value.""" - - start_value: Optional[Any] = Field(alias="startValue", default=None) - """Inclusive start.""" - - end_value: Optional[Any] = Field(alias="endValue", default=None) - """Exclusive end.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryAggregationRangeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryAggregationRangeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_query_aggregation_range_dict.py b/foundry/v2/models/_query_aggregation_range_dict.py deleted file mode 100644 index 3072f4b7..00000000 --- a/foundry/v2/models/_query_aggregation_range_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - - -class QueryAggregationRangeDict(TypedDict): - """Specifies a range from an inclusive start value to an exclusive end value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - startValue: NotRequired[Any] - """Inclusive start.""" - - endValue: NotRequired[Any] - """Exclusive end.""" diff --git a/foundry/v2/models/_query_aggregation_range_sub_type.py b/foundry/v2/models/_query_aggregation_range_sub_type.py deleted file mode 100644 index c2d90b6d..00000000 --- a/foundry/v2/models/_query_aggregation_range_sub_type.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._date_type import DateType -from foundry.v2.models._double_type import DoubleType -from foundry.v2.models._integer_type import IntegerType -from foundry.v2.models._timestamp_type import TimestampType - -QueryAggregationRangeSubType = Annotated[ - Union[DateType, DoubleType, IntegerType, TimestampType], Field(discriminator="type") -] -"""A union of all the types supported by query aggregation ranges.""" diff --git a/foundry/v2/models/_query_aggregation_range_sub_type_dict.py b/foundry/v2/models/_query_aggregation_range_sub_type_dict.py deleted file mode 100644 index 5448f871..00000000 --- a/foundry/v2/models/_query_aggregation_range_sub_type_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._date_type_dict import DateTypeDict -from foundry.v2.models._double_type_dict import DoubleTypeDict -from foundry.v2.models._integer_type_dict import IntegerTypeDict -from foundry.v2.models._timestamp_type_dict import TimestampTypeDict - -QueryAggregationRangeSubTypeDict = Annotated[ - Union[DateTypeDict, DoubleTypeDict, IntegerTypeDict, TimestampTypeDict], - Field(discriminator="type"), -] -"""A union of all the types supported by query aggregation ranges.""" diff --git a/foundry/v2/models/_query_aggregation_range_type.py b/foundry/v2/models/_query_aggregation_range_type.py deleted file mode 100644 index ee6ea89d..00000000 --- a/foundry/v2/models/_query_aggregation_range_type.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._query_aggregation_range_sub_type import QueryAggregationRangeSubType # NOQA -from foundry.v2.models._query_aggregation_range_type_dict import ( - QueryAggregationRangeTypeDict, -) # NOQA - - -class QueryAggregationRangeType(BaseModel): - """QueryAggregationRangeType""" - - sub_type: QueryAggregationRangeSubType = Field(alias="subType") - - type: Literal["range"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryAggregationRangeTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - QueryAggregationRangeTypeDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_query_aggregation_range_type_dict.py b/foundry/v2/models/_query_aggregation_range_type_dict.py deleted file mode 100644 index eae1f752..00000000 --- a/foundry/v2/models/_query_aggregation_range_type_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._query_aggregation_range_sub_type_dict import ( - QueryAggregationRangeSubTypeDict, -) # NOQA - - -class QueryAggregationRangeTypeDict(TypedDict): - """QueryAggregationRangeType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: QueryAggregationRangeSubTypeDict - - type: Literal["range"] diff --git a/foundry/v2/models/_query_aggregation_value_type.py b/foundry/v2/models/_query_aggregation_value_type.py deleted file mode 100644 index 89204695..00000000 --- a/foundry/v2/models/_query_aggregation_value_type.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._date_type import DateType -from foundry.v2.models._double_type import DoubleType -from foundry.v2.models._timestamp_type import TimestampType - -QueryAggregationValueType = Annotated[ - Union[DateType, DoubleType, TimestampType], Field(discriminator="type") -] -"""A union of all the types supported by query aggregation keys.""" diff --git a/foundry/v2/models/_query_aggregation_value_type_dict.py b/foundry/v2/models/_query_aggregation_value_type_dict.py deleted file mode 100644 index 1dfe69ac..00000000 --- a/foundry/v2/models/_query_aggregation_value_type_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._date_type_dict import DateTypeDict -from foundry.v2.models._double_type_dict import DoubleTypeDict -from foundry.v2.models._timestamp_type_dict import TimestampTypeDict - -QueryAggregationValueTypeDict = Annotated[ - Union[DateTypeDict, DoubleTypeDict, TimestampTypeDict], Field(discriminator="type") -] -"""A union of all the types supported by query aggregation keys.""" diff --git a/foundry/v2/models/_query_data_type.py b/foundry/v2/models/_query_data_type.py deleted file mode 100644 index 74e007e5..00000000 --- a/foundry/v2/models/_query_data_type.py +++ /dev/null @@ -1,144 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._attachment_type import AttachmentType -from foundry.v2.models._boolean_type import BooleanType -from foundry.v2.models._date_type import DateType -from foundry.v2.models._double_type import DoubleType -from foundry.v2.models._float_type import FloatType -from foundry.v2.models._integer_type import IntegerType -from foundry.v2.models._long_type import LongType -from foundry.v2.models._null_type import NullType -from foundry.v2.models._ontology_object_set_type import OntologyObjectSetType -from foundry.v2.models._ontology_object_type import OntologyObjectType -from foundry.v2.models._query_data_type_dict import QueryArrayTypeDict -from foundry.v2.models._query_data_type_dict import QuerySetTypeDict -from foundry.v2.models._query_data_type_dict import QueryStructFieldDict -from foundry.v2.models._query_data_type_dict import QueryStructTypeDict -from foundry.v2.models._query_data_type_dict import QueryUnionTypeDict -from foundry.v2.models._string_type import StringType -from foundry.v2.models._struct_field_name import StructFieldName -from foundry.v2.models._three_dimensional_aggregation import ThreeDimensionalAggregation -from foundry.v2.models._timestamp_type import TimestampType -from foundry.v2.models._two_dimensional_aggregation import TwoDimensionalAggregation -from foundry.v2.models._unsupported_type import UnsupportedType - - -class QueryArrayType(BaseModel): - """QueryArrayType""" - - sub_type: QueryDataType = Field(alias="subType") - - type: Literal["array"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryArrayTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class QuerySetType(BaseModel): - """QuerySetType""" - - sub_type: QueryDataType = Field(alias="subType") - - type: Literal["set"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QuerySetTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QuerySetTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class QueryStructField(BaseModel): - """QueryStructField""" - - name: StructFieldName - - field_type: QueryDataType = Field(alias="fieldType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryStructFieldDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryStructFieldDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class QueryStructType(BaseModel): - """QueryStructType""" - - fields: List[QueryStructField] - - type: Literal["struct"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryStructTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryStructTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class QueryUnionType(BaseModel): - """QueryUnionType""" - - union_types: List[QueryDataType] = Field(alias="unionTypes") - - type: Literal["union"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryUnionTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryUnionTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -QueryDataType = Annotated[ - Union[ - QueryArrayType, - AttachmentType, - BooleanType, - DateType, - DoubleType, - FloatType, - IntegerType, - LongType, - OntologyObjectSetType, - OntologyObjectType, - QuerySetType, - StringType, - QueryStructType, - ThreeDimensionalAggregation, - TimestampType, - TwoDimensionalAggregation, - QueryUnionType, - NullType, - UnsupportedType, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Query parameters or outputs.""" diff --git a/foundry/v2/models/_query_data_type_dict.py b/foundry/v2/models/_query_data_type_dict.py deleted file mode 100644 index 66393fb9..00000000 --- a/foundry/v2/models/_query_data_type_dict.py +++ /dev/null @@ -1,122 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import TypedDict - -from foundry.v2.models._attachment_type_dict import AttachmentTypeDict -from foundry.v2.models._boolean_type_dict import BooleanTypeDict -from foundry.v2.models._date_type_dict import DateTypeDict -from foundry.v2.models._double_type_dict import DoubleTypeDict -from foundry.v2.models._float_type_dict import FloatTypeDict -from foundry.v2.models._integer_type_dict import IntegerTypeDict -from foundry.v2.models._long_type_dict import LongTypeDict -from foundry.v2.models._null_type_dict import NullTypeDict -from foundry.v2.models._ontology_object_set_type_dict import OntologyObjectSetTypeDict -from foundry.v2.models._ontology_object_type_dict import OntologyObjectTypeDict -from foundry.v2.models._string_type_dict import StringTypeDict -from foundry.v2.models._struct_field_name import StructFieldName -from foundry.v2.models._three_dimensional_aggregation_dict import ( - ThreeDimensionalAggregationDict, -) # NOQA -from foundry.v2.models._timestamp_type_dict import TimestampTypeDict -from foundry.v2.models._two_dimensional_aggregation_dict import ( - TwoDimensionalAggregationDict, -) # NOQA -from foundry.v2.models._unsupported_type_dict import UnsupportedTypeDict - - -class QueryArrayTypeDict(TypedDict): - """QueryArrayType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: QueryDataTypeDict - - type: Literal["array"] - - -class QuerySetTypeDict(TypedDict): - """QuerySetType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - subType: QueryDataTypeDict - - type: Literal["set"] - - -class QueryStructFieldDict(TypedDict): - """QueryStructField""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - name: StructFieldName - - fieldType: QueryDataTypeDict - - -class QueryStructTypeDict(TypedDict): - """QueryStructType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: List[QueryStructFieldDict] - - type: Literal["struct"] - - -class QueryUnionTypeDict(TypedDict): - """QueryUnionType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - unionTypes: List[QueryDataTypeDict] - - type: Literal["union"] - - -QueryDataTypeDict = Annotated[ - Union[ - QueryArrayTypeDict, - AttachmentTypeDict, - BooleanTypeDict, - DateTypeDict, - DoubleTypeDict, - FloatTypeDict, - IntegerTypeDict, - LongTypeDict, - OntologyObjectSetTypeDict, - OntologyObjectTypeDict, - QuerySetTypeDict, - StringTypeDict, - QueryStructTypeDict, - ThreeDimensionalAggregationDict, - TimestampTypeDict, - TwoDimensionalAggregationDict, - QueryUnionTypeDict, - NullTypeDict, - UnsupportedTypeDict, - ], - Field(discriminator="type"), -] -"""A union of all the types supported by Ontology Query parameters or outputs.""" diff --git a/foundry/v2/models/_query_output_v2.py b/foundry/v2/models/_query_output_v2.py deleted file mode 100644 index 719028e3..00000000 --- a/foundry/v2/models/_query_output_v2.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool - -from foundry.v2.models._query_data_type import QueryDataType -from foundry.v2.models._query_output_v2_dict import QueryOutputV2Dict - - -class QueryOutputV2(BaseModel): - """Details about the output of a query.""" - - data_type: QueryDataType = Field(alias="dataType") - - required: StrictBool - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryOutputV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryOutputV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_query_output_v2_dict.py b/foundry/v2/models/_query_output_v2_dict.py deleted file mode 100644 index 7b826260..00000000 --- a/foundry/v2/models/_query_output_v2_dict.py +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictBool -from typing_extensions import TypedDict - -from foundry.v2.models._query_data_type_dict import QueryDataTypeDict - - -class QueryOutputV2Dict(TypedDict): - """Details about the output of a query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - dataType: QueryDataTypeDict - - required: StrictBool diff --git a/foundry/v2/models/_query_parameter_v2.py b/foundry/v2/models/_query_parameter_v2.py deleted file mode 100644 index 966d3f32..00000000 --- a/foundry/v2/models/_query_parameter_v2.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._query_data_type import QueryDataType -from foundry.v2.models._query_parameter_v2_dict import QueryParameterV2Dict - - -class QueryParameterV2(BaseModel): - """Details about a parameter of a query.""" - - description: Optional[StrictStr] = None - - data_type: QueryDataType = Field(alias="dataType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryParameterV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryParameterV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_query_parameter_v2_dict.py b/foundry/v2/models/_query_parameter_v2_dict.py deleted file mode 100644 index 3172854c..00000000 --- a/foundry/v2/models/_query_parameter_v2_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._query_data_type_dict import QueryDataTypeDict - - -class QueryParameterV2Dict(TypedDict): - """Details about a parameter of a query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - description: NotRequired[StrictStr] - - dataType: QueryDataTypeDict diff --git a/foundry/v2/models/_query_runtime_error_parameter.py b/foundry/v2/models/_query_runtime_error_parameter.py deleted file mode 100644 index 2b9d557d..00000000 --- a/foundry/v2/models/_query_runtime_error_parameter.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -QueryRuntimeErrorParameter = StrictStr -"""QueryRuntimeErrorParameter""" diff --git a/foundry/v2/models/_query_three_dimensional_aggregation.py b/foundry/v2/models/_query_three_dimensional_aggregation.py deleted file mode 100644 index 55a92dad..00000000 --- a/foundry/v2/models/_query_three_dimensional_aggregation.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._nested_query_aggregation import NestedQueryAggregation -from foundry.v2.models._query_three_dimensional_aggregation_dict import ( - QueryThreeDimensionalAggregationDict, -) # NOQA - - -class QueryThreeDimensionalAggregation(BaseModel): - """QueryThreeDimensionalAggregation""" - - groups: List[NestedQueryAggregation] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryThreeDimensionalAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - QueryThreeDimensionalAggregationDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_query_three_dimensional_aggregation_dict.py b/foundry/v2/models/_query_three_dimensional_aggregation_dict.py deleted file mode 100644 index 8819dd01..00000000 --- a/foundry/v2/models/_query_three_dimensional_aggregation_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._nested_query_aggregation_dict import NestedQueryAggregationDict - - -class QueryThreeDimensionalAggregationDict(TypedDict): - """QueryThreeDimensionalAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - groups: List[NestedQueryAggregationDict] diff --git a/foundry/v2/models/_query_two_dimensional_aggregation.py b/foundry/v2/models/_query_two_dimensional_aggregation.py deleted file mode 100644 index 17401f8a..00000000 --- a/foundry/v2/models/_query_two_dimensional_aggregation.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._query_aggregation import QueryAggregation -from foundry.v2.models._query_two_dimensional_aggregation_dict import ( - QueryTwoDimensionalAggregationDict, -) # NOQA - - -class QueryTwoDimensionalAggregation(BaseModel): - """QueryTwoDimensionalAggregation""" - - groups: List[QueryAggregation] - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryTwoDimensionalAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - QueryTwoDimensionalAggregationDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_query_two_dimensional_aggregation_dict.py b/foundry/v2/models/_query_two_dimensional_aggregation_dict.py deleted file mode 100644 index 2805c67a..00000000 --- a/foundry/v2/models/_query_two_dimensional_aggregation_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._query_aggregation_dict import QueryAggregationDict - - -class QueryTwoDimensionalAggregationDict(TypedDict): - """QueryTwoDimensionalAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - groups: List[QueryAggregationDict] diff --git a/foundry/v2/models/_query_type.py b/foundry/v2/models/_query_type.py deleted file mode 100644 index 47f5b63c..00000000 --- a/foundry/v2/models/_query_type.py +++ /dev/null @@ -1,57 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._function_rid import FunctionRid -from foundry.v2.models._function_version import FunctionVersion -from foundry.v2.models._ontology_data_type import OntologyDataType -from foundry.v2.models._parameter import Parameter -from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._query_api_name import QueryApiName -from foundry.v2.models._query_type_dict import QueryTypeDict - - -class QueryType(BaseModel): - """Represents a query type in the Ontology.""" - - api_name: QueryApiName = Field(alias="apiName") - - description: Optional[StrictStr] = None - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - parameters: Dict[ParameterId, Parameter] - - output: Optional[OntologyDataType] = None - - rid: FunctionRid - - version: FunctionVersion - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_query_type_dict.py b/foundry/v2/models/_query_type_dict.py deleted file mode 100644 index e8b421d6..00000000 --- a/foundry/v2/models/_query_type_dict.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._function_rid import FunctionRid -from foundry.v2.models._function_version import FunctionVersion -from foundry.v2.models._ontology_data_type_dict import OntologyDataTypeDict -from foundry.v2.models._parameter_dict import ParameterDict -from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._query_api_name import QueryApiName - - -class QueryTypeDict(TypedDict): - """Represents a query type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: QueryApiName - - description: NotRequired[StrictStr] - - displayName: NotRequired[DisplayName] - - parameters: Dict[ParameterId, ParameterDict] - - output: NotRequired[OntologyDataTypeDict] - - rid: FunctionRid - - version: FunctionVersion diff --git a/foundry/v2/models/_query_type_v2.py b/foundry/v2/models/_query_type_v2.py deleted file mode 100644 index 107d99a9..00000000 --- a/foundry/v2/models/_query_type_v2.py +++ /dev/null @@ -1,57 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._function_rid import FunctionRid -from foundry.v2.models._function_version import FunctionVersion -from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._query_api_name import QueryApiName -from foundry.v2.models._query_data_type import QueryDataType -from foundry.v2.models._query_parameter_v2 import QueryParameterV2 -from foundry.v2.models._query_type_v2_dict import QueryTypeV2Dict - - -class QueryTypeV2(BaseModel): - """Represents a query type in the Ontology.""" - - api_name: QueryApiName = Field(alias="apiName") - - description: Optional[StrictStr] = None - - display_name: Optional[DisplayName] = Field(alias="displayName", default=None) - - parameters: Dict[ParameterId, QueryParameterV2] - - output: QueryDataType - - rid: FunctionRid - - version: FunctionVersion - - model_config = {"extra": "allow"} - - def to_dict(self) -> QueryTypeV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(QueryTypeV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_query_type_v2_dict.py b/foundry/v2/models/_query_type_v2_dict.py deleted file mode 100644 index 881145e6..00000000 --- a/foundry/v2/models/_query_type_v2_dict.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._function_rid import FunctionRid -from foundry.v2.models._function_version import FunctionVersion -from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._query_api_name import QueryApiName -from foundry.v2.models._query_data_type_dict import QueryDataTypeDict -from foundry.v2.models._query_parameter_v2_dict import QueryParameterV2Dict - - -class QueryTypeV2Dict(TypedDict): - """Represents a query type in the Ontology.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - apiName: QueryApiName - - description: NotRequired[StrictStr] - - displayName: NotRequired[DisplayName] - - parameters: Dict[ParameterId, QueryParameterV2Dict] - - output: QueryDataTypeDict - - rid: FunctionRid - - version: FunctionVersion diff --git a/foundry/v2/models/_range_constraint.py b/foundry/v2/models/_range_constraint.py deleted file mode 100644 index 00f1c1c9..00000000 --- a/foundry/v2/models/_range_constraint.py +++ /dev/null @@ -1,49 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._range_constraint_dict import RangeConstraintDict - - -class RangeConstraint(BaseModel): - """The parameter value must be within the defined range.""" - - lt: Optional[Any] = None - """Less than""" - - lte: Optional[Any] = None - """Less than or equal""" - - gt: Optional[Any] = None - """Greater than""" - - gte: Optional[Any] = None - """Greater than or equal""" - - type: Literal["range"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> RangeConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(RangeConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_reason.py b/foundry/v2/models/_reason.py deleted file mode 100644 index 000bc6d3..00000000 --- a/foundry/v2/models/_reason.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._reason_dict import ReasonDict -from foundry.v2.models._reason_type import ReasonType - - -class Reason(BaseModel): - """Reason""" - - reason: ReasonType - - type: Literal["reason"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ReasonDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ReasonDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_reason_dict.py b/foundry/v2/models/_reason_dict.py deleted file mode 100644 index ca42f35d..00000000 --- a/foundry/v2/models/_reason_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._reason_type import ReasonType - - -class ReasonDict(TypedDict): - """Reason""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - reason: ReasonType - - type: Literal["reason"] diff --git a/foundry/v2/models/_reason_type.py b/foundry/v2/models/_reason_type.py deleted file mode 100644 index c388db7e..00000000 --- a/foundry/v2/models/_reason_type.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -ReasonType = Literal["USER_CLOSED", "CHANNEL_CLOSED"] -"""Represents the reason a subscription was closed.""" diff --git a/foundry/v2/models/_reference_update.py b/foundry/v2/models/_reference_update.py deleted file mode 100644 index 8a4060ba..00000000 --- a/foundry/v2/models/_reference_update.py +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._object_primary_key import ObjectPrimaryKey -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._reference_update_dict import ReferenceUpdateDict -from foundry.v2.models._reference_value import ReferenceValue - - -class ReferenceUpdate(BaseModel): - """ - The updated data value associated with an object instance's external reference. The object instance - is uniquely identified by an object type and a primary key. Note that the value of the property - field returns a dereferenced value rather than the reference itself. - """ - - object_type: ObjectTypeApiName = Field(alias="objectType") - - primary_key: ObjectPrimaryKey = Field(alias="primaryKey") - - property: PropertyApiName - - value: ReferenceValue - - type: Literal["reference"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ReferenceUpdateDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ReferenceUpdateDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_reference_update_dict.py b/foundry/v2/models/_reference_update_dict.py deleted file mode 100644 index 16e78cd4..00000000 --- a/foundry/v2/models/_reference_update_dict.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._object_primary_key import ObjectPrimaryKey -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._reference_value_dict import ReferenceValueDict - - -class ReferenceUpdateDict(TypedDict): - """ - The updated data value associated with an object instance's external reference. The object instance - is uniquely identified by an object type and a primary key. Note that the value of the property - field returns a dereferenced value rather than the reference itself. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - objectType: ObjectTypeApiName - - primaryKey: ObjectPrimaryKey - - property: PropertyApiName - - value: ReferenceValueDict - - type: Literal["reference"] diff --git a/foundry/v2/models/_reference_value.py b/foundry/v2/models/_reference_value.py deleted file mode 100644 index 751e2c32..00000000 --- a/foundry/v2/models/_reference_value.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v2.models._geotime_series_value import GeotimeSeriesValue - -ReferenceValue = GeotimeSeriesValue -"""Resolved data values pointed to by a reference.""" diff --git a/foundry/v2/models/_reference_value_dict.py b/foundry/v2/models/_reference_value_dict.py deleted file mode 100644 index 27b6eef6..00000000 --- a/foundry/v2/models/_reference_value_dict.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v2.models._geotime_series_value_dict import GeotimeSeriesValueDict - -ReferenceValueDict = GeotimeSeriesValueDict -"""Resolved data values pointed to by a reference.""" diff --git a/foundry/v2/models/_refresh_object_set.py b/foundry/v2/models/_refresh_object_set.py deleted file mode 100644 index 2d935a86..00000000 --- a/foundry/v2/models/_refresh_object_set.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._refresh_object_set_dict import RefreshObjectSetDict -from foundry.v2.models._subscription_id import SubscriptionId - - -class RefreshObjectSet(BaseModel): - """The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service.""" - - id: SubscriptionId - - object_type: ObjectTypeApiName = Field(alias="objectType") - - type: Literal["refreshObjectSet"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> RefreshObjectSetDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(RefreshObjectSetDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_refresh_object_set_dict.py b/foundry/v2/models/_refresh_object_set_dict.py deleted file mode 100644 index f7a1b277..00000000 --- a/foundry/v2/models/_refresh_object_set_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._subscription_id import SubscriptionId - - -class RefreshObjectSetDict(TypedDict): - """The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - id: SubscriptionId - - objectType: ObjectTypeApiName - - type: Literal["refreshObjectSet"] diff --git a/foundry/v2/models/_relative_time.py b/foundry/v2/models/_relative_time.py deleted file mode 100644 index f8cb5264..00000000 --- a/foundry/v2/models/_relative_time.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictInt - -from foundry.v2.models._relative_time_dict import RelativeTimeDict -from foundry.v2.models._relative_time_relation import RelativeTimeRelation -from foundry.v2.models._relative_time_series_time_unit import RelativeTimeSeriesTimeUnit - - -class RelativeTime(BaseModel): - """A relative time, such as "3 days before" or "2 hours after" the current moment.""" - - when: RelativeTimeRelation - - value: StrictInt - - unit: RelativeTimeSeriesTimeUnit - - model_config = {"extra": "allow"} - - def to_dict(self) -> RelativeTimeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(RelativeTimeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_relative_time_dict.py b/foundry/v2/models/_relative_time_dict.py deleted file mode 100644 index 537df4f8..00000000 --- a/foundry/v2/models/_relative_time_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictInt -from typing_extensions import TypedDict - -from foundry.v2.models._relative_time_relation import RelativeTimeRelation -from foundry.v2.models._relative_time_series_time_unit import RelativeTimeSeriesTimeUnit - - -class RelativeTimeDict(TypedDict): - """A relative time, such as "3 days before" or "2 hours after" the current moment.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - when: RelativeTimeRelation - - value: StrictInt - - unit: RelativeTimeSeriesTimeUnit diff --git a/foundry/v2/models/_relative_time_range.py b/foundry/v2/models/_relative_time_range.py deleted file mode 100644 index a5a3817a..00000000 --- a/foundry/v2/models/_relative_time_range.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._relative_time import RelativeTime -from foundry.v2.models._relative_time_range_dict import RelativeTimeRangeDict - - -class RelativeTimeRange(BaseModel): - """A relative time range for a time series query.""" - - start_time: Optional[RelativeTime] = Field(alias="startTime", default=None) - - end_time: Optional[RelativeTime] = Field(alias="endTime", default=None) - - type: Literal["relative"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> RelativeTimeRangeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(RelativeTimeRangeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_relative_time_range_dict.py b/foundry/v2/models/_relative_time_range_dict.py deleted file mode 100644 index e3b060f3..00000000 --- a/foundry/v2/models/_relative_time_range_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._relative_time_dict import RelativeTimeDict - - -class RelativeTimeRangeDict(TypedDict): - """A relative time range for a time series query.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - startTime: NotRequired[RelativeTimeDict] - - endTime: NotRequired[RelativeTimeDict] - - type: Literal["relative"] diff --git a/foundry/v2/models/_relative_time_relation.py b/foundry/v2/models/_relative_time_relation.py deleted file mode 100644 index 44aa08b5..00000000 --- a/foundry/v2/models/_relative_time_relation.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -RelativeTimeRelation = Literal["BEFORE", "AFTER"] -"""RelativeTimeRelation""" diff --git a/foundry/v2/models/_relative_time_series_time_unit.py b/foundry/v2/models/_relative_time_series_time_unit.py deleted file mode 100644 index fc9f2ef5..00000000 --- a/foundry/v2/models/_relative_time_series_time_unit.py +++ /dev/null @@ -1,23 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -RelativeTimeSeriesTimeUnit = Literal[ - "MILLISECONDS", "SECONDS", "MINUTES", "HOURS", "DAYS", "WEEKS", "MONTHS", "YEARS" -] -"""RelativeTimeSeriesTimeUnit""" diff --git a/foundry/v2/models/_remove_group_members_request.py b/foundry/v2/models/_remove_group_members_request.py deleted file mode 100644 index 0ff234b2..00000000 --- a/foundry/v2/models/_remove_group_members_request.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._principal_id import PrincipalId -from foundry.v2.models._remove_group_members_request_dict import ( - RemoveGroupMembersRequestDict, -) # NOQA - - -class RemoveGroupMembersRequest(BaseModel): - """RemoveGroupMembersRequest""" - - principal_ids: List[PrincipalId] = Field(alias="principalIds") - - model_config = {"extra": "allow"} - - def to_dict(self) -> RemoveGroupMembersRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - RemoveGroupMembersRequestDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_remove_group_members_request_dict.py b/foundry/v2/models/_remove_group_members_request_dict.py deleted file mode 100644 index 2a514415..00000000 --- a/foundry/v2/models/_remove_group_members_request_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._principal_id import PrincipalId - - -class RemoveGroupMembersRequestDict(TypedDict): - """RemoveGroupMembersRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - principalIds: List[PrincipalId] diff --git a/foundry/v2/models/_request_id.py b/foundry/v2/models/_request_id.py deleted file mode 100644 index c6fb7855..00000000 --- a/foundry/v2/models/_request_id.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import UUID - -RequestId = UUID -"""Unique request id""" diff --git a/foundry/v2/models/_resource.py b/foundry/v2/models/_resource.py deleted file mode 100644 index 98179ca3..00000000 --- a/foundry/v2/models/_resource.py +++ /dev/null @@ -1,97 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._created_by import CreatedBy -from foundry.v2.models._created_time import CreatedTime -from foundry.v2.models._folder_rid import FolderRid -from foundry.v2.models._project_rid import ProjectRid -from foundry.v2.models._resource_dict import ResourceDict -from foundry.v2.models._resource_display_name import ResourceDisplayName -from foundry.v2.models._resource_path import ResourcePath -from foundry.v2.models._resource_rid import ResourceRid -from foundry.v2.models._resource_type import ResourceType -from foundry.v2.models._space_rid import SpaceRid -from foundry.v2.models._trashed_status import TrashedStatus -from foundry.v2.models._updated_by import UpdatedBy -from foundry.v2.models._updated_time import UpdatedTime - - -class Resource(BaseModel): - """Resource""" - - rid: ResourceRid - - display_name: ResourceDisplayName = Field(alias="displayName") - """The display name of the Resource""" - - description: Optional[StrictStr] = None - """The description of the Resource""" - - documentation: Optional[StrictStr] = None - """The documentation associated with the Resource""" - - path: ResourcePath - """The full path to the resource, including the resource name itself""" - - type: ResourceType - """The type of the Resource derived from the Resource Identifier (RID).""" - - created_by: CreatedBy = Field(alias="createdBy") - """The user that created the Resource.""" - - updated_by: UpdatedBy = Field(alias="updatedBy") - """The user that last updated the Resource.""" - - created_time: CreatedTime = Field(alias="createdTime") - """The timestamp that the Resource was last created.""" - - updated_time: UpdatedTime = Field(alias="updatedTime") - """ - The timestamp that the Resource was last modified. For folders, this includes any of its descendants. For - top level folders (spaces and projects), this is not updated by child updates for performance reasons. - """ - - trashed: TrashedStatus - """ - The trash status of the resource. If trashed, a resource can either be directly trashed or one - of its ancestors can be trashed. - """ - - parent_folder_rid: FolderRid = Field(alias="parentFolderRid") - """The parent folder Resource Identifier (RID). For projects, this will be the Space RID.""" - - project_rid: ProjectRid = Field(alias="projectRid") - """ - The Project Resource Identifier (RID) that the Resource lives in. If the Resource itself is a - Project, this value will still be populated with the Project RID. - """ - - space_rid: SpaceRid = Field(alias="spaceRid") - """The Space Resource Identifier (RID) that the Resource lives in.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ResourceDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ResourceDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_resource_dict.py b/foundry/v2/models/_resource_dict.py deleted file mode 100644 index 479a8051..00000000 --- a/foundry/v2/models/_resource_dict.py +++ /dev/null @@ -1,89 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._created_by import CreatedBy -from foundry.v2.models._created_time import CreatedTime -from foundry.v2.models._folder_rid import FolderRid -from foundry.v2.models._project_rid import ProjectRid -from foundry.v2.models._resource_display_name import ResourceDisplayName -from foundry.v2.models._resource_path import ResourcePath -from foundry.v2.models._resource_rid import ResourceRid -from foundry.v2.models._resource_type import ResourceType -from foundry.v2.models._space_rid import SpaceRid -from foundry.v2.models._trashed_status import TrashedStatus -from foundry.v2.models._updated_by import UpdatedBy -from foundry.v2.models._updated_time import UpdatedTime - - -class ResourceDict(TypedDict): - """Resource""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ResourceRid - - displayName: ResourceDisplayName - """The display name of the Resource""" - - description: NotRequired[StrictStr] - """The description of the Resource""" - - documentation: NotRequired[StrictStr] - """The documentation associated with the Resource""" - - path: ResourcePath - """The full path to the resource, including the resource name itself""" - - type: ResourceType - """The type of the Resource derived from the Resource Identifier (RID).""" - - createdBy: CreatedBy - """The user that created the Resource.""" - - updatedBy: UpdatedBy - """The user that last updated the Resource.""" - - createdTime: CreatedTime - """The timestamp that the Resource was last created.""" - - updatedTime: UpdatedTime - """ - The timestamp that the Resource was last modified. For folders, this includes any of its descendants. For - top level folders (spaces and projects), this is not updated by child updates for performance reasons. - """ - - trashed: TrashedStatus - """ - The trash status of the resource. If trashed, a resource can either be directly trashed or one - of its ancestors can be trashed. - """ - - parentFolderRid: FolderRid - """The parent folder Resource Identifier (RID). For projects, this will be the Space RID.""" - - projectRid: ProjectRid - """ - The Project Resource Identifier (RID) that the Resource lives in. If the Resource itself is a - Project, this value will still be populated with the Project RID. - """ - - spaceRid: SpaceRid - """The Space Resource Identifier (RID) that the Resource lives in.""" diff --git a/foundry/v2/models/_resource_display_name.py b/foundry/v2/models/_resource_display_name.py deleted file mode 100644 index fedc985c..00000000 --- a/foundry/v2/models/_resource_display_name.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -ResourceDisplayName = StrictStr -"""The display name of the Resource""" diff --git a/foundry/v2/models/_resource_path.py b/foundry/v2/models/_resource_path.py deleted file mode 100644 index 092b5757..00000000 --- a/foundry/v2/models/_resource_path.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -ResourcePath = StrictStr -"""The full path to the resource, including the resource name itself""" diff --git a/foundry/v2/models/_resource_rid.py b/foundry/v2/models/_resource_rid.py deleted file mode 100644 index 75bb9352..00000000 --- a/foundry/v2/models/_resource_rid.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import RID - -ResourceRid = RID -"""The unique resource identifier (RID) of a Resource.""" diff --git a/foundry/v2/models/_resource_type.py b/foundry/v2/models/_resource_type.py deleted file mode 100644 index 62ae4866..00000000 --- a/foundry/v2/models/_resource_type.py +++ /dev/null @@ -1,71 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -ResourceType = Literal[ - "Academy_Tutorial", - "Artifacts_Repository", - "Automate_Automation", - "Builder_Pipeline", - "Carbon_Workspace", - "Cipher_Channel", - "Code_Repository", - "Code_Workbook", - "Code_Workspace", - "Connectivity_Agent", - "Connectivity_Source", - "Connectivity_VirtualTable", - "Contour_Analysis", - "Data_Lineage_Graph", - "Datasets_Dataset", - "Filesystem_Document", - "Filesystem_Folder", - "Filesystem_Image", - "Filesystem_Project", - "Filesystem_Space", - "Filesystem_WebLink", - "Foundry_Form", - "Foundry_Report", - "Foundry_Template", - "FoundryRules_Workflow", - "Fusion_Document", - "Logic_Function", - "Machinery_ProcessGraph", - "Maps_Layer", - "Maps_Map", - "Marketplace_Installation", - "Marketplace_LocalStore", - "Marketplace_RemoteStore", - "Media_Set", - "Modeling_Model", - "Modeling_ModelVersion", - "Modeling_Objective", - "Monitoring_MonitoringView", - "Notepad_Document", - "Notepad_Template", - "ObjectExploration_Exploration", - "ObjectExploration_Layout", - "Quiver_Analysis", - "Slate_Application", - "SolutionDesigner_Diagram", - "ThirdPartyApplication_ThirdPartyApplication", - "Unknown", - "Vertex_Graph", - "Workshop_Module", -] -"""The type of a resource.""" diff --git a/foundry/v2/models/_return_edits_mode.py b/foundry/v2/models/_return_edits_mode.py deleted file mode 100644 index fe1b26e5..00000000 --- a/foundry/v2/models/_return_edits_mode.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -ReturnEditsMode = Literal["ALL", "NONE"] -"""ReturnEditsMode""" diff --git a/foundry/v2/models/_schedule.py b/foundry/v2/models/_schedule.py deleted file mode 100644 index 1b0737c4..00000000 --- a/foundry/v2/models/_schedule.py +++ /dev/null @@ -1,74 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._action import Action -from foundry.v2.models._created_by import CreatedBy -from foundry.v2.models._created_time import CreatedTime -from foundry.v2.models._schedule_dict import ScheduleDict -from foundry.v2.models._schedule_paused import SchedulePaused -from foundry.v2.models._schedule_rid import ScheduleRid -from foundry.v2.models._schedule_version_rid import ScheduleVersionRid -from foundry.v2.models._scope_mode import ScopeMode -from foundry.v2.models._trigger import Trigger -from foundry.v2.models._updated_by import UpdatedBy -from foundry.v2.models._updated_time import UpdatedTime - - -class Schedule(BaseModel): - """Schedule""" - - rid: ScheduleRid - - display_name: Optional[StrictStr] = Field(alias="displayName", default=None) - - description: Optional[StrictStr] = None - - current_version_rid: ScheduleVersionRid = Field(alias="currentVersionRid") - """The RID of the current schedule version""" - - created_time: CreatedTime = Field(alias="createdTime") - - created_by: CreatedBy = Field(alias="createdBy") - - updated_time: UpdatedTime = Field(alias="updatedTime") - - updated_by: UpdatedBy = Field(alias="updatedBy") - - paused: SchedulePaused - - trigger: Optional[Trigger] = None - """ - The schedule trigger. If the requesting user does not have - permission to see the trigger, this will be empty. - """ - - action: Action - - scope_mode: ScopeMode = Field(alias="scopeMode") - - model_config = {"extra": "allow"} - - def to_dict(self) -> ScheduleDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ScheduleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_schedule_dict.py b/foundry/v2/models/_schedule_dict.py deleted file mode 100644 index 21d9ad88..00000000 --- a/foundry/v2/models/_schedule_dict.py +++ /dev/null @@ -1,66 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._action_dict import ActionDict -from foundry.v2.models._created_by import CreatedBy -from foundry.v2.models._created_time import CreatedTime -from foundry.v2.models._schedule_paused import SchedulePaused -from foundry.v2.models._schedule_rid import ScheduleRid -from foundry.v2.models._schedule_version_rid import ScheduleVersionRid -from foundry.v2.models._scope_mode_dict import ScopeModeDict -from foundry.v2.models._trigger_dict import TriggerDict -from foundry.v2.models._updated_by import UpdatedBy -from foundry.v2.models._updated_time import UpdatedTime - - -class ScheduleDict(TypedDict): - """Schedule""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ScheduleRid - - displayName: NotRequired[StrictStr] - - description: NotRequired[StrictStr] - - currentVersionRid: ScheduleVersionRid - """The RID of the current schedule version""" - - createdTime: CreatedTime - - createdBy: CreatedBy - - updatedTime: UpdatedTime - - updatedBy: UpdatedBy - - paused: SchedulePaused - - trigger: NotRequired[TriggerDict] - """ - The schedule trigger. If the requesting user does not have - permission to see the trigger, this will be empty. - """ - - action: ActionDict - - scopeMode: ScopeModeDict diff --git a/foundry/v2/models/_schedule_run_result.py b/foundry/v2/models/_schedule_run_result.py deleted file mode 100644 index ed0f311e..00000000 --- a/foundry/v2/models/_schedule_run_result.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._schedule_run_error import ScheduleRunError -from foundry.v2.models._schedule_run_ignored import ScheduleRunIgnored -from foundry.v2.models._schedule_run_submitted import ScheduleRunSubmitted - -ScheduleRunResult = Annotated[ - Union[ScheduleRunSubmitted, ScheduleRunIgnored, ScheduleRunError], Field(discriminator="type") -] -""" -The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, -ignored if all targets are up-to-date or error. -""" diff --git a/foundry/v2/models/_schedule_run_result_dict.py b/foundry/v2/models/_schedule_run_result_dict.py deleted file mode 100644 index 7f989cf7..00000000 --- a/foundry/v2/models/_schedule_run_result_dict.py +++ /dev/null @@ -1,34 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._schedule_run_error_dict import ScheduleRunErrorDict -from foundry.v2.models._schedule_run_ignored_dict import ScheduleRunIgnoredDict -from foundry.v2.models._schedule_run_submitted_dict import ScheduleRunSubmittedDict - -ScheduleRunResultDict = Annotated[ - Union[ScheduleRunSubmittedDict, ScheduleRunIgnoredDict, ScheduleRunErrorDict], - Field(discriminator="type"), -] -""" -The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, -ignored if all targets are up-to-date or error. -""" diff --git a/foundry/v2/models/_schedule_version.py b/foundry/v2/models/_schedule_version.py deleted file mode 100644 index fddffa99..00000000 --- a/foundry/v2/models/_schedule_version.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._schedule_version_dict import ScheduleVersionDict -from foundry.v2.models._schedule_version_rid import ScheduleVersionRid - - -class ScheduleVersion(BaseModel): - """ScheduleVersion""" - - rid: ScheduleVersionRid - """The RID of a schedule version""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> ScheduleVersionDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ScheduleVersionDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_schedule_version_dict.py b/foundry/v2/models/_schedule_version_dict.py deleted file mode 100644 index ca04c37a..00000000 --- a/foundry/v2/models/_schedule_version_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._schedule_version_rid import ScheduleVersionRid - - -class ScheduleVersionDict(TypedDict): - """ScheduleVersion""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: ScheduleVersionRid - """The RID of a schedule version""" diff --git a/foundry/v2/models/_scope_mode_dict.py b/foundry/v2/models/_scope_mode_dict.py deleted file mode 100644 index a69eef85..00000000 --- a/foundry/v2/models/_scope_mode_dict.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._project_scope_dict import ProjectScopeDict -from foundry.v2.models._user_scope_dict import UserScopeDict - -ScopeModeDict = Annotated[Union[UserScopeDict, ProjectScopeDict], Field(discriminator="type")] -"""The boundaries for the schedule build.""" diff --git a/foundry/v2/models/_sdk_package_name.py b/foundry/v2/models/_sdk_package_name.py deleted file mode 100644 index 60e45fc6..00000000 --- a/foundry/v2/models/_sdk_package_name.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -SdkPackageName = StrictStr -"""SdkPackageName""" diff --git a/foundry/v2/models/_search_groups_request.py b/foundry/v2/models/_search_groups_request.py deleted file mode 100644 index f219ac32..00000000 --- a/foundry/v2/models/_search_groups_request.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._group_search_filter import GroupSearchFilter -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._search_groups_request_dict import SearchGroupsRequestDict - - -class SearchGroupsRequest(BaseModel): - """SearchGroupsRequest""" - - where: GroupSearchFilter - - page_size: Optional[PageSize] = Field(alias="pageSize", default=None) - - page_token: Optional[PageToken] = Field(alias="pageToken", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchGroupsRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchGroupsRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_search_groups_request_dict.py b/foundry/v2/models/_search_groups_request_dict.py deleted file mode 100644 index 73125672..00000000 --- a/foundry/v2/models/_search_groups_request_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._group_search_filter_dict import GroupSearchFilterDict -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken - - -class SearchGroupsRequestDict(TypedDict): - """SearchGroupsRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - where: GroupSearchFilterDict - - pageSize: NotRequired[PageSize] - - pageToken: NotRequired[PageToken] diff --git a/foundry/v2/models/_search_json_query.py b/foundry/v2/models/_search_json_query.py deleted file mode 100644 index 71ea7b49..00000000 --- a/foundry/v2/models/_search_json_query.py +++ /dev/null @@ -1,104 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._all_terms_query import AllTermsQuery -from foundry.v2.models._any_term_query import AnyTermQuery -from foundry.v2.models._contains_query import ContainsQuery -from foundry.v2.models._equals_query import EqualsQuery -from foundry.v2.models._gt_query import GtQuery -from foundry.v2.models._gte_query import GteQuery -from foundry.v2.models._is_null_query import IsNullQuery -from foundry.v2.models._lt_query import LtQuery -from foundry.v2.models._lte_query import LteQuery -from foundry.v2.models._phrase_query import PhraseQuery -from foundry.v2.models._prefix_query import PrefixQuery -from foundry.v2.models._search_json_query_dict import AndQueryDict -from foundry.v2.models._search_json_query_dict import NotQueryDict -from foundry.v2.models._search_json_query_dict import OrQueryDict - - -class AndQuery(BaseModel): - """Returns objects where every query is satisfied.""" - - value: List[SearchJsonQuery] - - type: Literal["and"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AndQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AndQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class OrQuery(BaseModel): - """Returns objects where at least 1 query is satisfied.""" - - value: List[SearchJsonQuery] - - type: Literal["or"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OrQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OrQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class NotQuery(BaseModel): - """Returns objects where the query is not satisfied.""" - - value: SearchJsonQuery - - type: Literal["not"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> NotQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(NotQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -SearchJsonQuery = Annotated[ - Union[ - LtQuery, - GtQuery, - LteQuery, - GteQuery, - EqualsQuery, - IsNullQuery, - ContainsQuery, - AndQuery, - OrQuery, - NotQuery, - PrefixQuery, - PhraseQuery, - AnyTermQuery, - AllTermsQuery, - ], - Field(discriminator="type"), -] -"""SearchJsonQuery""" diff --git a/foundry/v2/models/_search_json_query_dict.py b/foundry/v2/models/_search_json_query_dict.py deleted file mode 100644 index 7dc1b387..00000000 --- a/foundry/v2/models/_search_json_query_dict.py +++ /dev/null @@ -1,88 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import TypedDict - -from foundry.v2.models._all_terms_query_dict import AllTermsQueryDict -from foundry.v2.models._any_term_query_dict import AnyTermQueryDict -from foundry.v2.models._contains_query_dict import ContainsQueryDict -from foundry.v2.models._equals_query_dict import EqualsQueryDict -from foundry.v2.models._gt_query_dict import GtQueryDict -from foundry.v2.models._gte_query_dict import GteQueryDict -from foundry.v2.models._is_null_query_dict import IsNullQueryDict -from foundry.v2.models._lt_query_dict import LtQueryDict -from foundry.v2.models._lte_query_dict import LteQueryDict -from foundry.v2.models._phrase_query_dict import PhraseQueryDict -from foundry.v2.models._prefix_query_dict import PrefixQueryDict - - -class AndQueryDict(TypedDict): - """Returns objects where every query is satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: List[SearchJsonQueryDict] - - type: Literal["and"] - - -class OrQueryDict(TypedDict): - """Returns objects where at least 1 query is satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: List[SearchJsonQueryDict] - - type: Literal["or"] - - -class NotQueryDict(TypedDict): - """Returns objects where the query is not satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: SearchJsonQueryDict - - type: Literal["not"] - - -SearchJsonQueryDict = Annotated[ - Union[ - LtQueryDict, - GtQueryDict, - LteQueryDict, - GteQueryDict, - EqualsQueryDict, - IsNullQueryDict, - ContainsQueryDict, - AndQueryDict, - OrQueryDict, - NotQueryDict, - PrefixQueryDict, - PhraseQueryDict, - AnyTermQueryDict, - AllTermsQueryDict, - ], - Field(discriminator="type"), -] -"""SearchJsonQuery""" diff --git a/foundry/v2/models/_search_json_query_v2.py b/foundry/v2/models/_search_json_query_v2.py deleted file mode 100644 index d570732d..00000000 --- a/foundry/v2/models/_search_json_query_v2.py +++ /dev/null @@ -1,126 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._contains_all_terms_in_order_prefix_last_term import ( - ContainsAllTermsInOrderPrefixLastTerm, -) # NOQA -from foundry.v2.models._contains_all_terms_in_order_query import ( - ContainsAllTermsInOrderQuery, -) # NOQA -from foundry.v2.models._contains_all_terms_query import ContainsAllTermsQuery -from foundry.v2.models._contains_any_term_query import ContainsAnyTermQuery -from foundry.v2.models._contains_query_v2 import ContainsQueryV2 -from foundry.v2.models._does_not_intersect_bounding_box_query import ( - DoesNotIntersectBoundingBoxQuery, -) # NOQA -from foundry.v2.models._does_not_intersect_polygon_query import DoesNotIntersectPolygonQuery # NOQA -from foundry.v2.models._equals_query_v2 import EqualsQueryV2 -from foundry.v2.models._gt_query_v2 import GtQueryV2 -from foundry.v2.models._gte_query_v2 import GteQueryV2 -from foundry.v2.models._intersects_bounding_box_query import IntersectsBoundingBoxQuery -from foundry.v2.models._intersects_polygon_query import IntersectsPolygonQuery -from foundry.v2.models._is_null_query_v2 import IsNullQueryV2 -from foundry.v2.models._lt_query_v2 import LtQueryV2 -from foundry.v2.models._lte_query_v2 import LteQueryV2 -from foundry.v2.models._search_json_query_v2_dict import AndQueryV2Dict -from foundry.v2.models._search_json_query_v2_dict import NotQueryV2Dict -from foundry.v2.models._search_json_query_v2_dict import OrQueryV2Dict -from foundry.v2.models._starts_with_query import StartsWithQuery -from foundry.v2.models._within_bounding_box_query import WithinBoundingBoxQuery -from foundry.v2.models._within_distance_of_query import WithinDistanceOfQuery -from foundry.v2.models._within_polygon_query import WithinPolygonQuery - - -class AndQueryV2(BaseModel): - """Returns objects where every query is satisfied.""" - - value: List[SearchJsonQueryV2] - - type: Literal["and"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AndQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AndQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class OrQueryV2(BaseModel): - """Returns objects where at least 1 query is satisfied.""" - - value: List[SearchJsonQueryV2] - - type: Literal["or"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OrQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OrQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class NotQueryV2(BaseModel): - """Returns objects where the query is not satisfied.""" - - value: SearchJsonQueryV2 - - type: Literal["not"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> NotQueryV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(NotQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) - - -SearchJsonQueryV2 = Annotated[ - Union[ - LtQueryV2, - GtQueryV2, - LteQueryV2, - GteQueryV2, - EqualsQueryV2, - IsNullQueryV2, - ContainsQueryV2, - AndQueryV2, - OrQueryV2, - NotQueryV2, - StartsWithQuery, - ContainsAllTermsInOrderQuery, - ContainsAllTermsInOrderPrefixLastTerm, - ContainsAnyTermQuery, - ContainsAllTermsQuery, - WithinDistanceOfQuery, - WithinBoundingBoxQuery, - IntersectsBoundingBoxQuery, - DoesNotIntersectBoundingBoxQuery, - WithinPolygonQuery, - IntersectsPolygonQuery, - DoesNotIntersectPolygonQuery, - ], - Field(discriminator="type"), -] -"""SearchJsonQueryV2""" diff --git a/foundry/v2/models/_search_json_query_v2_dict.py b/foundry/v2/models/_search_json_query_v2_dict.py deleted file mode 100644 index 5c4f9be0..00000000 --- a/foundry/v2/models/_search_json_query_v2_dict.py +++ /dev/null @@ -1,114 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import TypedDict - -from foundry.v2.models._contains_all_terms_in_order_prefix_last_term_dict import ( - ContainsAllTermsInOrderPrefixLastTermDict, -) # NOQA -from foundry.v2.models._contains_all_terms_in_order_query_dict import ( - ContainsAllTermsInOrderQueryDict, -) # NOQA -from foundry.v2.models._contains_all_terms_query_dict import ContainsAllTermsQueryDict -from foundry.v2.models._contains_any_term_query_dict import ContainsAnyTermQueryDict -from foundry.v2.models._contains_query_v2_dict import ContainsQueryV2Dict -from foundry.v2.models._does_not_intersect_bounding_box_query_dict import ( - DoesNotIntersectBoundingBoxQueryDict, -) # NOQA -from foundry.v2.models._does_not_intersect_polygon_query_dict import ( - DoesNotIntersectPolygonQueryDict, -) # NOQA -from foundry.v2.models._equals_query_v2_dict import EqualsQueryV2Dict -from foundry.v2.models._gt_query_v2_dict import GtQueryV2Dict -from foundry.v2.models._gte_query_v2_dict import GteQueryV2Dict -from foundry.v2.models._intersects_bounding_box_query_dict import ( - IntersectsBoundingBoxQueryDict, -) # NOQA -from foundry.v2.models._intersects_polygon_query_dict import IntersectsPolygonQueryDict -from foundry.v2.models._is_null_query_v2_dict import IsNullQueryV2Dict -from foundry.v2.models._lt_query_v2_dict import LtQueryV2Dict -from foundry.v2.models._lte_query_v2_dict import LteQueryV2Dict -from foundry.v2.models._starts_with_query_dict import StartsWithQueryDict -from foundry.v2.models._within_bounding_box_query_dict import WithinBoundingBoxQueryDict -from foundry.v2.models._within_distance_of_query_dict import WithinDistanceOfQueryDict -from foundry.v2.models._within_polygon_query_dict import WithinPolygonQueryDict - - -class AndQueryV2Dict(TypedDict): - """Returns objects where every query is satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: List[SearchJsonQueryV2Dict] - - type: Literal["and"] - - -class OrQueryV2Dict(TypedDict): - """Returns objects where at least 1 query is satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: List[SearchJsonQueryV2Dict] - - type: Literal["or"] - - -class NotQueryV2Dict(TypedDict): - """Returns objects where the query is not satisfied.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - value: SearchJsonQueryV2Dict - - type: Literal["not"] - - -SearchJsonQueryV2Dict = Annotated[ - Union[ - LtQueryV2Dict, - GtQueryV2Dict, - LteQueryV2Dict, - GteQueryV2Dict, - EqualsQueryV2Dict, - IsNullQueryV2Dict, - ContainsQueryV2Dict, - AndQueryV2Dict, - OrQueryV2Dict, - NotQueryV2Dict, - StartsWithQueryDict, - ContainsAllTermsInOrderQueryDict, - ContainsAllTermsInOrderPrefixLastTermDict, - ContainsAnyTermQueryDict, - ContainsAllTermsQueryDict, - WithinDistanceOfQueryDict, - WithinBoundingBoxQueryDict, - IntersectsBoundingBoxQueryDict, - DoesNotIntersectBoundingBoxQueryDict, - WithinPolygonQueryDict, - IntersectsPolygonQueryDict, - DoesNotIntersectPolygonQueryDict, - ], - Field(discriminator="type"), -] -"""SearchJsonQueryV2""" diff --git a/foundry/v2/models/_search_objects_for_interface_request.py b/foundry/v2/models/_search_objects_for_interface_request.py deleted file mode 100644 index 12ea765d..00000000 --- a/foundry/v2/models/_search_objects_for_interface_request.py +++ /dev/null @@ -1,95 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._search_json_query_v2 import SearchJsonQueryV2 -from foundry.v2.models._search_objects_for_interface_request_dict import ( - SearchObjectsForInterfaceRequestDict, -) # NOQA -from foundry.v2.models._search_order_by_v2 import SearchOrderByV2 -from foundry.v2.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class SearchObjectsForInterfaceRequest(BaseModel): - """SearchObjectsForInterfaceRequest""" - - where: Optional[SearchJsonQueryV2] = None - - order_by: Optional[SearchOrderByV2] = Field(alias="orderBy", default=None) - - augmented_properties: Dict[ObjectTypeApiName, List[PropertyApiName]] = Field( - alias="augmentedProperties" - ) - """ - A map from object type API name to a list of property type API names. For each returned object, if the - object’s object type is a key in the map, then we augment the response for that object type with the list - of properties specified in the value. - """ - - augmented_shared_property_types: Dict[ - InterfaceTypeApiName, List[SharedPropertyTypeApiName] - ] = Field(alias="augmentedSharedPropertyTypes") - """ - A map from interface type API name to a list of shared property type API names. For each returned object, if - the object implements an interface that is a key in the map, then we augment the response for that object - type with the list of properties specified in the value. - """ - - selected_shared_property_types: List[SharedPropertyTypeApiName] = Field( - alias="selectedSharedPropertyTypes" - ) - """ - A list of shared property type API names of the interface type that should be included in the response. - Omit this parameter to include all properties of the interface type in the response. - """ - - selected_object_types: List[ObjectTypeApiName] = Field(alias="selectedObjectTypes") - """ - A list of object type API names that should be included in the response. If non-empty, object types that are - not mentioned will not be included in the response even if they implement the specified interface. Omit the - parameter to include all object types. - """ - - other_interface_types: List[InterfaceTypeApiName] = Field(alias="otherInterfaceTypes") - """ - A list of interface type API names. Object types must implement all the mentioned interfaces in order to be - included in the response. - """ - - page_size: Optional[PageSize] = Field(alias="pageSize", default=None) - - page_token: Optional[PageToken] = Field(alias="pageToken", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchObjectsForInterfaceRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - SearchObjectsForInterfaceRequestDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_search_objects_for_interface_request_dict.py b/foundry/v2/models/_search_objects_for_interface_request_dict.py deleted file mode 100644 index 920b2c6c..00000000 --- a/foundry/v2/models/_search_objects_for_interface_request_dict.py +++ /dev/null @@ -1,78 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._interface_type_api_name import InterfaceTypeApiName -from foundry.v2.models._object_type_api_name import ObjectTypeApiName -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._search_json_query_v2_dict import SearchJsonQueryV2Dict -from foundry.v2.models._search_order_by_v2_dict import SearchOrderByV2Dict -from foundry.v2.models._shared_property_type_api_name import SharedPropertyTypeApiName - - -class SearchObjectsForInterfaceRequestDict(TypedDict): - """SearchObjectsForInterfaceRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - where: NotRequired[SearchJsonQueryV2Dict] - - orderBy: NotRequired[SearchOrderByV2Dict] - - augmentedProperties: Dict[ObjectTypeApiName, List[PropertyApiName]] - """ - A map from object type API name to a list of property type API names. For each returned object, if the - object’s object type is a key in the map, then we augment the response for that object type with the list - of properties specified in the value. - """ - - augmentedSharedPropertyTypes: Dict[InterfaceTypeApiName, List[SharedPropertyTypeApiName]] - """ - A map from interface type API name to a list of shared property type API names. For each returned object, if - the object implements an interface that is a key in the map, then we augment the response for that object - type with the list of properties specified in the value. - """ - - selectedSharedPropertyTypes: List[SharedPropertyTypeApiName] - """ - A list of shared property type API names of the interface type that should be included in the response. - Omit this parameter to include all properties of the interface type in the response. - """ - - selectedObjectTypes: List[ObjectTypeApiName] - """ - A list of object type API names that should be included in the response. If non-empty, object types that are - not mentioned will not be included in the response even if they implement the specified interface. Omit the - parameter to include all object types. - """ - - otherInterfaceTypes: List[InterfaceTypeApiName] - """ - A list of interface type API names. Object types must implement all the mentioned interfaces in order to be - included in the response. - """ - - pageSize: NotRequired[PageSize] - - pageToken: NotRequired[PageToken] diff --git a/foundry/v2/models/_search_objects_request.py b/foundry/v2/models/_search_objects_request.py deleted file mode 100644 index a78306cf..00000000 --- a/foundry/v2/models/_search_objects_request.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._search_json_query import SearchJsonQuery -from foundry.v2.models._search_objects_request_dict import SearchObjectsRequestDict -from foundry.v2.models._search_order_by import SearchOrderBy - - -class SearchObjectsRequest(BaseModel): - """SearchObjectsRequest""" - - query: SearchJsonQuery - - order_by: Optional[SearchOrderBy] = Field(alias="orderBy", default=None) - - page_size: Optional[PageSize] = Field(alias="pageSize", default=None) - - page_token: Optional[PageToken] = Field(alias="pageToken", default=None) - - fields: List[PropertyApiName] - """The API names of the object type properties to include in the response.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchObjectsRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchObjectsRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_search_objects_request_dict.py b/foundry/v2/models/_search_objects_request_dict.py deleted file mode 100644 index 9c2a7320..00000000 --- a/foundry/v2/models/_search_objects_request_dict.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._search_json_query_dict import SearchJsonQueryDict -from foundry.v2.models._search_order_by_dict import SearchOrderByDict - - -class SearchObjectsRequestDict(TypedDict): - """SearchObjectsRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - query: SearchJsonQueryDict - - orderBy: NotRequired[SearchOrderByDict] - - pageSize: NotRequired[PageSize] - - pageToken: NotRequired[PageToken] - - fields: List[PropertyApiName] - """The API names of the object type properties to include in the response.""" diff --git a/foundry/v2/models/_search_objects_request_v2.py b/foundry/v2/models/_search_objects_request_v2.py deleted file mode 100644 index 1b84a96f..00000000 --- a/foundry/v2/models/_search_objects_request_v2.py +++ /dev/null @@ -1,58 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictBool - -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._search_json_query_v2 import SearchJsonQueryV2 -from foundry.v2.models._search_objects_request_v2_dict import SearchObjectsRequestV2Dict -from foundry.v2.models._search_order_by_v2 import SearchOrderByV2 - - -class SearchObjectsRequestV2(BaseModel): - """SearchObjectsRequestV2""" - - where: Optional[SearchJsonQueryV2] = None - - order_by: Optional[SearchOrderByV2] = Field(alias="orderBy", default=None) - - page_size: Optional[PageSize] = Field(alias="pageSize", default=None) - - page_token: Optional[PageToken] = Field(alias="pageToken", default=None) - - select: List[PropertyApiName] - """The API names of the object type properties to include in the response.""" - - exclude_rid: Optional[StrictBool] = Field(alias="excludeRid", default=None) - """ - A flag to exclude the retrieval of the `__rid` property. - Setting this to true may improve performance of this endpoint for object types in OSV2. - """ - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchObjectsRequestV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchObjectsRequestV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_search_objects_request_v2_dict.py b/foundry/v2/models/_search_objects_request_v2_dict.py deleted file mode 100644 index 2d226b4a..00000000 --- a/foundry/v2/models/_search_objects_request_v2_dict.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from pydantic import StrictBool -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._search_json_query_v2_dict import SearchJsonQueryV2Dict -from foundry.v2.models._search_order_by_v2_dict import SearchOrderByV2Dict - - -class SearchObjectsRequestV2Dict(TypedDict): - """SearchObjectsRequestV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - where: NotRequired[SearchJsonQueryV2Dict] - - orderBy: NotRequired[SearchOrderByV2Dict] - - pageSize: NotRequired[PageSize] - - pageToken: NotRequired[PageToken] - - select: List[PropertyApiName] - """The API names of the object type properties to include in the response.""" - - excludeRid: NotRequired[StrictBool] - """ - A flag to exclude the retrieval of the `__rid` property. - Setting this to true may improve performance of this endpoint for object types in OSV2. - """ diff --git a/foundry/v2/models/_search_objects_response.py b/foundry/v2/models/_search_objects_response.py deleted file mode 100644 index 17dfb083..00000000 --- a/foundry/v2/models/_search_objects_response.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._ontology_object import OntologyObject -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._search_objects_response_dict import SearchObjectsResponseDict -from foundry.v2.models._total_count import TotalCount - - -class SearchObjectsResponse(BaseModel): - """SearchObjectsResponse""" - - data: List[OntologyObject] - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - total_count: TotalCount = Field(alias="totalCount") - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchObjectsResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchObjectsResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_search_objects_response_dict.py b/foundry/v2/models/_search_objects_response_dict.py deleted file mode 100644 index f5c6a169..00000000 --- a/foundry/v2/models/_search_objects_response_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._ontology_object_dict import OntologyObjectDict -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._total_count import TotalCount - - -class SearchObjectsResponseDict(TypedDict): - """SearchObjectsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[OntologyObjectDict] - - nextPageToken: NotRequired[PageToken] - - totalCount: TotalCount diff --git a/foundry/v2/models/_search_objects_response_v2.py b/foundry/v2/models/_search_objects_response_v2.py deleted file mode 100644 index dbff65f5..00000000 --- a/foundry/v2/models/_search_objects_response_v2.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._search_objects_response_v2_dict import SearchObjectsResponseV2Dict # NOQA -from foundry.v2.models._total_count import TotalCount - - -class SearchObjectsResponseV2(BaseModel): - """SearchObjectsResponseV2""" - - data: List[OntologyObjectV2] - - next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) - - total_count: TotalCount = Field(alias="totalCount") - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchObjectsResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_search_objects_response_v2_dict.py b/foundry/v2/models/_search_objects_response_v2_dict.py deleted file mode 100644 index e322e0cd..00000000 --- a/foundry/v2/models/_search_objects_response_v2_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._ontology_object_v2 import OntologyObjectV2 -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._total_count import TotalCount - - -class SearchObjectsResponseV2Dict(TypedDict): - """SearchObjectsResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[OntologyObjectV2] - - nextPageToken: NotRequired[PageToken] - - totalCount: TotalCount diff --git a/foundry/v2/models/_search_order_by.py b/foundry/v2/models/_search_order_by.py deleted file mode 100644 index 3f0ae75b..00000000 --- a/foundry/v2/models/_search_order_by.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._search_order_by_dict import SearchOrderByDict -from foundry.v2.models._search_ordering import SearchOrdering - - -class SearchOrderBy(BaseModel): - """Specifies the ordering of search results by a field and an ordering direction.""" - - fields: List[SearchOrdering] - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchOrderByDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchOrderByDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_search_order_by_dict.py b/foundry/v2/models/_search_order_by_dict.py deleted file mode 100644 index 93d52ff6..00000000 --- a/foundry/v2/models/_search_order_by_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._search_ordering_dict import SearchOrderingDict - - -class SearchOrderByDict(TypedDict): - """Specifies the ordering of search results by a field and an ordering direction.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: List[SearchOrderingDict] diff --git a/foundry/v2/models/_search_order_by_v2.py b/foundry/v2/models/_search_order_by_v2.py deleted file mode 100644 index c7a32eb1..00000000 --- a/foundry/v2/models/_search_order_by_v2.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._search_order_by_v2_dict import SearchOrderByV2Dict -from foundry.v2.models._search_ordering_v2 import SearchOrderingV2 - - -class SearchOrderByV2(BaseModel): - """Specifies the ordering of search results by a field and an ordering direction.""" - - fields: List[SearchOrderingV2] - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchOrderByV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchOrderByV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_search_order_by_v2_dict.py b/foundry/v2/models/_search_order_by_v2_dict.py deleted file mode 100644 index 809aa309..00000000 --- a/foundry/v2/models/_search_order_by_v2_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._search_ordering_v2_dict import SearchOrderingV2Dict - - -class SearchOrderByV2Dict(TypedDict): - """Specifies the ordering of search results by a field and an ordering direction.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - fields: List[SearchOrderingV2Dict] diff --git a/foundry/v2/models/_search_ordering.py b/foundry/v2/models/_search_ordering.py deleted file mode 100644 index 66b4df50..00000000 --- a/foundry/v2/models/_search_ordering.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._search_ordering_dict import SearchOrderingDict - - -class SearchOrdering(BaseModel): - """SearchOrdering""" - - field: FieldNameV1 - - direction: Optional[StrictStr] = None - """Specifies the ordering direction (can be either `asc` or `desc`)""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchOrderingDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchOrderingDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_search_ordering_dict.py b/foundry/v2/models/_search_ordering_dict.py deleted file mode 100644 index 1d789a9f..00000000 --- a/foundry/v2/models/_search_ordering_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class SearchOrderingDict(TypedDict): - """SearchOrdering""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - direction: NotRequired[StrictStr] - """Specifies the ordering direction (can be either `asc` or `desc`)""" diff --git a/foundry/v2/models/_search_ordering_v2.py b/foundry/v2/models/_search_ordering_v2.py deleted file mode 100644 index 21108886..00000000 --- a/foundry/v2/models/_search_ordering_v2.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._search_ordering_v2_dict import SearchOrderingV2Dict - - -class SearchOrderingV2(BaseModel): - """SearchOrderingV2""" - - field: PropertyApiName - - direction: Optional[StrictStr] = None - """Specifies the ordering direction (can be either `asc` or `desc`)""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchOrderingV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchOrderingV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_search_ordering_v2_dict.py b/foundry/v2/models/_search_ordering_v2_dict.py deleted file mode 100644 index 772c0146..00000000 --- a/foundry/v2/models/_search_ordering_v2_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName - - -class SearchOrderingV2Dict(TypedDict): - """SearchOrderingV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - direction: NotRequired[StrictStr] - """Specifies the ordering direction (can be either `asc` or `desc`)""" diff --git a/foundry/v2/models/_search_users_request.py b/foundry/v2/models/_search_users_request.py deleted file mode 100644 index 1b9b1b4c..00000000 --- a/foundry/v2/models/_search_users_request.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._search_users_request_dict import SearchUsersRequestDict -from foundry.v2.models._user_search_filter import UserSearchFilter - - -class SearchUsersRequest(BaseModel): - """SearchUsersRequest""" - - where: UserSearchFilter - - page_size: Optional[PageSize] = Field(alias="pageSize", default=None) - - page_token: Optional[PageToken] = Field(alias="pageToken", default=None) - - model_config = {"extra": "allow"} - - def to_dict(self) -> SearchUsersRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SearchUsersRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_search_users_request_dict.py b/foundry/v2/models/_search_users_request_dict.py deleted file mode 100644 index 5dcdaf63..00000000 --- a/foundry/v2/models/_search_users_request_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._page_size import PageSize -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._user_search_filter_dict import UserSearchFilterDict - - -class SearchUsersRequestDict(TypedDict): - """SearchUsersRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - where: UserSearchFilterDict - - pageSize: NotRequired[PageSize] - - pageToken: NotRequired[PageToken] diff --git a/foundry/v2/models/_shared_property_type.py b/foundry/v2/models/_shared_property_type.py deleted file mode 100644 index 590b22af..00000000 --- a/foundry/v2/models/_shared_property_type.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._object_property_type import ObjectPropertyType -from foundry.v2.models._shared_property_type_api_name import SharedPropertyTypeApiName -from foundry.v2.models._shared_property_type_dict import SharedPropertyTypeDict -from foundry.v2.models._shared_property_type_rid import SharedPropertyTypeRid - - -class SharedPropertyType(BaseModel): - """A property type that can be shared across object types.""" - - rid: SharedPropertyTypeRid - - api_name: SharedPropertyTypeApiName = Field(alias="apiName") - - display_name: DisplayName = Field(alias="displayName") - - description: Optional[StrictStr] = None - """A short text that describes the SharedPropertyType.""" - - data_type: ObjectPropertyType = Field(alias="dataType") - - model_config = {"extra": "allow"} - - def to_dict(self) -> SharedPropertyTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SharedPropertyTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_shared_property_type_api_name.py b/foundry/v2/models/_shared_property_type_api_name.py deleted file mode 100644 index b9db5173..00000000 --- a/foundry/v2/models/_shared_property_type_api_name.py +++ /dev/null @@ -1,24 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -SharedPropertyTypeApiName = StrictStr -""" -The name of the shared property type in the API in lowerCamelCase format. To find the API name for your -shared property type, use the `List shared property types` endpoint or check the **Ontology Manager**. -""" diff --git a/foundry/v2/models/_shared_property_type_dict.py b/foundry/v2/models/_shared_property_type_dict.py deleted file mode 100644 index abb556c2..00000000 --- a/foundry/v2/models/_shared_property_type_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._display_name import DisplayName -from foundry.v2.models._object_property_type_dict import ObjectPropertyTypeDict -from foundry.v2.models._shared_property_type_api_name import SharedPropertyTypeApiName -from foundry.v2.models._shared_property_type_rid import SharedPropertyTypeRid - - -class SharedPropertyTypeDict(TypedDict): - """A property type that can be shared across object types.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: SharedPropertyTypeRid - - apiName: SharedPropertyTypeApiName - - displayName: DisplayName - - description: NotRequired[StrictStr] - """A short text that describes the SharedPropertyType.""" - - dataType: ObjectPropertyTypeDict diff --git a/foundry/v2/models/_shared_property_type_rid.py b/foundry/v2/models/_shared_property_type_rid.py deleted file mode 100644 index 16f54b80..00000000 --- a/foundry/v2/models/_shared_property_type_rid.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import RID - -SharedPropertyTypeRid = RID -"""The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs.""" diff --git a/foundry/v2/models/_short_type.py b/foundry/v2/models/_short_type.py deleted file mode 100644 index e5c4003e..00000000 --- a/foundry/v2/models/_short_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._short_type_dict import ShortTypeDict - - -class ShortType(BaseModel): - """ShortType""" - - type: Literal["short"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ShortTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ShortTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_size_bytes.py b/foundry/v2/models/_size_bytes.py deleted file mode 100644 index c00066d1..00000000 --- a/foundry/v2/models/_size_bytes.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -SizeBytes = StrictStr -"""The size of the file or attachment in bytes.""" diff --git a/foundry/v2/models/_space.py b/foundry/v2/models/_space.py deleted file mode 100644 index c3c3edbf..00000000 --- a/foundry/v2/models/_space.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._space_dict import SpaceDict -from foundry.v2.models._space_rid import SpaceRid - - -class Space(BaseModel): - """Space""" - - rid: SpaceRid - - model_config = {"extra": "allow"} - - def to_dict(self) -> SpaceDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SpaceDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_space_dict.py b/foundry/v2/models/_space_dict.py deleted file mode 100644 index 31f658fa..00000000 --- a/foundry/v2/models/_space_dict.py +++ /dev/null @@ -1,28 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import TypedDict - -from foundry.v2.models._space_rid import SpaceRid - - -class SpaceDict(TypedDict): - """Space""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: SpaceRid diff --git a/foundry/v2/models/_space_rid.py b/foundry/v2/models/_space_rid.py deleted file mode 100644 index 02e7601c..00000000 --- a/foundry/v2/models/_space_rid.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import RID - -SpaceRid = RID -"""The unique resource identifier (RID) of a Space.""" diff --git a/foundry/v2/models/_starts_with_query.py b/foundry/v2/models/_starts_with_query.py deleted file mode 100644 index 026e8e29..00000000 --- a/foundry/v2/models/_starts_with_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._starts_with_query_dict import StartsWithQueryDict - - -class StartsWithQuery(BaseModel): - """Returns objects where the specified field starts with the provided value.""" - - field: PropertyApiName - - value: StrictStr - - type: Literal["startsWith"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> StartsWithQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(StartsWithQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_starts_with_query_dict.py b/foundry/v2/models/_starts_with_query_dict.py deleted file mode 100644 index fda0c37a..00000000 --- a/foundry/v2/models/_starts_with_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from pydantic import StrictStr -from typing_extensions import TypedDict - -from foundry.v2.models._property_api_name import PropertyApiName - - -class StartsWithQueryDict(TypedDict): - """Returns objects where the specified field starts with the provided value.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: StrictStr - - type: Literal["startsWith"] diff --git a/foundry/v2/models/_stream_message.py b/foundry/v2/models/_stream_message.py deleted file mode 100644 index 397846c3..00000000 --- a/foundry/v2/models/_stream_message.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._object_set_subscribe_responses import ObjectSetSubscribeResponses # NOQA -from foundry.v2.models._object_set_updates import ObjectSetUpdates -from foundry.v2.models._refresh_object_set import RefreshObjectSet -from foundry.v2.models._subscription_closed import SubscriptionClosed - -StreamMessage = Annotated[ - Union[ObjectSetSubscribeResponses, ObjectSetUpdates, RefreshObjectSet, SubscriptionClosed], - Field(discriminator="type"), -] -"""StreamMessage""" diff --git a/foundry/v2/models/_stream_message_dict.py b/foundry/v2/models/_stream_message_dict.py deleted file mode 100644 index 47d8a410..00000000 --- a/foundry/v2/models/_stream_message_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._object_set_subscribe_responses_dict import ( - ObjectSetSubscribeResponsesDict, -) # NOQA -from foundry.v2.models._object_set_updates_dict import ObjectSetUpdatesDict -from foundry.v2.models._refresh_object_set_dict import RefreshObjectSetDict -from foundry.v2.models._subscription_closed_dict import SubscriptionClosedDict - -StreamMessageDict = Annotated[ - Union[ - ObjectSetSubscribeResponsesDict, - ObjectSetUpdatesDict, - RefreshObjectSetDict, - SubscriptionClosedDict, - ], - Field(discriminator="type"), -] -"""StreamMessage""" diff --git a/foundry/v2/models/_stream_time_series_points_request.py b/foundry/v2/models/_stream_time_series_points_request.py deleted file mode 100644 index 666f5b26..00000000 --- a/foundry/v2/models/_stream_time_series_points_request.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._stream_time_series_points_request_dict import ( - StreamTimeSeriesPointsRequestDict, -) # NOQA -from foundry.v2.models._time_range import TimeRange - - -class StreamTimeSeriesPointsRequest(BaseModel): - """StreamTimeSeriesPointsRequest""" - - range: Optional[TimeRange] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> StreamTimeSeriesPointsRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - StreamTimeSeriesPointsRequestDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_stream_time_series_points_request_dict.py b/foundry/v2/models/_stream_time_series_points_request_dict.py deleted file mode 100644 index 9e9e1c56..00000000 --- a/foundry/v2/models/_stream_time_series_points_request_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._time_range_dict import TimeRangeDict - - -class StreamTimeSeriesPointsRequestDict(TypedDict): - """StreamTimeSeriesPointsRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - range: NotRequired[TimeRangeDict] diff --git a/foundry/v2/models/_stream_time_series_points_response.py b/foundry/v2/models/_stream_time_series_points_response.py deleted file mode 100644 index c601149d..00000000 --- a/foundry/v2/models/_stream_time_series_points_response.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._stream_time_series_points_response_dict import ( - StreamTimeSeriesPointsResponseDict, -) # NOQA -from foundry.v2.models._time_series_point import TimeSeriesPoint - - -class StreamTimeSeriesPointsResponse(BaseModel): - """StreamTimeSeriesPointsResponse""" - - data: List[TimeSeriesPoint] - - model_config = {"extra": "allow"} - - def to_dict(self) -> StreamTimeSeriesPointsResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - StreamTimeSeriesPointsResponseDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_stream_time_series_points_response_dict.py b/foundry/v2/models/_stream_time_series_points_response_dict.py deleted file mode 100644 index 3cfd07c1..00000000 --- a/foundry/v2/models/_stream_time_series_points_response_dict.py +++ /dev/null @@ -1,30 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._time_series_point_dict import TimeSeriesPointDict - - -class StreamTimeSeriesPointsResponseDict(TypedDict): - """StreamTimeSeriesPointsResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - data: List[TimeSeriesPointDict] diff --git a/foundry/v2/models/_string_length_constraint.py b/foundry/v2/models/_string_length_constraint.py deleted file mode 100644 index 7a6a8362..00000000 --- a/foundry/v2/models/_string_length_constraint.py +++ /dev/null @@ -1,52 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Any -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._string_length_constraint_dict import StringLengthConstraintDict - - -class StringLengthConstraint(BaseModel): - """ - The parameter value must have a length within the defined range. - *This range is always inclusive.* - """ - - lt: Optional[Any] = None - """Less than""" - - lte: Optional[Any] = None - """Less than or equal""" - - gt: Optional[Any] = None - """Greater than""" - - gte: Optional[Any] = None - """Greater than or equal""" - - type: Literal["stringLength"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> StringLengthConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(StringLengthConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_string_regex_match_constraint.py b/foundry/v2/models/_string_regex_match_constraint.py deleted file mode 100644 index 201589dd..00000000 --- a/foundry/v2/models/_string_regex_match_constraint.py +++ /dev/null @@ -1,53 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._string_regex_match_constraint_dict import ( - StringRegexMatchConstraintDict, -) # NOQA - - -class StringRegexMatchConstraint(BaseModel): - """The parameter value must match a predefined regular expression.""" - - regex: StrictStr - """The regular expression configured in the **Ontology Manager**.""" - - configured_failure_message: Optional[StrictStr] = Field( - alias="configuredFailureMessage", default=None - ) - """ - The message indicating that the regular expression was not matched. - This is configured per parameter in the **Ontology Manager**. - """ - - type: Literal["stringRegexMatch"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> StringRegexMatchConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - StringRegexMatchConstraintDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_string_type.py b/foundry/v2/models/_string_type.py deleted file mode 100644 index 3c79a60c..00000000 --- a/foundry/v2/models/_string_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._string_type_dict import StringTypeDict - - -class StringType(BaseModel): - """StringType""" - - type: Literal["string"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> StringTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(StringTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_submission_criteria_evaluation.py b/foundry/v2/models/_submission_criteria_evaluation.py deleted file mode 100644 index 55e72ddb..00000000 --- a/foundry/v2/models/_submission_criteria_evaluation.py +++ /dev/null @@ -1,54 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._submission_criteria_evaluation_dict import ( - SubmissionCriteriaEvaluationDict, -) # NOQA -from foundry.v2.models._validation_result import ValidationResult - - -class SubmissionCriteriaEvaluation(BaseModel): - """ - Contains the status of the **submission criteria**. - **Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. - These are configured in the **Ontology Manager**. - """ - - configured_failure_message: Optional[StrictStr] = Field( - alias="configuredFailureMessage", default=None - ) - """ - The message indicating one of the **submission criteria** was not satisfied. - This is configured per **submission criteria** in the **Ontology Manager**. - """ - - result: ValidationResult - - model_config = {"extra": "allow"} - - def to_dict(self) -> SubmissionCriteriaEvaluationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - SubmissionCriteriaEvaluationDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_submission_criteria_evaluation_dict.py b/foundry/v2/models/_submission_criteria_evaluation_dict.py deleted file mode 100644 index 4101d810..00000000 --- a/foundry/v2/models/_submission_criteria_evaluation_dict.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._validation_result import ValidationResult - - -class SubmissionCriteriaEvaluationDict(TypedDict): - """ - Contains the status of the **submission criteria**. - **Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. - These are configured in the **Ontology Manager**. - """ - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - configuredFailureMessage: NotRequired[StrictStr] - """ - The message indicating one of the **submission criteria** was not satisfied. - This is configured per **submission criteria** in the **Ontology Manager**. - """ - - result: ValidationResult diff --git a/foundry/v2/models/_subscription_closed.py b/foundry/v2/models/_subscription_closed.py deleted file mode 100644 index 419cc988..00000000 --- a/foundry/v2/models/_subscription_closed.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._subscription_closed_dict import SubscriptionClosedDict -from foundry.v2.models._subscription_closure_cause import SubscriptionClosureCause -from foundry.v2.models._subscription_id import SubscriptionId - - -class SubscriptionClosed(BaseModel): - """The subscription has been closed due to an irrecoverable error during its lifecycle.""" - - id: SubscriptionId - - cause: SubscriptionClosureCause - - type: Literal["subscriptionClosed"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> SubscriptionClosedDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SubscriptionClosedDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_subscription_closed_dict.py b/foundry/v2/models/_subscription_closed_dict.py deleted file mode 100644 index d8d65ca4..00000000 --- a/foundry/v2/models/_subscription_closed_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._subscription_closure_cause_dict import SubscriptionClosureCauseDict # NOQA -from foundry.v2.models._subscription_id import SubscriptionId - - -class SubscriptionClosedDict(TypedDict): - """The subscription has been closed due to an irrecoverable error during its lifecycle.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - id: SubscriptionId - - cause: SubscriptionClosureCauseDict - - type: Literal["subscriptionClosed"] diff --git a/foundry/v2/models/_subscription_closure_cause.py b/foundry/v2/models/_subscription_closure_cause.py deleted file mode 100644 index 16627afe..00000000 --- a/foundry/v2/models/_subscription_closure_cause.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._error import Error -from foundry.v2.models._reason import Reason - -SubscriptionClosureCause = Annotated[Union[Error, Reason], Field(discriminator="type")] -"""SubscriptionClosureCause""" diff --git a/foundry/v2/models/_subscription_closure_cause_dict.py b/foundry/v2/models/_subscription_closure_cause_dict.py deleted file mode 100644 index 00f5f70f..00000000 --- a/foundry/v2/models/_subscription_closure_cause_dict.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._error_dict import ErrorDict -from foundry.v2.models._reason_dict import ReasonDict - -SubscriptionClosureCauseDict = Annotated[Union[ErrorDict, ReasonDict], Field(discriminator="type")] -"""SubscriptionClosureCause""" diff --git a/foundry/v2/models/_subscription_error.py b/foundry/v2/models/_subscription_error.py deleted file mode 100644 index ac0e1d53..00000000 --- a/foundry/v2/models/_subscription_error.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._error import Error -from foundry.v2.models._subscription_error_dict import SubscriptionErrorDict - - -class SubscriptionError(BaseModel): - """SubscriptionError""" - - errors: List[Error] - - type: Literal["error"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> SubscriptionErrorDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SubscriptionErrorDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_subscription_error_dict.py b/foundry/v2/models/_subscription_error_dict.py deleted file mode 100644 index db2e9075..00000000 --- a/foundry/v2/models/_subscription_error_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import List -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._error_dict import ErrorDict - - -class SubscriptionErrorDict(TypedDict): - """SubscriptionError""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - errors: List[ErrorDict] - - type: Literal["error"] diff --git a/foundry/v2/models/_subscription_id.py b/foundry/v2/models/_subscription_id.py deleted file mode 100644 index 97558790..00000000 --- a/foundry/v2/models/_subscription_id.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import UUID - -SubscriptionId = UUID -"""A unique identifier used to associate subscription requests with responses.""" diff --git a/foundry/v2/models/_subscription_success.py b/foundry/v2/models/_subscription_success.py deleted file mode 100644 index 11c9af76..00000000 --- a/foundry/v2/models/_subscription_success.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._subscription_id import SubscriptionId -from foundry.v2.models._subscription_success_dict import SubscriptionSuccessDict - - -class SubscriptionSuccess(BaseModel): - """SubscriptionSuccess""" - - id: SubscriptionId - - type: Literal["success"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> SubscriptionSuccessDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SubscriptionSuccessDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_subscription_success_dict.py b/foundry/v2/models/_subscription_success_dict.py deleted file mode 100644 index e08d5974..00000000 --- a/foundry/v2/models/_subscription_success_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._subscription_id import SubscriptionId - - -class SubscriptionSuccessDict(TypedDict): - """SubscriptionSuccess""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - id: SubscriptionId - - type: Literal["success"] diff --git a/foundry/v2/models/_sum_aggregation.py b/foundry/v2/models/_sum_aggregation.py deleted file mode 100644 index af92fb0a..00000000 --- a/foundry/v2/models/_sum_aggregation.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._field_name_v1 import FieldNameV1 -from foundry.v2.models._sum_aggregation_dict import SumAggregationDict - - -class SumAggregation(BaseModel): - """Computes the sum of values for the provided field.""" - - field: FieldNameV1 - - name: Optional[AggregationMetricName] = None - - type: Literal["sum"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> SumAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SumAggregationDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_sum_aggregation_dict.py b/foundry/v2/models/_sum_aggregation_dict.py deleted file mode 100644 index f5aa3e67..00000000 --- a/foundry/v2/models/_sum_aggregation_dict.py +++ /dev/null @@ -1,36 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._field_name_v1 import FieldNameV1 - - -class SumAggregationDict(TypedDict): - """Computes the sum of values for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: FieldNameV1 - - name: NotRequired[AggregationMetricName] - - type: Literal["sum"] diff --git a/foundry/v2/models/_sum_aggregation_v2.py b/foundry/v2/models/_sum_aggregation_v2.py deleted file mode 100644 index 2e92939e..00000000 --- a/foundry/v2/models/_sum_aggregation_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._sum_aggregation_v2_dict import SumAggregationV2Dict - - -class SumAggregationV2(BaseModel): - """Computes the sum of values for the provided field.""" - - field: PropertyApiName - - name: Optional[AggregationMetricName] = None - - direction: Optional[OrderByDirection] = None - - type: Literal["sum"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> SumAggregationV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(SumAggregationV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_sum_aggregation_v2_dict.py b/foundry/v2/models/_sum_aggregation_v2_dict.py deleted file mode 100644 index 233114cf..00000000 --- a/foundry/v2/models/_sum_aggregation_v2_dict.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._aggregation_metric_name import AggregationMetricName -from foundry.v2.models._order_by_direction import OrderByDirection -from foundry.v2.models._property_api_name import PropertyApiName - - -class SumAggregationV2Dict(TypedDict): - """Computes the sum of values for the provided field.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - name: NotRequired[AggregationMetricName] - - direction: NotRequired[OrderByDirection] - - type: Literal["sum"] diff --git a/foundry/v2/models/_sync_apply_action_response_v2.py b/foundry/v2/models/_sync_apply_action_response_v2.py deleted file mode 100644 index a068dc5a..00000000 --- a/foundry/v2/models/_sync_apply_action_response_v2.py +++ /dev/null @@ -1,43 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._action_results import ActionResults -from foundry.v2.models._sync_apply_action_response_v2_dict import ( - SyncApplyActionResponseV2Dict, -) # NOQA -from foundry.v2.models._validate_action_response_v2 import ValidateActionResponseV2 - - -class SyncApplyActionResponseV2(BaseModel): - """SyncApplyActionResponseV2""" - - validation: Optional[ValidateActionResponseV2] = None - - edits: Optional[ActionResults] = None - - model_config = {"extra": "allow"} - - def to_dict(self) -> SyncApplyActionResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - SyncApplyActionResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_sync_apply_action_response_v2_dict.py b/foundry/v2/models/_sync_apply_action_response_v2_dict.py deleted file mode 100644 index 3fdd3f51..00000000 --- a/foundry/v2/models/_sync_apply_action_response_v2_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._action_results_dict import ActionResultsDict -from foundry.v2.models._validate_action_response_v2_dict import ValidateActionResponseV2Dict # NOQA - - -class SyncApplyActionResponseV2Dict(TypedDict): - """SyncApplyActionResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - validation: NotRequired[ValidateActionResponseV2Dict] - - edits: NotRequired[ActionResultsDict] diff --git a/foundry/v2/models/_three_dimensional_aggregation.py b/foundry/v2/models/_three_dimensional_aggregation.py deleted file mode 100644 index df2404fc..00000000 --- a/foundry/v2/models/_three_dimensional_aggregation.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._query_aggregation_key_type import QueryAggregationKeyType -from foundry.v2.models._three_dimensional_aggregation_dict import ( - ThreeDimensionalAggregationDict, -) # NOQA -from foundry.v2.models._two_dimensional_aggregation import TwoDimensionalAggregation - - -class ThreeDimensionalAggregation(BaseModel): - """ThreeDimensionalAggregation""" - - key_type: QueryAggregationKeyType = Field(alias="keyType") - - value_type: TwoDimensionalAggregation = Field(alias="valueType") - - type: Literal["threeDimensionalAggregation"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ThreeDimensionalAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ThreeDimensionalAggregationDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_three_dimensional_aggregation_dict.py b/foundry/v2/models/_three_dimensional_aggregation_dict.py deleted file mode 100644 index 1c4801f3..00000000 --- a/foundry/v2/models/_three_dimensional_aggregation_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._query_aggregation_key_type_dict import QueryAggregationKeyTypeDict # NOQA -from foundry.v2.models._two_dimensional_aggregation_dict import ( - TwoDimensionalAggregationDict, -) # NOQA - - -class ThreeDimensionalAggregationDict(TypedDict): - """ThreeDimensionalAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyType: QueryAggregationKeyTypeDict - - valueType: TwoDimensionalAggregationDict - - type: Literal["threeDimensionalAggregation"] diff --git a/foundry/v2/models/_time_range.py b/foundry/v2/models/_time_range.py deleted file mode 100644 index ac367924..00000000 --- a/foundry/v2/models/_time_range.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._absolute_time_range import AbsoluteTimeRange -from foundry.v2.models._relative_time_range import RelativeTimeRange - -TimeRange = Annotated[Union[AbsoluteTimeRange, RelativeTimeRange], Field(discriminator="type")] -"""An absolute or relative range for a time series query.""" diff --git a/foundry/v2/models/_time_range_dict.py b/foundry/v2/models/_time_range_dict.py deleted file mode 100644 index 72e38afc..00000000 --- a/foundry/v2/models/_time_range_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._absolute_time_range_dict import AbsoluteTimeRangeDict -from foundry.v2.models._relative_time_range_dict import RelativeTimeRangeDict - -TimeRangeDict = Annotated[ - Union[AbsoluteTimeRangeDict, RelativeTimeRangeDict], Field(discriminator="type") -] -"""An absolute or relative range for a time series query.""" diff --git a/foundry/v2/models/_time_series_item_type.py b/foundry/v2/models/_time_series_item_type.py deleted file mode 100644 index d815566f..00000000 --- a/foundry/v2/models/_time_series_item_type.py +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._double_type import DoubleType -from foundry.v2.models._string_type import StringType - -TimeSeriesItemType = Annotated[Union[DoubleType, StringType], Field(discriminator="type")] -"""A union of the types supported by time series properties.""" diff --git a/foundry/v2/models/_time_series_item_type_dict.py b/foundry/v2/models/_time_series_item_type_dict.py deleted file mode 100644 index 4258e2c8..00000000 --- a/foundry/v2/models/_time_series_item_type_dict.py +++ /dev/null @@ -1,29 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import Union - -from pydantic import Field - -from foundry.v2.models._double_type_dict import DoubleTypeDict -from foundry.v2.models._string_type_dict import StringTypeDict - -TimeSeriesItemTypeDict = Annotated[ - Union[DoubleTypeDict, StringTypeDict], Field(discriminator="type") -] -"""A union of the types supported by time series properties.""" diff --git a/foundry/v2/models/_time_series_point.py b/foundry/v2/models/_time_series_point.py deleted file mode 100644 index a638d1c4..00000000 --- a/foundry/v2/models/_time_series_point.py +++ /dev/null @@ -1,40 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime -from typing import Any -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._time_series_point_dict import TimeSeriesPointDict - - -class TimeSeriesPoint(BaseModel): - """A time and value pair.""" - - time: datetime - """An ISO 8601 timestamp""" - - value: Any - """An object which is either an enum String or a double number.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> TimeSeriesPointDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(TimeSeriesPointDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_time_series_point_dict.py b/foundry/v2/models/_time_series_point_dict.py deleted file mode 100644 index cee4fdc5..00000000 --- a/foundry/v2/models/_time_series_point_dict.py +++ /dev/null @@ -1,33 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime -from typing import Any - -from typing_extensions import TypedDict - - -class TimeSeriesPointDict(TypedDict): - """A time and value pair.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - time: datetime - """An ISO 8601 timestamp""" - - value: Any - """An object which is either an enum String or a double number.""" diff --git a/foundry/v2/models/_timeseries_type.py b/foundry/v2/models/_timeseries_type.py deleted file mode 100644 index ecf58221..00000000 --- a/foundry/v2/models/_timeseries_type.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._time_series_item_type import TimeSeriesItemType -from foundry.v2.models._timeseries_type_dict import TimeseriesTypeDict - - -class TimeseriesType(BaseModel): - """TimeseriesType""" - - item_type: TimeSeriesItemType = Field(alias="itemType") - - type: Literal["timeseries"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> TimeseriesTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(TimeseriesTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_timeseries_type_dict.py b/foundry/v2/models/_timeseries_type_dict.py deleted file mode 100644 index 3f39f883..00000000 --- a/foundry/v2/models/_timeseries_type_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._time_series_item_type_dict import TimeSeriesItemTypeDict - - -class TimeseriesTypeDict(TypedDict): - """TimeseriesType""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - itemType: TimeSeriesItemTypeDict - - type: Literal["timeseries"] diff --git a/foundry/v2/models/_timestamp_type.py b/foundry/v2/models/_timestamp_type.py deleted file mode 100644 index 49e6e49a..00000000 --- a/foundry/v2/models/_timestamp_type.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._timestamp_type_dict import TimestampTypeDict - - -class TimestampType(BaseModel): - """TimestampType""" - - type: Literal["timestamp"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> TimestampTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(TimestampTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_transaction.py b/foundry/v2/models/_transaction.py deleted file mode 100644 index 3b28a351..00000000 --- a/foundry/v2/models/_transaction.py +++ /dev/null @@ -1,51 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime -from typing import Optional -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._transaction_created_time import TransactionCreatedTime -from foundry.v2.models._transaction_dict import TransactionDict -from foundry.v2.models._transaction_rid import TransactionRid -from foundry.v2.models._transaction_status import TransactionStatus -from foundry.v2.models._transaction_type import TransactionType - - -class Transaction(BaseModel): - """Transaction""" - - rid: TransactionRid - - transaction_type: TransactionType = Field(alias="transactionType") - - status: TransactionStatus - - created_time: TransactionCreatedTime = Field(alias="createdTime") - """The timestamp when the transaction was created, in ISO 8601 timestamp format.""" - - closed_time: Optional[datetime] = Field(alias="closedTime", default=None) - """The timestamp when the transaction was closed, in ISO 8601 timestamp format.""" - - model_config = {"extra": "allow"} - - def to_dict(self) -> TransactionDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(TransactionDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_transaction_dict.py b/foundry/v2/models/_transaction_dict.py deleted file mode 100644 index d0effbd9..00000000 --- a/foundry/v2/models/_transaction_dict.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from datetime import datetime - -from typing_extensions import NotRequired -from typing_extensions import TypedDict - -from foundry.v2.models._transaction_created_time import TransactionCreatedTime -from foundry.v2.models._transaction_rid import TransactionRid -from foundry.v2.models._transaction_status import TransactionStatus -from foundry.v2.models._transaction_type import TransactionType - - -class TransactionDict(TypedDict): - """Transaction""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - rid: TransactionRid - - transactionType: TransactionType - - status: TransactionStatus - - createdTime: TransactionCreatedTime - """The timestamp when the transaction was created, in ISO 8601 timestamp format.""" - - closedTime: NotRequired[datetime] - """The timestamp when the transaction was closed, in ISO 8601 timestamp format.""" diff --git a/foundry/v2/models/_trashed_status.py b/foundry/v2/models/_trashed_status.py deleted file mode 100644 index 59a7001a..00000000 --- a/foundry/v2/models/_trashed_status.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -TrashedStatus = Literal["DIRECTLY_TRASHED", "ANCESTOR_TRASHED", "NOT_TRASHED"] -"""TrashedStatus""" diff --git a/foundry/v2/models/_trigger.py b/foundry/v2/models/_trigger.py deleted file mode 100644 index 87542542..00000000 --- a/foundry/v2/models/_trigger.py +++ /dev/null @@ -1,78 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._dataset_updated_trigger import DatasetUpdatedTrigger -from foundry.v2.models._job_succeeded_trigger import JobSucceededTrigger -from foundry.v2.models._media_set_updated_trigger import MediaSetUpdatedTrigger -from foundry.v2.models._new_logic_trigger import NewLogicTrigger -from foundry.v2.models._schedule_succeeded_trigger import ScheduleSucceededTrigger -from foundry.v2.models._time_trigger import TimeTrigger -from foundry.v2.models._trigger_dict import AndTriggerDict -from foundry.v2.models._trigger_dict import OrTriggerDict - - -class AndTrigger(BaseModel): - """Trigger after all of the given triggers emit an event.""" - - triggers: List[Trigger] - - type: Literal["and"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> AndTriggerDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(AndTriggerDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -class OrTrigger(BaseModel): - """Trigger whenever any of the given triggers emit an event.""" - - triggers: List[Trigger] - - type: Literal["or"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> OrTriggerDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(OrTriggerDict, self.model_dump(by_alias=True, exclude_unset=True)) - - -Trigger = Annotated[ - Union[ - AndTrigger, - OrTrigger, - TimeTrigger, - DatasetUpdatedTrigger, - NewLogicTrigger, - JobSucceededTrigger, - ScheduleSucceededTrigger, - MediaSetUpdatedTrigger, - ], - Field(discriminator="type"), -] -"""Trigger""" diff --git a/foundry/v2/models/_trigger_dict.py b/foundry/v2/models/_trigger_dict.py deleted file mode 100644 index fb8176f9..00000000 --- a/foundry/v2/models/_trigger_dict.py +++ /dev/null @@ -1,67 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Annotated -from typing import List -from typing import Literal -from typing import Union - -from pydantic import Field -from typing_extensions import TypedDict - -from foundry.v2.models._dataset_updated_trigger_dict import DatasetUpdatedTriggerDict -from foundry.v2.models._job_succeeded_trigger_dict import JobSucceededTriggerDict -from foundry.v2.models._media_set_updated_trigger_dict import MediaSetUpdatedTriggerDict -from foundry.v2.models._new_logic_trigger_dict import NewLogicTriggerDict -from foundry.v2.models._schedule_succeeded_trigger_dict import ScheduleSucceededTriggerDict # NOQA -from foundry.v2.models._time_trigger_dict import TimeTriggerDict - - -class AndTriggerDict(TypedDict): - """Trigger after all of the given triggers emit an event.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - triggers: List[TriggerDict] - - type: Literal["and"] - - -class OrTriggerDict(TypedDict): - """Trigger whenever any of the given triggers emit an event.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - triggers: List[TriggerDict] - - type: Literal["or"] - - -TriggerDict = Annotated[ - Union[ - AndTriggerDict, - OrTriggerDict, - TimeTriggerDict, - DatasetUpdatedTriggerDict, - NewLogicTriggerDict, - JobSucceededTriggerDict, - ScheduleSucceededTriggerDict, - MediaSetUpdatedTriggerDict, - ], - Field(discriminator="type"), -] -"""Trigger""" diff --git a/foundry/v2/models/_two_dimensional_aggregation.py b/foundry/v2/models/_two_dimensional_aggregation.py deleted file mode 100644 index 323fb758..00000000 --- a/foundry/v2/models/_two_dimensional_aggregation.py +++ /dev/null @@ -1,46 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._query_aggregation_key_type import QueryAggregationKeyType -from foundry.v2.models._query_aggregation_value_type import QueryAggregationValueType -from foundry.v2.models._two_dimensional_aggregation_dict import ( - TwoDimensionalAggregationDict, -) # NOQA - - -class TwoDimensionalAggregation(BaseModel): - """TwoDimensionalAggregation""" - - key_type: QueryAggregationKeyType = Field(alias="keyType") - - value_type: QueryAggregationValueType = Field(alias="valueType") - - type: Literal["twoDimensionalAggregation"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> TwoDimensionalAggregationDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - TwoDimensionalAggregationDict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_two_dimensional_aggregation_dict.py b/foundry/v2/models/_two_dimensional_aggregation_dict.py deleted file mode 100644 index 7bb19801..00000000 --- a/foundry/v2/models/_two_dimensional_aggregation_dict.py +++ /dev/null @@ -1,37 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._query_aggregation_key_type_dict import QueryAggregationKeyTypeDict # NOQA -from foundry.v2.models._query_aggregation_value_type_dict import ( - QueryAggregationValueTypeDict, -) # NOQA - - -class TwoDimensionalAggregationDict(TypedDict): - """TwoDimensionalAggregation""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - keyType: QueryAggregationKeyTypeDict - - valueType: QueryAggregationValueTypeDict - - type: Literal["twoDimensionalAggregation"] diff --git a/foundry/v2/models/_unevaluable_constraint.py b/foundry/v2/models/_unevaluable_constraint.py deleted file mode 100644 index 9bdefca3..00000000 --- a/foundry/v2/models/_unevaluable_constraint.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._unevaluable_constraint_dict import UnevaluableConstraintDict - - -class UnevaluableConstraint(BaseModel): - """ - The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. - This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. - """ - - type: Literal["unevaluable"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> UnevaluableConstraintDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(UnevaluableConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_unsupported_type.py b/foundry/v2/models/_unsupported_type.py deleted file mode 100644 index b4942fd5..00000000 --- a/foundry/v2/models/_unsupported_type.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel -from pydantic import Field -from pydantic import StrictStr - -from foundry.v2.models._unsupported_type_dict import UnsupportedTypeDict - - -class UnsupportedType(BaseModel): - """UnsupportedType""" - - unsupported_type: StrictStr = Field(alias="unsupportedType") - - type: Literal["unsupported"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> UnsupportedTypeDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(UnsupportedTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_user_id.py b/foundry/v2/models/_user_id.py deleted file mode 100644 index 26cb7385..00000000 --- a/foundry/v2/models/_user_id.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry._core.utils import UUID - -UserId = UUID -"""A Foundry User ID.""" diff --git a/foundry/v2/models/_user_search_filter.py b/foundry/v2/models/_user_search_filter.py deleted file mode 100644 index 06a99126..00000000 --- a/foundry/v2/models/_user_search_filter.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import cast - -from pydantic import BaseModel -from pydantic import StrictStr - -from foundry.v2.models._principal_filter_type import PrincipalFilterType -from foundry.v2.models._user_search_filter_dict import UserSearchFilterDict - - -class UserSearchFilter(BaseModel): - """UserSearchFilter""" - - type: PrincipalFilterType - - value: StrictStr - - model_config = {"extra": "allow"} - - def to_dict(self) -> UserSearchFilterDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(UserSearchFilterDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_validate_action_request.py b/foundry/v2/models/_validate_action_request.py deleted file mode 100644 index 58ffe2af..00000000 --- a/foundry/v2/models/_validate_action_request.py +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._validate_action_request_dict import ValidateActionRequestDict - - -class ValidateActionRequest(BaseModel): - """ValidateActionRequest""" - - parameters: Dict[ParameterId, Optional[DataValue]] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ValidateActionRequestDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ValidateActionRequestDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_validate_action_request_dict.py b/foundry/v2/models/_validate_action_request_dict.py deleted file mode 100644 index 77bd241d..00000000 --- a/foundry/v2/models/_validate_action_request_dict.py +++ /dev/null @@ -1,32 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import Optional - -from typing_extensions import TypedDict - -from foundry.v2.models._data_value import DataValue -from foundry.v2.models._parameter_id import ParameterId - - -class ValidateActionRequestDict(TypedDict): - """ValidateActionRequest""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v2/models/_validate_action_response.py b/foundry/v2/models/_validate_action_response.py deleted file mode 100644 index c158bc68..00000000 --- a/foundry/v2/models/_validate_action_response.py +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._parameter_evaluation_result import ParameterEvaluationResult -from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._submission_criteria_evaluation import SubmissionCriteriaEvaluation # NOQA -from foundry.v2.models._validate_action_response_dict import ValidateActionResponseDict -from foundry.v2.models._validation_result import ValidationResult - - -class ValidateActionResponse(BaseModel): - """ValidateActionResponse""" - - result: ValidationResult - - submission_criteria: List[SubmissionCriteriaEvaluation] = Field(alias="submissionCriteria") - - parameters: Dict[ParameterId, ParameterEvaluationResult] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ValidateActionResponseDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(ValidateActionResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_validate_action_response_dict.py b/foundry/v2/models/_validate_action_response_dict.py deleted file mode 100644 index 7055e6ba..00000000 --- a/foundry/v2/models/_validate_action_response_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._parameter_evaluation_result_dict import ( - ParameterEvaluationResultDict, -) # NOQA -from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._submission_criteria_evaluation_dict import ( - SubmissionCriteriaEvaluationDict, -) # NOQA -from foundry.v2.models._validation_result import ValidationResult - - -class ValidateActionResponseDict(TypedDict): - """ValidateActionResponse""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - result: ValidationResult - - submissionCriteria: List[SubmissionCriteriaEvaluationDict] - - parameters: Dict[ParameterId, ParameterEvaluationResultDict] diff --git a/foundry/v2/models/_validate_action_response_v2.py b/foundry/v2/models/_validate_action_response_v2.py deleted file mode 100644 index 00a5fff4..00000000 --- a/foundry/v2/models/_validate_action_response_v2.py +++ /dev/null @@ -1,47 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List -from typing import cast - -from pydantic import BaseModel -from pydantic import Field - -from foundry.v2.models._parameter_evaluation_result import ParameterEvaluationResult -from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._submission_criteria_evaluation import SubmissionCriteriaEvaluation # NOQA -from foundry.v2.models._validate_action_response_v2_dict import ValidateActionResponseV2Dict # NOQA -from foundry.v2.models._validation_result import ValidationResult - - -class ValidateActionResponseV2(BaseModel): - """ValidateActionResponseV2""" - - result: ValidationResult - - submission_criteria: List[SubmissionCriteriaEvaluation] = Field(alias="submissionCriteria") - - parameters: Dict[ParameterId, ParameterEvaluationResult] - - model_config = {"extra": "allow"} - - def to_dict(self) -> ValidateActionResponseV2Dict: - """Return the dictionary representation of the model using the field aliases.""" - return cast( - ValidateActionResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) - ) diff --git a/foundry/v2/models/_validate_action_response_v2_dict.py b/foundry/v2/models/_validate_action_response_v2_dict.py deleted file mode 100644 index 2993396d..00000000 --- a/foundry/v2/models/_validate_action_response_v2_dict.py +++ /dev/null @@ -1,42 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Dict -from typing import List - -from typing_extensions import TypedDict - -from foundry.v2.models._parameter_evaluation_result_dict import ( - ParameterEvaluationResultDict, -) # NOQA -from foundry.v2.models._parameter_id import ParameterId -from foundry.v2.models._submission_criteria_evaluation_dict import ( - SubmissionCriteriaEvaluationDict, -) # NOQA -from foundry.v2.models._validation_result import ValidationResult - - -class ValidateActionResponseV2Dict(TypedDict): - """ValidateActionResponseV2""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - result: ValidationResult - - submissionCriteria: List[SubmissionCriteriaEvaluationDict] - - parameters: Dict[ParameterId, ParameterEvaluationResultDict] diff --git a/foundry/v2/models/_value_type.py b/foundry/v2/models/_value_type.py deleted file mode 100644 index ef9c5d6d..00000000 --- a/foundry/v2/models/_value_type.py +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from pydantic import StrictStr - -ValueType = StrictStr -""" -A string indicating the type of each data value. Note that these types can be nested, for example an array of -structs. - -| Type | JSON value | -|---------------------|-------------------------------------------------------------------------------------------------------------------| -| Array | `Array`, where `T` is the type of the array elements, e.g. `Array`. | -| Attachment | `Attachment` | -| Boolean | `Boolean` | -| Byte | `Byte` | -| Date | `LocalDate` | -| Decimal | `Decimal` | -| Double | `Double` | -| Float | `Float` | -| Integer | `Integer` | -| Long | `Long` | -| Marking | `Marking` | -| OntologyObject | `OntologyObject` where `T` is the API name of the referenced object type. | -| Short | `Short` | -| String | `String` | -| Struct | `Struct` where `T` contains field name and type pairs, e.g. `Struct<{ firstName: String, lastName: string }>` | -| Timeseries | `TimeSeries` where `T` is either `String` for an enum series or `Double` for a numeric series. | -| Timestamp | `Timestamp` | -""" diff --git a/foundry/v2/models/_within_bounding_box_point.py b/foundry/v2/models/_within_bounding_box_point.py deleted file mode 100644 index 7f89a965..00000000 --- a/foundry/v2/models/_within_bounding_box_point.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v2.models._geo_point import GeoPoint - -WithinBoundingBoxPoint = GeoPoint -"""WithinBoundingBoxPoint""" diff --git a/foundry/v2/models/_within_bounding_box_point_dict.py b/foundry/v2/models/_within_bounding_box_point_dict.py deleted file mode 100644 index db87772e..00000000 --- a/foundry/v2/models/_within_bounding_box_point_dict.py +++ /dev/null @@ -1,21 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from foundry.v2.models._geo_point_dict import GeoPointDict - -WithinBoundingBoxPointDict = GeoPointDict -"""WithinBoundingBoxPoint""" diff --git a/foundry/v2/models/_within_bounding_box_query.py b/foundry/v2/models/_within_bounding_box_query.py deleted file mode 100644 index 44c004f2..00000000 --- a/foundry/v2/models/_within_bounding_box_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._bounding_box_value import BoundingBoxValue -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._within_bounding_box_query_dict import WithinBoundingBoxQueryDict - - -class WithinBoundingBoxQuery(BaseModel): - """Returns objects where the specified field contains a point within the bounding box provided.""" - - field: PropertyApiName - - value: BoundingBoxValue - - type: Literal["withinBoundingBox"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> WithinBoundingBoxQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(WithinBoundingBoxQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_within_bounding_box_query_dict.py b/foundry/v2/models/_within_bounding_box_query_dict.py deleted file mode 100644 index d45bafdc..00000000 --- a/foundry/v2/models/_within_bounding_box_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._bounding_box_value_dict import BoundingBoxValueDict -from foundry.v2.models._property_api_name import PropertyApiName - - -class WithinBoundingBoxQueryDict(TypedDict): - """Returns objects where the specified field contains a point within the bounding box provided.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: BoundingBoxValueDict - - type: Literal["withinBoundingBox"] diff --git a/foundry/v2/models/_within_distance_of_query.py b/foundry/v2/models/_within_distance_of_query.py deleted file mode 100644 index e5478df6..00000000 --- a/foundry/v2/models/_within_distance_of_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._center_point import CenterPoint -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._within_distance_of_query_dict import WithinDistanceOfQueryDict - - -class WithinDistanceOfQuery(BaseModel): - """Returns objects where the specified field contains a point within the distance provided of the center point.""" - - field: PropertyApiName - - value: CenterPoint - - type: Literal["withinDistanceOf"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> WithinDistanceOfQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(WithinDistanceOfQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_within_distance_of_query_dict.py b/foundry/v2/models/_within_distance_of_query_dict.py deleted file mode 100644 index c0608bd2..00000000 --- a/foundry/v2/models/_within_distance_of_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._center_point_dict import CenterPointDict -from foundry.v2.models._property_api_name import PropertyApiName - - -class WithinDistanceOfQueryDict(TypedDict): - """Returns objects where the specified field contains a point within the distance provided of the center point.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: CenterPointDict - - type: Literal["withinDistanceOf"] diff --git a/foundry/v2/models/_within_polygon_query.py b/foundry/v2/models/_within_polygon_query.py deleted file mode 100644 index 5f688a22..00000000 --- a/foundry/v2/models/_within_polygon_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal -from typing import cast - -from pydantic import BaseModel - -from foundry.v2.models._polygon_value import PolygonValue -from foundry.v2.models._property_api_name import PropertyApiName -from foundry.v2.models._within_polygon_query_dict import WithinPolygonQueryDict - - -class WithinPolygonQuery(BaseModel): - """Returns objects where the specified field contains a point within the polygon provided.""" - - field: PropertyApiName - - value: PolygonValue - - type: Literal["withinPolygon"] - - model_config = {"extra": "allow"} - - def to_dict(self) -> WithinPolygonQueryDict: - """Return the dictionary representation of the model using the field aliases.""" - return cast(WithinPolygonQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_within_polygon_query_dict.py b/foundry/v2/models/_within_polygon_query_dict.py deleted file mode 100644 index 52295e8c..00000000 --- a/foundry/v2/models/_within_polygon_query_dict.py +++ /dev/null @@ -1,35 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - - -from __future__ import annotations - -from typing import Literal - -from typing_extensions import TypedDict - -from foundry.v2.models._polygon_value_dict import PolygonValueDict -from foundry.v2.models._property_api_name import PropertyApiName - - -class WithinPolygonQueryDict(TypedDict): - """Returns objects where the specified field contains a point within the polygon provided.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - field: PropertyApiName - - value: PolygonValueDict - - type: Literal["withinPolygon"] diff --git a/foundry/v2/ontologies/action.py b/foundry/v2/ontologies/action.py new file mode 100644 index 00000000..30fe518c --- /dev/null +++ b/foundry/v2/ontologies/action.py @@ -0,0 +1,207 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import List +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v2.ontologies.models._action_type_api_name import ActionTypeApiName +from foundry.v2.ontologies.models._apply_action_request_options_dict import ( + ApplyActionRequestOptionsDict, +) # NOQA +from foundry.v2.ontologies.models._artifact_repository_rid import ArtifactRepositoryRid +from foundry.v2.ontologies.models._batch_apply_action_request_item_dict import ( + BatchApplyActionRequestItemDict, +) # NOQA +from foundry.v2.ontologies.models._batch_apply_action_request_options_dict import ( + BatchApplyActionRequestOptionsDict, +) # NOQA +from foundry.v2.ontologies.models._batch_apply_action_response_v2 import ( + BatchApplyActionResponseV2, +) # NOQA +from foundry.v2.ontologies.models._data_value import DataValue +from foundry.v2.ontologies.models._ontology_identifier import OntologyIdentifier +from foundry.v2.ontologies.models._parameter_id import ParameterId +from foundry.v2.ontologies.models._sdk_package_name import SdkPackageName +from foundry.v2.ontologies.models._sync_apply_action_response_v2 import ( + SyncApplyActionResponseV2, +) # NOQA + + +class ActionClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def apply( + self, + ontology: OntologyIdentifier, + action: ActionTypeApiName, + *, + parameters: Dict[ParameterId, Optional[DataValue]], + artifact_repository: Optional[ArtifactRepositoryRid] = None, + options: Optional[ApplyActionRequestOptionsDict] = None, + package_name: Optional[SdkPackageName] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> SyncApplyActionResponseV2: + """ + Applies an action using the given parameters. + + Changes to the Ontology are eventually consistent and may take some time to be visible. + + Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by + this endpoint. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read api:ontologies-write`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param action: action + :type action: ActionTypeApiName + :param parameters: + :type parameters: Dict[ParameterId, Optional[DataValue]] + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param options: + :type options: Optional[ApplyActionRequestOptionsDict] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: SyncApplyActionResponseV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/actions/{action}/apply", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + "action": action, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "options": options, + "parameters": parameters, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "options": Optional[ApplyActionRequestOptionsDict], + "parameters": Dict[ParameterId, Optional[DataValue]], + }, + ), + response_type=SyncApplyActionResponseV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def apply_batch( + self, + ontology: OntologyIdentifier, + action: ActionTypeApiName, + *, + requests: List[BatchApplyActionRequestItemDict], + artifact_repository: Optional[ArtifactRepositoryRid] = None, + options: Optional[BatchApplyActionRequestOptionsDict] = None, + package_name: Optional[SdkPackageName] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> BatchApplyActionResponseV2: + """ + Applies multiple actions (of the same Action Type) using the given parameters. + Changes to the Ontology are eventually consistent and may take some time to be visible. + + Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not + call Functions may receive a higher limit. + + Note that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read api:ontologies-write`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param action: action + :type action: ActionTypeApiName + :param requests: + :type requests: List[BatchApplyActionRequestItemDict] + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param options: + :type options: Optional[BatchApplyActionRequestOptionsDict] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: BatchApplyActionResponseV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/actions/{action}/applyBatch", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + "action": action, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "options": options, + "requests": requests, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "options": Optional[BatchApplyActionRequestOptionsDict], + "requests": List[BatchApplyActionRequestItemDict], + }, + ), + response_type=BatchApplyActionResponseV2, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/ontologies/action_type.py b/foundry/v2/ontologies/action_type.py new file mode 100644 index 00000000..4c6311f3 --- /dev/null +++ b/foundry/v2/ontologies/action_type.py @@ -0,0 +1,185 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._action_type_api_name import ActionTypeApiName +from foundry.v2.ontologies.models._action_type_v2 import ActionTypeV2 +from foundry.v2.ontologies.models._list_action_types_response_v2 import ( + ListActionTypesResponseV2, +) # NOQA +from foundry.v2.ontologies.models._ontology_identifier import OntologyIdentifier + + +class ActionTypeClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get( + self, + ontology: OntologyIdentifier, + action_type: ActionTypeApiName, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ActionTypeV2: + """ + Gets a specific action type with the given API name. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param action_type: actionType + :type action_type: ActionTypeApiName + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ActionTypeV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/actionTypes/{actionType}", + query_params={}, + path_params={ + "ontology": ontology, + "actionType": action_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ActionTypeV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + ontology: OntologyIdentifier, + *, + page_size: Optional[PageSize] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[ActionTypeV2]: + """ + Lists the action types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[ActionTypeV2] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/actionTypes", + query_params={ + "pageSize": page_size, + }, + path_params={ + "ontology": ontology, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListActionTypesResponseV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + ontology: OntologyIdentifier, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListActionTypesResponseV2: + """ + Lists the action types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListActionTypesResponseV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/actionTypes", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + }, + path_params={ + "ontology": ontology, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListActionTypesResponseV2, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/ontologies/attachment.py b/foundry/v2/ontologies/attachment.py new file mode 100644 index 00000000..46557ef2 --- /dev/null +++ b/foundry/v2/ontologies/attachment.py @@ -0,0 +1,136 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v2.core.models._content_length import ContentLength +from foundry.v2.core.models._content_type import ContentType +from foundry.v2.core.models._filename import Filename +from foundry.v2.ontologies.models._attachment_rid import AttachmentRid +from foundry.v2.ontologies.models._attachment_v2 import AttachmentV2 + + +class AttachmentClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def read( + self, + attachment_rid: AttachmentRid, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> bytes: + """ + Get the content of an attachment. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param attachment_rid: attachmentRid + :type attachment_rid: AttachmentRid + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: bytes + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/attachments/{attachmentRid}/content", + query_params={}, + path_params={ + "attachmentRid": attachment_rid, + }, + header_params={ + "Accept": "*/*", + }, + body=None, + body_type=None, + response_type=bytes, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def upload( + self, + body: bytes, + *, + content_length: ContentLength, + content_type: ContentType, + filename: Filename, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> AttachmentV2: + """ + Upload an attachment to use in an action. Any attachment which has not been linked to an object via + an action within one hour after upload will be removed. + Previously mapped attachments which are not connected to any object anymore are also removed on + a biweekly basis. + The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-write`. + + :param body: Body of the request + :type body: bytes + :param content_length: Content-Length + :type content_length: ContentLength + :param content_type: Content-Type + :type content_type: ContentType + :param filename: filename + :type filename: Filename + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: AttachmentV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/ontologies/attachments/upload", + query_params={ + "filename": filename, + }, + path_params={}, + header_params={ + "Content-Length": content_length, + "Content-Type": content_type, + "Content-Type": "*/*", + "Accept": "application/json", + }, + body=body, + body_type=bytes, + response_type=AttachmentV2, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/ontologies/attachment_property.py b/foundry/v2/ontologies/attachment_property.py new file mode 100644 index 00000000..e761377c --- /dev/null +++ b/foundry/v2/ontologies/attachment_property.py @@ -0,0 +1,302 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v2.ontologies.models._artifact_repository_rid import ArtifactRepositoryRid +from foundry.v2.ontologies.models._attachment_metadata_response import ( + AttachmentMetadataResponse, +) # NOQA +from foundry.v2.ontologies.models._attachment_rid import AttachmentRid +from foundry.v2.ontologies.models._attachment_v2 import AttachmentV2 +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._ontology_identifier import OntologyIdentifier +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value_escaped_string import ( + PropertyValueEscapedString, +) # NOQA +from foundry.v2.ontologies.models._sdk_package_name import SdkPackageName + + +class AttachmentPropertyClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get_attachment( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + property: PropertyApiName, + *, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + package_name: Optional[SdkPackageName] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> AttachmentMetadataResponse: + """ + Get the metadata of attachments parented to the given object. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param property: property + :type property: PropertyApiName + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: AttachmentMetadataResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + "primaryKey": primary_key, + "property": property, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=AttachmentMetadataResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get_attachment_by_rid( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + property: PropertyApiName, + attachment_rid: AttachmentRid, + *, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + package_name: Optional[SdkPackageName] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> AttachmentV2: + """ + Get the metadata of a particular attachment in an attachment list. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param property: property + :type property: PropertyApiName + :param attachment_rid: attachmentRid + :type attachment_rid: AttachmentRid + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: AttachmentV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + "primaryKey": primary_key, + "property": property, + "attachmentRid": attachment_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=AttachmentV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def read_attachment( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + property: PropertyApiName, + *, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + package_name: Optional[SdkPackageName] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> bytes: + """ + Get the content of an attachment. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param property: property + :type property: PropertyApiName + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: bytes + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + "primaryKey": primary_key, + "property": property, + }, + header_params={ + "Accept": "*/*", + }, + body=None, + body_type=None, + response_type=bytes, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def read_attachment_by_rid( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + property: PropertyApiName, + attachment_rid: AttachmentRid, + *, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + package_name: Optional[SdkPackageName] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> bytes: + """ + Get the content of an attachment by its RID. + + The RID must exist in the attachment array of the property. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param property: property + :type property: PropertyApiName + :param attachment_rid: attachmentRid + :type attachment_rid: AttachmentRid + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: bytes + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + "primaryKey": primary_key, + "property": property, + "attachmentRid": attachment_rid, + }, + header_params={ + "Accept": "*/*", + }, + body=None, + body_type=None, + response_type=bytes, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/ontologies/client.py b/foundry/v2/ontologies/client.py new file mode 100644 index 00000000..0c0a0aac --- /dev/null +++ b/foundry/v2/ontologies/client.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry._core import Auth +from foundry.v2.ontologies.action import ActionClient +from foundry.v2.ontologies.attachment import AttachmentClient +from foundry.v2.ontologies.attachment_property import AttachmentPropertyClient +from foundry.v2.ontologies.linked_object import LinkedObjectClient +from foundry.v2.ontologies.ontology import OntologyClient +from foundry.v2.ontologies.ontology_interface import OntologyInterfaceClient +from foundry.v2.ontologies.ontology_object import OntologyObjectClient +from foundry.v2.ontologies.ontology_object_set import OntologyObjectSetClient +from foundry.v2.ontologies.query import QueryClient +from foundry.v2.ontologies.time_series_property_v2 import TimeSeriesPropertyV2Client + + +class OntologiesClient: + def __init__(self, auth: Auth, hostname: str): + self.Action = ActionClient(auth=auth, hostname=hostname) + self.Attachment = AttachmentClient(auth=auth, hostname=hostname) + self.AttachmentProperty = AttachmentPropertyClient(auth=auth, hostname=hostname) + self.LinkedObject = LinkedObjectClient(auth=auth, hostname=hostname) + self.OntologyInterface = OntologyInterfaceClient(auth=auth, hostname=hostname) + self.OntologyObjectSet = OntologyObjectSetClient(auth=auth, hostname=hostname) + self.OntologyObject = OntologyObjectClient(auth=auth, hostname=hostname) + self.Ontology = OntologyClient(auth=auth, hostname=hostname) + self.Query = QueryClient(auth=auth, hostname=hostname) + self.TimeSeriesPropertyV2 = TimeSeriesPropertyV2Client(auth=auth, hostname=hostname) diff --git a/foundry/v2/ontologies/linked_object.py b/foundry/v2/ontologies/linked_object.py new file mode 100644 index 00000000..e127e2b3 --- /dev/null +++ b/foundry/v2/ontologies/linked_object.py @@ -0,0 +1,308 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import List +from typing import Optional + +from pydantic import Field +from pydantic import StrictBool +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._artifact_repository_rid import ArtifactRepositoryRid +from foundry.v2.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v2.ontologies.models._list_linked_objects_response_v2 import ( + ListLinkedObjectsResponseV2, +) # NOQA +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._ontology_identifier import OntologyIdentifier +from foundry.v2.ontologies.models._ontology_object_v2 import OntologyObjectV2 +from foundry.v2.ontologies.models._order_by import OrderBy +from foundry.v2.ontologies.models._property_value_escaped_string import ( + PropertyValueEscapedString, +) # NOQA +from foundry.v2.ontologies.models._sdk_package_name import SdkPackageName +from foundry.v2.ontologies.models._selected_property_api_name import SelectedPropertyApiName # NOQA + + +class LinkedObjectClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get_linked_object( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + link_type: LinkTypeApiName, + linked_object_primary_key: PropertyValueEscapedString, + *, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + exclude_rid: Optional[StrictBool] = None, + package_name: Optional[SdkPackageName] = None, + select: Optional[List[SelectedPropertyApiName]] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> OntologyObjectV2: + """ + Get a specific linked object that originates from another object. + + If there is no link between the two objects, `LinkedObjectNotFound` is thrown. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param link_type: linkType + :type link_type: LinkTypeApiName + :param linked_object_primary_key: linkedObjectPrimaryKey + :type linked_object_primary_key: PropertyValueEscapedString + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param exclude_rid: excludeRid + :type exclude_rid: Optional[StrictBool] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param select: select + :type select: Optional[List[SelectedPropertyApiName]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: OntologyObjectV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}", + query_params={ + "artifactRepository": artifact_repository, + "excludeRid": exclude_rid, + "packageName": package_name, + "select": select, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + "primaryKey": primary_key, + "linkType": link_type, + "linkedObjectPrimaryKey": linked_object_primary_key, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=OntologyObjectV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list_linked_objects( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + link_type: LinkTypeApiName, + *, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + exclude_rid: Optional[StrictBool] = None, + order_by: Optional[OrderBy] = None, + package_name: Optional[SdkPackageName] = None, + page_size: Optional[PageSize] = None, + select: Optional[List[SelectedPropertyApiName]] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[OntologyObjectV2]: + """ + Lists the linked objects for a specific object and the given link type. + + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param link_type: linkType + :type link_type: LinkTypeApiName + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param exclude_rid: excludeRid + :type exclude_rid: Optional[StrictBool] + :param order_by: orderBy + :type order_by: Optional[OrderBy] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param select: select + :type select: Optional[List[SelectedPropertyApiName]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[OntologyObjectV2] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}", + query_params={ + "artifactRepository": artifact_repository, + "excludeRid": exclude_rid, + "orderBy": order_by, + "packageName": package_name, + "pageSize": page_size, + "select": select, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + "primaryKey": primary_key, + "linkType": link_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListLinkedObjectsResponseV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page_linked_objects( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + link_type: LinkTypeApiName, + *, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + exclude_rid: Optional[StrictBool] = None, + order_by: Optional[OrderBy] = None, + package_name: Optional[SdkPackageName] = None, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + select: Optional[List[SelectedPropertyApiName]] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListLinkedObjectsResponseV2: + """ + Lists the linked objects for a specific object and the given link type. + + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param link_type: linkType + :type link_type: LinkTypeApiName + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param exclude_rid: excludeRid + :type exclude_rid: Optional[StrictBool] + :param order_by: orderBy + :type order_by: Optional[OrderBy] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param select: select + :type select: Optional[List[SelectedPropertyApiName]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListLinkedObjectsResponseV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}", + query_params={ + "artifactRepository": artifact_repository, + "excludeRid": exclude_rid, + "orderBy": order_by, + "packageName": package_name, + "pageSize": page_size, + "pageToken": page_token, + "select": select, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + "primaryKey": primary_key, + "linkType": link_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListLinkedObjectsResponseV2, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/ontologies/models/__init__.py b/foundry/v2/ontologies/models/__init__.py new file mode 100644 index 00000000..6dd5770f --- /dev/null +++ b/foundry/v2/ontologies/models/__init__.py @@ -0,0 +1,16 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +__all__ = [] diff --git a/foundry/v1/models/_absolute_time_range_dict.py b/foundry/v2/ontologies/models/_absolute_time_range_dict.py similarity index 100% rename from foundry/v1/models/_absolute_time_range_dict.py rename to foundry/v2/ontologies/models/_absolute_time_range_dict.py diff --git a/foundry/v2/ontologies/models/_action_parameter_array_type.py b/foundry/v2/ontologies/models/_action_parameter_array_type.py new file mode 100644 index 00000000..f077bb15 --- /dev/null +++ b/foundry/v2/ontologies/models/_action_parameter_array_type.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._action_parameter_array_type_dict import ( + ActionParameterArrayTypeDict, +) # NOQA +from foundry.v2.ontologies.models._action_parameter_type import ActionParameterType + + +class ActionParameterArrayType(BaseModel): + """ActionParameterArrayType""" + + sub_type: ActionParameterType = Field(alias="subType") + + type: Literal["array"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ActionParameterArrayTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ActionParameterArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_action_parameter_array_type_dict.py b/foundry/v2/ontologies/models/_action_parameter_array_type_dict.py new file mode 100644 index 00000000..3bb94bd3 --- /dev/null +++ b/foundry/v2/ontologies/models/_action_parameter_array_type_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._action_parameter_type_dict import ActionParameterTypeDict # NOQA + + +class ActionParameterArrayTypeDict(TypedDict): + """ActionParameterArrayType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + subType: ActionParameterTypeDict + + type: Literal["array"] diff --git a/foundry/v2/ontologies/models/_action_parameter_type.py b/foundry/v2/ontologies/models/_action_parameter_type.py new file mode 100644 index 00000000..59d1cff6 --- /dev/null +++ b/foundry/v2/ontologies/models/_action_parameter_type.py @@ -0,0 +1,75 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import Union +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.core.models._attachment_type import AttachmentType +from foundry.v2.core.models._boolean_type import BooleanType +from foundry.v2.core.models._date_type import DateType +from foundry.v2.core.models._double_type import DoubleType +from foundry.v2.core.models._integer_type import IntegerType +from foundry.v2.core.models._long_type import LongType +from foundry.v2.core.models._marking_type import MarkingType +from foundry.v2.core.models._string_type import StringType +from foundry.v2.core.models._timestamp_type import TimestampType +from foundry.v2.ontologies.models._action_parameter_array_type_dict import ( + ActionParameterArrayTypeDict, +) # NOQA +from foundry.v2.ontologies.models._ontology_object_set_type import OntologyObjectSetType +from foundry.v2.ontologies.models._ontology_object_type import OntologyObjectType + + +class ActionParameterArrayType(BaseModel): + """ActionParameterArrayType""" + + sub_type: ActionParameterType = Field(alias="subType") + + type: Literal["array"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ActionParameterArrayTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ActionParameterArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True) + ) + + +ActionParameterType = Annotated[ + Union[ + DateType, + BooleanType, + MarkingType, + AttachmentType, + StringType, + ActionParameterArrayType, + OntologyObjectSetType, + DoubleType, + IntegerType, + LongType, + OntologyObjectType, + TimestampType, + ], + Field(discriminator="type"), +] +"""A union of all the types supported by Ontology Action parameters.""" diff --git a/foundry/v2/ontologies/models/_action_parameter_type_dict.py b/foundry/v2/ontologies/models/_action_parameter_type_dict.py new file mode 100644 index 00000000..f5a6186b --- /dev/null +++ b/foundry/v2/ontologies/models/_action_parameter_type_dict.py @@ -0,0 +1,67 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry.v2.core.models._attachment_type_dict import AttachmentTypeDict +from foundry.v2.core.models._boolean_type_dict import BooleanTypeDict +from foundry.v2.core.models._date_type_dict import DateTypeDict +from foundry.v2.core.models._double_type_dict import DoubleTypeDict +from foundry.v2.core.models._integer_type_dict import IntegerTypeDict +from foundry.v2.core.models._long_type_dict import LongTypeDict +from foundry.v2.core.models._marking_type_dict import MarkingTypeDict +from foundry.v2.core.models._string_type_dict import StringTypeDict +from foundry.v2.core.models._timestamp_type_dict import TimestampTypeDict +from foundry.v2.ontologies.models._ontology_object_set_type_dict import ( + OntologyObjectSetTypeDict, +) # NOQA +from foundry.v2.ontologies.models._ontology_object_type_dict import OntologyObjectTypeDict # NOQA + + +class ActionParameterArrayTypeDict(TypedDict): + """ActionParameterArrayType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + subType: ActionParameterTypeDict + + type: Literal["array"] + + +ActionParameterTypeDict = Annotated[ + Union[ + DateTypeDict, + BooleanTypeDict, + MarkingTypeDict, + AttachmentTypeDict, + StringTypeDict, + ActionParameterArrayTypeDict, + OntologyObjectSetTypeDict, + DoubleTypeDict, + IntegerTypeDict, + LongTypeDict, + OntologyObjectTypeDict, + TimestampTypeDict, + ], + Field(discriminator="type"), +] +"""A union of all the types supported by Ontology Action parameters.""" diff --git a/foundry/v2/ontologies/models/_action_parameter_v2.py b/foundry/v2/ontologies/models/_action_parameter_v2.py new file mode 100644 index 00000000..c8e5f652 --- /dev/null +++ b/foundry/v2/ontologies/models/_action_parameter_v2.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictBool +from pydantic import StrictStr + +from foundry.v2.ontologies.models._action_parameter_type import ActionParameterType +from foundry.v2.ontologies.models._action_parameter_v2_dict import ActionParameterV2Dict + + +class ActionParameterV2(BaseModel): + """Details about a parameter of an action.""" + + description: Optional[StrictStr] = None + + data_type: ActionParameterType = Field(alias="dataType") + + required: StrictBool + + model_config = {"extra": "allow"} + + def to_dict(self) -> ActionParameterV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ActionParameterV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_action_parameter_v2_dict.py b/foundry/v2/ontologies/models/_action_parameter_v2_dict.py new file mode 100644 index 00000000..6578aaf6 --- /dev/null +++ b/foundry/v2/ontologies/models/_action_parameter_v2_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictBool +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._action_parameter_type_dict import ActionParameterTypeDict # NOQA + + +class ActionParameterV2Dict(TypedDict): + """Details about a parameter of an action.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + description: NotRequired[StrictStr] + + dataType: ActionParameterTypeDict + + required: StrictBool diff --git a/foundry/v2/ontologies/models/_action_results.py b/foundry/v2/ontologies/models/_action_results.py new file mode 100644 index 00000000..f5fb9ce1 --- /dev/null +++ b/foundry/v2/ontologies/models/_action_results.py @@ -0,0 +1,27 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._object_edits import ObjectEdits +from foundry.v2.ontologies.models._object_type_edits import ObjectTypeEdits + +ActionResults = Annotated[Union[ObjectEdits, ObjectTypeEdits], Field(discriminator="type")] +"""ActionResults""" diff --git a/foundry/v2/ontologies/models/_action_results_dict.py b/foundry/v2/ontologies/models/_action_results_dict.py new file mode 100644 index 00000000..26c61125 --- /dev/null +++ b/foundry/v2/ontologies/models/_action_results_dict.py @@ -0,0 +1,29 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._object_edits_dict import ObjectEditsDict +from foundry.v2.ontologies.models._object_type_edits_dict import ObjectTypeEditsDict + +ActionResultsDict = Annotated[ + Union[ObjectEditsDict, ObjectTypeEditsDict], Field(discriminator="type") +] +"""ActionResults""" diff --git a/foundry/v2/models/_action_type_api_name.py b/foundry/v2/ontologies/models/_action_type_api_name.py similarity index 100% rename from foundry/v2/models/_action_type_api_name.py rename to foundry/v2/ontologies/models/_action_type_api_name.py diff --git a/foundry/v2/models/_action_type_rid.py b/foundry/v2/ontologies/models/_action_type_rid.py similarity index 100% rename from foundry/v2/models/_action_type_rid.py rename to foundry/v2/ontologies/models/_action_type_rid.py diff --git a/foundry/v2/ontologies/models/_action_type_v2.py b/foundry/v2/ontologies/models/_action_type_v2.py new file mode 100644 index 00000000..1ab22ab4 --- /dev/null +++ b/foundry/v2/ontologies/models/_action_type_v2.py @@ -0,0 +1,58 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.core.models._release_status import ReleaseStatus +from foundry.v2.ontologies.models._action_parameter_v2 import ActionParameterV2 +from foundry.v2.ontologies.models._action_type_api_name import ActionTypeApiName +from foundry.v2.ontologies.models._action_type_rid import ActionTypeRid +from foundry.v2.ontologies.models._action_type_v2_dict import ActionTypeV2Dict +from foundry.v2.ontologies.models._logic_rule import LogicRule +from foundry.v2.ontologies.models._parameter_id import ParameterId + + +class ActionTypeV2(BaseModel): + """Represents an action type in the Ontology.""" + + api_name: ActionTypeApiName = Field(alias="apiName") + + description: Optional[StrictStr] = None + + display_name: Optional[DisplayName] = Field(alias="displayName", default=None) + + status: ReleaseStatus + + parameters: Dict[ParameterId, ActionParameterV2] + + rid: ActionTypeRid + + operations: List[LogicRule] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ActionTypeV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ActionTypeV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_action_type_v2_dict.py b/foundry/v2/ontologies/models/_action_type_v2_dict.py new file mode 100644 index 00000000..d4db5fdf --- /dev/null +++ b/foundry/v2/ontologies/models/_action_type_v2_dict.py @@ -0,0 +1,51 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.core.models._release_status import ReleaseStatus +from foundry.v2.ontologies.models._action_parameter_v2_dict import ActionParameterV2Dict +from foundry.v2.ontologies.models._action_type_api_name import ActionTypeApiName +from foundry.v2.ontologies.models._action_type_rid import ActionTypeRid +from foundry.v2.ontologies.models._logic_rule_dict import LogicRuleDict +from foundry.v2.ontologies.models._parameter_id import ParameterId + + +class ActionTypeV2Dict(TypedDict): + """Represents an action type in the Ontology.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + apiName: ActionTypeApiName + + description: NotRequired[StrictStr] + + displayName: NotRequired[DisplayName] + + status: ReleaseStatus + + parameters: Dict[ParameterId, ActionParameterV2Dict] + + rid: ActionTypeRid + + operations: List[LogicRuleDict] diff --git a/foundry/v2/ontologies/models/_add_link.py b/foundry/v2/ontologies/models/_add_link.py new file mode 100644 index 00000000..2464c12a --- /dev/null +++ b/foundry/v2/ontologies/models/_add_link.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._add_link_dict import AddLinkDict +from foundry.v2.ontologies.models._link_side_object import LinkSideObject +from foundry.v2.ontologies.models._link_type_api_name import LinkTypeApiName + + +class AddLink(BaseModel): + """AddLink""" + + link_type_api_name_ato_b: LinkTypeApiName = Field(alias="linkTypeApiNameAtoB") + + link_type_api_name_bto_a: LinkTypeApiName = Field(alias="linkTypeApiNameBtoA") + + a_side_object: LinkSideObject = Field(alias="aSideObject") + + b_side_object: LinkSideObject = Field(alias="bSideObject") + + type: Literal["addLink"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> AddLinkDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(AddLinkDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_add_link_dict.py b/foundry/v2/ontologies/models/_add_link_dict.py new file mode 100644 index 00000000..a032f030 --- /dev/null +++ b/foundry/v2/ontologies/models/_add_link_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._link_side_object_dict import LinkSideObjectDict +from foundry.v2.ontologies.models._link_type_api_name import LinkTypeApiName + + +class AddLinkDict(TypedDict): + """AddLink""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + linkTypeApiNameAtoB: LinkTypeApiName + + linkTypeApiNameBtoA: LinkTypeApiName + + aSideObject: LinkSideObjectDict + + bSideObject: LinkSideObjectDict + + type: Literal["addLink"] diff --git a/foundry/v2/ontologies/models/_add_object.py b/foundry/v2/ontologies/models/_add_object.py new file mode 100644 index 00000000..ef555751 --- /dev/null +++ b/foundry/v2/ontologies/models/_add_object.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._add_object_dict import AddObjectDict +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class AddObject(BaseModel): + """AddObject""" + + primary_key: PropertyValue = Field(alias="primaryKey") + + object_type: ObjectTypeApiName = Field(alias="objectType") + + type: Literal["addObject"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> AddObjectDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(AddObjectDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_add_object_dict.py b/foundry/v2/ontologies/models/_add_object_dict.py new file mode 100644 index 00000000..5ee24a42 --- /dev/null +++ b/foundry/v2/ontologies/models/_add_object_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class AddObjectDict(TypedDict): + """AddObject""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + primaryKey: PropertyValue + + objectType: ObjectTypeApiName + + type: Literal["addObject"] diff --git a/foundry/v2/ontologies/models/_aggregate_objects_response_item_v2.py b/foundry/v2/ontologies/models/_aggregate_objects_response_item_v2.py new file mode 100644 index 00000000..2ec8ff12 --- /dev/null +++ b/foundry/v2/ontologies/models/_aggregate_objects_response_item_v2.py @@ -0,0 +1,47 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._aggregate_objects_response_item_v2_dict import ( + AggregateObjectsResponseItemV2Dict, +) # NOQA +from foundry.v2.ontologies.models._aggregation_group_key_v2 import AggregationGroupKeyV2 +from foundry.v2.ontologies.models._aggregation_group_value_v2 import AggregationGroupValueV2 # NOQA +from foundry.v2.ontologies.models._aggregation_metric_result_v2 import ( + AggregationMetricResultV2, +) # NOQA + + +class AggregateObjectsResponseItemV2(BaseModel): + """AggregateObjectsResponseItemV2""" + + group: Dict[AggregationGroupKeyV2, AggregationGroupValueV2] + + metrics: List[AggregationMetricResultV2] + + model_config = {"extra": "allow"} + + def to_dict(self) -> AggregateObjectsResponseItemV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + AggregateObjectsResponseItemV2Dict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_aggregate_objects_response_item_v2_dict.py b/foundry/v2/ontologies/models/_aggregate_objects_response_item_v2_dict.py new file mode 100644 index 00000000..13a85d0b --- /dev/null +++ b/foundry/v2/ontologies/models/_aggregate_objects_response_item_v2_dict.py @@ -0,0 +1,37 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._aggregation_group_key_v2 import AggregationGroupKeyV2 +from foundry.v2.ontologies.models._aggregation_group_value_v2 import AggregationGroupValueV2 # NOQA +from foundry.v2.ontologies.models._aggregation_metric_result_v2_dict import ( + AggregationMetricResultV2Dict, +) # NOQA + + +class AggregateObjectsResponseItemV2Dict(TypedDict): + """AggregateObjectsResponseItemV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + group: Dict[AggregationGroupKeyV2, AggregationGroupValueV2] + + metrics: List[AggregationMetricResultV2Dict] diff --git a/foundry/v2/ontologies/models/_aggregate_objects_response_v2.py b/foundry/v2/ontologies/models/_aggregate_objects_response_v2.py new file mode 100644 index 00000000..12468848 --- /dev/null +++ b/foundry/v2/ontologies/models/_aggregate_objects_response_v2.py @@ -0,0 +1,50 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictInt + +from foundry.v2.ontologies.models._aggregate_objects_response_item_v2 import ( + AggregateObjectsResponseItemV2, +) # NOQA +from foundry.v2.ontologies.models._aggregate_objects_response_v2_dict import ( + AggregateObjectsResponseV2Dict, +) # NOQA +from foundry.v2.ontologies.models._aggregation_accuracy import AggregationAccuracy + + +class AggregateObjectsResponseV2(BaseModel): + """AggregateObjectsResponseV2""" + + excluded_items: Optional[StrictInt] = Field(alias="excludedItems", default=None) + + accuracy: AggregationAccuracy + + data: List[AggregateObjectsResponseItemV2] + + model_config = {"extra": "allow"} + + def to_dict(self) -> AggregateObjectsResponseV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + AggregateObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_aggregate_objects_response_v2_dict.py b/foundry/v2/ontologies/models/_aggregate_objects_response_v2_dict.py new file mode 100644 index 00000000..b472ed9e --- /dev/null +++ b/foundry/v2/ontologies/models/_aggregate_objects_response_v2_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from pydantic import StrictInt +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._aggregate_objects_response_item_v2_dict import ( + AggregateObjectsResponseItemV2Dict, +) # NOQA +from foundry.v2.ontologies.models._aggregation_accuracy import AggregationAccuracy + + +class AggregateObjectsResponseV2Dict(TypedDict): + """AggregateObjectsResponseV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + excludedItems: NotRequired[StrictInt] + + accuracy: AggregationAccuracy + + data: List[AggregateObjectsResponseItemV2Dict] diff --git a/foundry/v1/models/_aggregation_accuracy.py b/foundry/v2/ontologies/models/_aggregation_accuracy.py similarity index 100% rename from foundry/v1/models/_aggregation_accuracy.py rename to foundry/v2/ontologies/models/_aggregation_accuracy.py diff --git a/foundry/v1/models/_aggregation_accuracy_request.py b/foundry/v2/ontologies/models/_aggregation_accuracy_request.py similarity index 100% rename from foundry/v1/models/_aggregation_accuracy_request.py rename to foundry/v2/ontologies/models/_aggregation_accuracy_request.py diff --git a/foundry/v2/ontologies/models/_aggregation_duration_grouping_v2_dict.py b/foundry/v2/ontologies/models/_aggregation_duration_grouping_v2_dict.py new file mode 100644 index 00000000..886ea517 --- /dev/null +++ b/foundry/v2/ontologies/models/_aggregation_duration_grouping_v2_dict.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictInt +from typing_extensions import TypedDict + +from foundry.v2.core.models._time_unit import TimeUnit +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class AggregationDurationGroupingV2Dict(TypedDict): + """ + Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. + When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: StrictInt + + unit: TimeUnit + + type: Literal["duration"] diff --git a/foundry/v2/ontologies/models/_aggregation_exact_grouping_v2_dict.py b/foundry/v2/ontologies/models/_aggregation_exact_grouping_v2_dict.py new file mode 100644 index 00000000..9a67c8c6 --- /dev/null +++ b/foundry/v2/ontologies/models/_aggregation_exact_grouping_v2_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictInt +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class AggregationExactGroupingV2Dict(TypedDict): + """Divides objects into groups according to an exact value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + maxGroupCount: NotRequired[StrictInt] + + type: Literal["exact"] diff --git a/foundry/v2/ontologies/models/_aggregation_fixed_width_grouping_v2_dict.py b/foundry/v2/ontologies/models/_aggregation_fixed_width_grouping_v2_dict.py new file mode 100644 index 00000000..507253ba --- /dev/null +++ b/foundry/v2/ontologies/models/_aggregation_fixed_width_grouping_v2_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictInt +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class AggregationFixedWidthGroupingV2Dict(TypedDict): + """Divides objects into groups with the specified width.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + fixedWidth: StrictInt + + type: Literal["fixedWidth"] diff --git a/foundry/v2/ontologies/models/_aggregation_group_by_v2_dict.py b/foundry/v2/ontologies/models/_aggregation_group_by_v2_dict.py new file mode 100644 index 00000000..962c438f --- /dev/null +++ b/foundry/v2/ontologies/models/_aggregation_group_by_v2_dict.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._aggregation_duration_grouping_v2_dict import ( + AggregationDurationGroupingV2Dict, +) # NOQA +from foundry.v2.ontologies.models._aggregation_exact_grouping_v2_dict import ( + AggregationExactGroupingV2Dict, +) # NOQA +from foundry.v2.ontologies.models._aggregation_fixed_width_grouping_v2_dict import ( + AggregationFixedWidthGroupingV2Dict, +) # NOQA +from foundry.v2.ontologies.models._aggregation_ranges_grouping_v2_dict import ( + AggregationRangesGroupingV2Dict, +) # NOQA + +AggregationGroupByV2Dict = Annotated[ + Union[ + AggregationDurationGroupingV2Dict, + AggregationFixedWidthGroupingV2Dict, + AggregationRangesGroupingV2Dict, + AggregationExactGroupingV2Dict, + ], + Field(discriminator="type"), +] +"""Specifies a grouping for aggregation results.""" diff --git a/foundry/v1/models/_aggregation_group_key_v2.py b/foundry/v2/ontologies/models/_aggregation_group_key_v2.py similarity index 100% rename from foundry/v1/models/_aggregation_group_key_v2.py rename to foundry/v2/ontologies/models/_aggregation_group_key_v2.py diff --git a/foundry/v1/models/_aggregation_group_value_v2.py b/foundry/v2/ontologies/models/_aggregation_group_value_v2.py similarity index 100% rename from foundry/v1/models/_aggregation_group_value_v2.py rename to foundry/v2/ontologies/models/_aggregation_group_value_v2.py diff --git a/foundry/v2/models/_aggregation_metric_name.py b/foundry/v2/ontologies/models/_aggregation_metric_name.py similarity index 100% rename from foundry/v2/models/_aggregation_metric_name.py rename to foundry/v2/ontologies/models/_aggregation_metric_name.py diff --git a/foundry/v2/ontologies/models/_aggregation_metric_result_v2.py b/foundry/v2/ontologies/models/_aggregation_metric_result_v2.py new file mode 100644 index 00000000..f32c7e15 --- /dev/null +++ b/foundry/v2/ontologies/models/_aggregation_metric_result_v2.py @@ -0,0 +1,47 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import StrictStr + +from foundry.v2.ontologies.models._aggregation_metric_result_v2_dict import ( + AggregationMetricResultV2Dict, +) # NOQA + + +class AggregationMetricResultV2(BaseModel): + """AggregationMetricResultV2""" + + name: StrictStr + + value: Optional[Any] = None + """ + The value of the metric. This will be a double in the case of + a numeric metric, or a date string in the case of a date metric. + """ + + model_config = {"extra": "allow"} + + def to_dict(self) -> AggregationMetricResultV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + AggregationMetricResultV2Dict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v1/models/_aggregation_metric_result_v2_dict.py b/foundry/v2/ontologies/models/_aggregation_metric_result_v2_dict.py similarity index 100% rename from foundry/v1/models/_aggregation_metric_result_v2_dict.py rename to foundry/v2/ontologies/models/_aggregation_metric_result_v2_dict.py diff --git a/foundry/v1/models/_aggregation_range_v2_dict.py b/foundry/v2/ontologies/models/_aggregation_range_v2_dict.py similarity index 100% rename from foundry/v1/models/_aggregation_range_v2_dict.py rename to foundry/v2/ontologies/models/_aggregation_range_v2_dict.py diff --git a/foundry/v2/ontologies/models/_aggregation_ranges_grouping_v2_dict.py b/foundry/v2/ontologies/models/_aggregation_ranges_grouping_v2_dict.py new file mode 100644 index 00000000..6c67fc49 --- /dev/null +++ b/foundry/v2/ontologies/models/_aggregation_ranges_grouping_v2_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._aggregation_range_v2_dict import AggregationRangeV2Dict # NOQA +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class AggregationRangesGroupingV2Dict(TypedDict): + """Divides objects into groups according to specified ranges.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + ranges: List[AggregationRangeV2Dict] + + type: Literal["ranges"] diff --git a/foundry/v2/ontologies/models/_aggregation_v2_dict.py b/foundry/v2/ontologies/models/_aggregation_v2_dict.py new file mode 100644 index 00000000..27e53dc2 --- /dev/null +++ b/foundry/v2/ontologies/models/_aggregation_v2_dict.py @@ -0,0 +1,51 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._approximate_distinct_aggregation_v2_dict import ( + ApproximateDistinctAggregationV2Dict, +) # NOQA +from foundry.v2.ontologies.models._approximate_percentile_aggregation_v2_dict import ( + ApproximatePercentileAggregationV2Dict, +) # NOQA +from foundry.v2.ontologies.models._avg_aggregation_v2_dict import AvgAggregationV2Dict +from foundry.v2.ontologies.models._count_aggregation_v2_dict import CountAggregationV2Dict # NOQA +from foundry.v2.ontologies.models._exact_distinct_aggregation_v2_dict import ( + ExactDistinctAggregationV2Dict, +) # NOQA +from foundry.v2.ontologies.models._max_aggregation_v2_dict import MaxAggregationV2Dict +from foundry.v2.ontologies.models._min_aggregation_v2_dict import MinAggregationV2Dict +from foundry.v2.ontologies.models._sum_aggregation_v2_dict import SumAggregationV2Dict + +AggregationV2Dict = Annotated[ + Union[ + ApproximateDistinctAggregationV2Dict, + MinAggregationV2Dict, + AvgAggregationV2Dict, + MaxAggregationV2Dict, + ApproximatePercentileAggregationV2Dict, + CountAggregationV2Dict, + SumAggregationV2Dict, + ExactDistinctAggregationV2Dict, + ], + Field(discriminator="type"), +] +"""Specifies an aggregation function.""" diff --git a/foundry/v2/ontologies/models/_and_query_v2.py b/foundry/v2/ontologies/models/_and_query_v2.py new file mode 100644 index 00000000..c0b0a99f --- /dev/null +++ b/foundry/v2/ontologies/models/_and_query_v2.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._and_query_v2_dict import AndQueryV2Dict +from foundry.v2.ontologies.models._search_json_query_v2 import SearchJsonQueryV2 + + +class AndQueryV2(BaseModel): + """Returns objects where every query is satisfied.""" + + value: List[SearchJsonQueryV2] + + type: Literal["and"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> AndQueryV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(AndQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_and_query_v2_dict.py b/foundry/v2/ontologies/models/_and_query_v2_dict.py new file mode 100644 index 00000000..0eb32d5a --- /dev/null +++ b/foundry/v2/ontologies/models/_and_query_v2_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._search_json_query_v2_dict import SearchJsonQueryV2Dict # NOQA + + +class AndQueryV2Dict(TypedDict): + """Returns objects where every query is satisfied.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: List[SearchJsonQueryV2Dict] + + type: Literal["and"] diff --git a/foundry/v1/models/_apply_action_mode.py b/foundry/v2/ontologies/models/_apply_action_mode.py similarity index 100% rename from foundry/v1/models/_apply_action_mode.py rename to foundry/v2/ontologies/models/_apply_action_mode.py diff --git a/foundry/v2/ontologies/models/_apply_action_request_options_dict.py b/foundry/v2/ontologies/models/_apply_action_request_options_dict.py new file mode 100644 index 00000000..e3436d4b --- /dev/null +++ b/foundry/v2/ontologies/models/_apply_action_request_options_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._apply_action_mode import ApplyActionMode +from foundry.v2.ontologies.models._return_edits_mode import ReturnEditsMode + + +class ApplyActionRequestOptionsDict(TypedDict): + """ApplyActionRequestOptions""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + mode: NotRequired[ApplyActionMode] + + returnEdits: NotRequired[ReturnEditsMode] diff --git a/foundry/v2/ontologies/models/_approximate_distinct_aggregation_v2_dict.py b/foundry/v2/ontologies/models/_approximate_distinct_aggregation_v2_dict.py new file mode 100644 index 00000000..69357ec9 --- /dev/null +++ b/foundry/v2/ontologies/models/_approximate_distinct_aggregation_v2_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._aggregation_metric_name import AggregationMetricName +from foundry.v2.ontologies.models._order_by_direction import OrderByDirection +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class ApproximateDistinctAggregationV2Dict(TypedDict): + """Computes an approximate number of distinct values for the provided field.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + name: NotRequired[AggregationMetricName] + + direction: NotRequired[OrderByDirection] + + type: Literal["approximateDistinct"] diff --git a/foundry/v2/ontologies/models/_approximate_percentile_aggregation_v2_dict.py b/foundry/v2/ontologies/models/_approximate_percentile_aggregation_v2_dict.py new file mode 100644 index 00000000..091c936c --- /dev/null +++ b/foundry/v2/ontologies/models/_approximate_percentile_aggregation_v2_dict.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictFloat +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._aggregation_metric_name import AggregationMetricName +from foundry.v2.ontologies.models._order_by_direction import OrderByDirection +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class ApproximatePercentileAggregationV2Dict(TypedDict): + """Computes the approximate percentile value for the provided field. Requires Object Storage V2.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + name: NotRequired[AggregationMetricName] + + approximatePercentile: StrictFloat + + direction: NotRequired[OrderByDirection] + + type: Literal["approximatePercentile"] diff --git a/foundry/v2/ontologies/models/_array_size_constraint.py b/foundry/v2/ontologies/models/_array_size_constraint.py new file mode 100644 index 00000000..22427957 --- /dev/null +++ b/foundry/v2/ontologies/models/_array_size_constraint.py @@ -0,0 +1,49 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._array_size_constraint_dict import ArraySizeConstraintDict # NOQA + + +class ArraySizeConstraint(BaseModel): + """The parameter expects an array of values and the size of the array must fall within the defined range.""" + + lt: Optional[Any] = None + """Less than""" + + lte: Optional[Any] = None + """Less than or equal""" + + gt: Optional[Any] = None + """Greater than""" + + gte: Optional[Any] = None + """Greater than or equal""" + + type: Literal["arraySize"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ArraySizeConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ArraySizeConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_array_size_constraint_dict.py b/foundry/v2/ontologies/models/_array_size_constraint_dict.py similarity index 100% rename from foundry/v2/models/_array_size_constraint_dict.py rename to foundry/v2/ontologies/models/_array_size_constraint_dict.py diff --git a/foundry/v1/models/_artifact_repository_rid.py b/foundry/v2/ontologies/models/_artifact_repository_rid.py similarity index 100% rename from foundry/v1/models/_artifact_repository_rid.py rename to foundry/v2/ontologies/models/_artifact_repository_rid.py diff --git a/foundry/v2/ontologies/models/_attachment_metadata_response.py b/foundry/v2/ontologies/models/_attachment_metadata_response.py new file mode 100644 index 00000000..08441470 --- /dev/null +++ b/foundry/v2/ontologies/models/_attachment_metadata_response.py @@ -0,0 +1,31 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._attachment_v2 import AttachmentV2 +from foundry.v2.ontologies.models._list_attachments_response_v2 import ( + ListAttachmentsResponseV2, +) # NOQA + +AttachmentMetadataResponse = Annotated[ + Union[AttachmentV2, ListAttachmentsResponseV2], Field(discriminator="type") +] +"""The attachment metadata response""" diff --git a/foundry/v2/ontologies/models/_attachment_metadata_response_dict.py b/foundry/v2/ontologies/models/_attachment_metadata_response_dict.py new file mode 100644 index 00000000..f94137c9 --- /dev/null +++ b/foundry/v2/ontologies/models/_attachment_metadata_response_dict.py @@ -0,0 +1,31 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._attachment_v2_dict import AttachmentV2Dict +from foundry.v2.ontologies.models._list_attachments_response_v2_dict import ( + ListAttachmentsResponseV2Dict, +) # NOQA + +AttachmentMetadataResponseDict = Annotated[ + Union[AttachmentV2Dict, ListAttachmentsResponseV2Dict], Field(discriminator="type") +] +"""The attachment metadata response""" diff --git a/foundry/v1/models/_attachment_rid.py b/foundry/v2/ontologies/models/_attachment_rid.py similarity index 100% rename from foundry/v1/models/_attachment_rid.py rename to foundry/v2/ontologies/models/_attachment_rid.py diff --git a/foundry/v2/ontologies/models/_attachment_v2.py b/foundry/v2/ontologies/models/_attachment_v2.py new file mode 100644 index 00000000..eefaa6ef --- /dev/null +++ b/foundry/v2/ontologies/models/_attachment_v2.py @@ -0,0 +1,48 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._filename import Filename +from foundry.v2.core.models._media_type import MediaType +from foundry.v2.core.models._size_bytes import SizeBytes +from foundry.v2.ontologies.models._attachment_rid import AttachmentRid +from foundry.v2.ontologies.models._attachment_v2_dict import AttachmentV2Dict + + +class AttachmentV2(BaseModel): + """The representation of an attachment.""" + + rid: AttachmentRid + + filename: Filename + + size_bytes: SizeBytes = Field(alias="sizeBytes") + + media_type: MediaType = Field(alias="mediaType") + + type: Literal["single"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> AttachmentV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(AttachmentV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_attachment_v2_dict.py b/foundry/v2/ontologies/models/_attachment_v2_dict.py new file mode 100644 index 00000000..b01d4c9c --- /dev/null +++ b/foundry/v2/ontologies/models/_attachment_v2_dict.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.core.models._filename import Filename +from foundry.v2.core.models._media_type import MediaType +from foundry.v2.core.models._size_bytes import SizeBytes +from foundry.v2.ontologies.models._attachment_rid import AttachmentRid + + +class AttachmentV2Dict(TypedDict): + """The representation of an attachment.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + rid: AttachmentRid + + filename: Filename + + sizeBytes: SizeBytes + + mediaType: MediaType + + type: Literal["single"] diff --git a/foundry/v2/ontologies/models/_avg_aggregation_v2_dict.py b/foundry/v2/ontologies/models/_avg_aggregation_v2_dict.py new file mode 100644 index 00000000..2b54bd86 --- /dev/null +++ b/foundry/v2/ontologies/models/_avg_aggregation_v2_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._aggregation_metric_name import AggregationMetricName +from foundry.v2.ontologies.models._order_by_direction import OrderByDirection +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class AvgAggregationV2Dict(TypedDict): + """Computes the average value for the provided field.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + name: NotRequired[AggregationMetricName] + + direction: NotRequired[OrderByDirection] + + type: Literal["avg"] diff --git a/foundry/v2/ontologies/models/_batch_apply_action_request_item_dict.py b/foundry/v2/ontologies/models/_batch_apply_action_request_item_dict.py new file mode 100644 index 00000000..b89472ad --- /dev/null +++ b/foundry/v2/ontologies/models/_batch_apply_action_request_item_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import Optional + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._data_value import DataValue +from foundry.v2.ontologies.models._parameter_id import ParameterId + + +class BatchApplyActionRequestItemDict(TypedDict): + """BatchApplyActionRequestItem""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + parameters: Dict[ParameterId, Optional[DataValue]] diff --git a/foundry/v2/ontologies/models/_batch_apply_action_request_options_dict.py b/foundry/v2/ontologies/models/_batch_apply_action_request_options_dict.py new file mode 100644 index 00000000..43b51e53 --- /dev/null +++ b/foundry/v2/ontologies/models/_batch_apply_action_request_options_dict.py @@ -0,0 +1,29 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._return_edits_mode import ReturnEditsMode + + +class BatchApplyActionRequestOptionsDict(TypedDict): + """BatchApplyActionRequestOptions""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + returnEdits: NotRequired[ReturnEditsMode] diff --git a/foundry/v2/ontologies/models/_batch_apply_action_response_v2.py b/foundry/v2/ontologies/models/_batch_apply_action_response_v2.py new file mode 100644 index 00000000..b04702d7 --- /dev/null +++ b/foundry/v2/ontologies/models/_batch_apply_action_response_v2.py @@ -0,0 +1,40 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._action_results import ActionResults +from foundry.v2.ontologies.models._batch_apply_action_response_v2_dict import ( + BatchApplyActionResponseV2Dict, +) # NOQA + + +class BatchApplyActionResponseV2(BaseModel): + """BatchApplyActionResponseV2""" + + edits: Optional[ActionResults] = None + + model_config = {"extra": "allow"} + + def to_dict(self) -> BatchApplyActionResponseV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + BatchApplyActionResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_batch_apply_action_response_v2_dict.py b/foundry/v2/ontologies/models/_batch_apply_action_response_v2_dict.py new file mode 100644 index 00000000..35e333e1 --- /dev/null +++ b/foundry/v2/ontologies/models/_batch_apply_action_response_v2_dict.py @@ -0,0 +1,29 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._action_results_dict import ActionResultsDict + + +class BatchApplyActionResponseV2Dict(TypedDict): + """BatchApplyActionResponseV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + edits: NotRequired[ActionResultsDict] diff --git a/foundry/v2/ontologies/models/_blueprint_icon.py b/foundry/v2/ontologies/models/_blueprint_icon.py new file mode 100644 index 00000000..01f33e1c --- /dev/null +++ b/foundry/v2/ontologies/models/_blueprint_icon.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import StrictStr + +from foundry.v2.ontologies.models._blueprint_icon_dict import BlueprintIconDict + + +class BlueprintIcon(BaseModel): + """BlueprintIcon""" + + color: StrictStr + """A hexadecimal color code.""" + + name: StrictStr + """ + The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. + Used to specify the Blueprint icon to represent the object type in a React app. + """ + + type: Literal["blueprint"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> BlueprintIconDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(BlueprintIconDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_blueprint_icon_dict.py b/foundry/v2/ontologies/models/_blueprint_icon_dict.py similarity index 100% rename from foundry/v1/models/_blueprint_icon_dict.py rename to foundry/v2/ontologies/models/_blueprint_icon_dict.py diff --git a/foundry/v2/ontologies/models/_bounding_box_value.py b/foundry/v2/ontologies/models/_bounding_box_value.py new file mode 100644 index 00000000..4aef0c0b --- /dev/null +++ b/foundry/v2/ontologies/models/_bounding_box_value.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._bounding_box_value_dict import BoundingBoxValueDict +from foundry.v2.ontologies.models._within_bounding_box_point import WithinBoundingBoxPoint # NOQA + + +class BoundingBoxValue(BaseModel): + """The top left and bottom right coordinate points that make up the bounding box.""" + + top_left: WithinBoundingBoxPoint = Field(alias="topLeft") + + bottom_right: WithinBoundingBoxPoint = Field(alias="bottomRight") + + model_config = {"extra": "allow"} + + def to_dict(self) -> BoundingBoxValueDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(BoundingBoxValueDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_bounding_box_value_dict.py b/foundry/v2/ontologies/models/_bounding_box_value_dict.py new file mode 100644 index 00000000..9ba144b3 --- /dev/null +++ b/foundry/v2/ontologies/models/_bounding_box_value_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._within_bounding_box_point_dict import ( + WithinBoundingBoxPointDict, +) # NOQA + + +class BoundingBoxValueDict(TypedDict): + """The top left and bottom right coordinate points that make up the bounding box.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + topLeft: WithinBoundingBoxPointDict + + bottomRight: WithinBoundingBoxPointDict diff --git a/foundry/v2/ontologies/models/_center_point.py b/foundry/v2/ontologies/models/_center_point.py new file mode 100644 index 00000000..e8c0c98f --- /dev/null +++ b/foundry/v2/ontologies/models/_center_point.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.core.models._distance import Distance +from foundry.v2.ontologies.models._center_point_dict import CenterPointDict +from foundry.v2.ontologies.models._center_point_types import CenterPointTypes + + +class CenterPoint(BaseModel): + """The coordinate point to use as the center of the distance query.""" + + center: CenterPointTypes + + distance: Distance + + model_config = {"extra": "allow"} + + def to_dict(self) -> CenterPointDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(CenterPointDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_center_point_dict.py b/foundry/v2/ontologies/models/_center_point_dict.py new file mode 100644 index 00000000..926b4737 --- /dev/null +++ b/foundry/v2/ontologies/models/_center_point_dict.py @@ -0,0 +1,31 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import TypedDict + +from foundry.v2.core.models._distance_dict import DistanceDict +from foundry.v2.ontologies.models._center_point_types_dict import CenterPointTypesDict + + +class CenterPointDict(TypedDict): + """The coordinate point to use as the center of the distance query.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + center: CenterPointTypesDict + + distance: DistanceDict diff --git a/foundry/v2/ontologies/models/_center_point_types.py b/foundry/v2/ontologies/models/_center_point_types.py new file mode 100644 index 00000000..893fef33 --- /dev/null +++ b/foundry/v2/ontologies/models/_center_point_types.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry.v2.geo.models._geo_point import GeoPoint + +CenterPointTypes = GeoPoint +"""CenterPointTypes""" diff --git a/foundry/v2/ontologies/models/_center_point_types_dict.py b/foundry/v2/ontologies/models/_center_point_types_dict.py new file mode 100644 index 00000000..f311ffde --- /dev/null +++ b/foundry/v2/ontologies/models/_center_point_types_dict.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry.v2.geo.models._geo_point_dict import GeoPointDict + +CenterPointTypesDict = GeoPointDict +"""CenterPointTypes""" diff --git a/foundry/v2/ontologies/models/_contains_all_terms_in_order_prefix_last_term.py b/foundry/v2/ontologies/models/_contains_all_terms_in_order_prefix_last_term.py new file mode 100644 index 00000000..2e288486 --- /dev/null +++ b/foundry/v2/ontologies/models/_contains_all_terms_in_order_prefix_last_term.py @@ -0,0 +1,50 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import StrictStr + +from foundry.v2.ontologies.models._contains_all_terms_in_order_prefix_last_term_dict import ( + ContainsAllTermsInOrderPrefixLastTermDict, +) # NOQA +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class ContainsAllTermsInOrderPrefixLastTerm(BaseModel): + """ + Returns objects where the specified field contains all of the terms in the order provided, + but they do have to be adjacent to each other. + The last term can be a partial prefix match. + """ + + field: PropertyApiName + + value: StrictStr + + type: Literal["containsAllTermsInOrderPrefixLastTerm"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ContainsAllTermsInOrderPrefixLastTermDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ContainsAllTermsInOrderPrefixLastTermDict, + self.model_dump(by_alias=True, exclude_unset=True), + ) diff --git a/foundry/v2/ontologies/models/_contains_all_terms_in_order_prefix_last_term_dict.py b/foundry/v2/ontologies/models/_contains_all_terms_in_order_prefix_last_term_dict.py new file mode 100644 index 00000000..65195c39 --- /dev/null +++ b/foundry/v2/ontologies/models/_contains_all_terms_in_order_prefix_last_term_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictStr +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class ContainsAllTermsInOrderPrefixLastTermDict(TypedDict): + """ + Returns objects where the specified field contains all of the terms in the order provided, + but they do have to be adjacent to each other. + The last term can be a partial prefix match. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: StrictStr + + type: Literal["containsAllTermsInOrderPrefixLastTerm"] diff --git a/foundry/v2/ontologies/models/_contains_all_terms_in_order_query.py b/foundry/v2/ontologies/models/_contains_all_terms_in_order_query.py new file mode 100644 index 00000000..0e1fb3b1 --- /dev/null +++ b/foundry/v2/ontologies/models/_contains_all_terms_in_order_query.py @@ -0,0 +1,48 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import StrictStr + +from foundry.v2.ontologies.models._contains_all_terms_in_order_query_dict import ( + ContainsAllTermsInOrderQueryDict, +) # NOQA +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class ContainsAllTermsInOrderQuery(BaseModel): + """ + Returns objects where the specified field contains all of the terms in the order provided, + but they do have to be adjacent to each other. + """ + + field: PropertyApiName + + value: StrictStr + + type: Literal["containsAllTermsInOrder"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ContainsAllTermsInOrderQueryDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ContainsAllTermsInOrderQueryDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_contains_all_terms_in_order_query_dict.py b/foundry/v2/ontologies/models/_contains_all_terms_in_order_query_dict.py new file mode 100644 index 00000000..f1df510e --- /dev/null +++ b/foundry/v2/ontologies/models/_contains_all_terms_in_order_query_dict.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictStr +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class ContainsAllTermsInOrderQueryDict(TypedDict): + """ + Returns objects where the specified field contains all of the terms in the order provided, + but they do have to be adjacent to each other. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: StrictStr + + type: Literal["containsAllTermsInOrder"] diff --git a/foundry/v2/ontologies/models/_contains_all_terms_query.py b/foundry/v2/ontologies/models/_contains_all_terms_query.py new file mode 100644 index 00000000..52a9c7af --- /dev/null +++ b/foundry/v2/ontologies/models/_contains_all_terms_query.py @@ -0,0 +1,50 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import StrictStr + +from foundry.v2.ontologies.models._contains_all_terms_query_dict import ( + ContainsAllTermsQueryDict, +) # NOQA +from foundry.v2.ontologies.models._fuzzy_v2 import FuzzyV2 +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class ContainsAllTermsQuery(BaseModel): + """ + Returns objects where the specified field contains all of the whitespace separated words in any + order in the provided value. This query supports fuzzy matching. + """ + + field: PropertyApiName + + value: StrictStr + + fuzzy: Optional[FuzzyV2] = None + + type: Literal["containsAllTerms"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ContainsAllTermsQueryDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ContainsAllTermsQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_contains_all_terms_query_dict.py b/foundry/v2/ontologies/models/_contains_all_terms_query_dict.py new file mode 100644 index 00000000..ecb11e03 --- /dev/null +++ b/foundry/v2/ontologies/models/_contains_all_terms_query_dict.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._fuzzy_v2 import FuzzyV2 +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class ContainsAllTermsQueryDict(TypedDict): + """ + Returns objects where the specified field contains all of the whitespace separated words in any + order in the provided value. This query supports fuzzy matching. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: StrictStr + + fuzzy: NotRequired[FuzzyV2] + + type: Literal["containsAllTerms"] diff --git a/foundry/v2/ontologies/models/_contains_any_term_query.py b/foundry/v2/ontologies/models/_contains_any_term_query.py new file mode 100644 index 00000000..a1335249 --- /dev/null +++ b/foundry/v2/ontologies/models/_contains_any_term_query.py @@ -0,0 +1,50 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import StrictStr + +from foundry.v2.ontologies.models._contains_any_term_query_dict import ( + ContainsAnyTermQueryDict, +) # NOQA +from foundry.v2.ontologies.models._fuzzy_v2 import FuzzyV2 +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class ContainsAnyTermQuery(BaseModel): + """ + Returns objects where the specified field contains any of the whitespace separated words in any + order in the provided value. This query supports fuzzy matching. + """ + + field: PropertyApiName + + value: StrictStr + + fuzzy: Optional[FuzzyV2] = None + + type: Literal["containsAnyTerm"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ContainsAnyTermQueryDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ContainsAnyTermQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_contains_any_term_query_dict.py b/foundry/v2/ontologies/models/_contains_any_term_query_dict.py new file mode 100644 index 00000000..4351ea2d --- /dev/null +++ b/foundry/v2/ontologies/models/_contains_any_term_query_dict.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._fuzzy_v2 import FuzzyV2 +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class ContainsAnyTermQueryDict(TypedDict): + """ + Returns objects where the specified field contains any of the whitespace separated words in any + order in the provided value. This query supports fuzzy matching. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: StrictStr + + fuzzy: NotRequired[FuzzyV2] + + type: Literal["containsAnyTerm"] diff --git a/foundry/v2/ontologies/models/_contains_query_v2.py b/foundry/v2/ontologies/models/_contains_query_v2.py new file mode 100644 index 00000000..ab193eff --- /dev/null +++ b/foundry/v2/ontologies/models/_contains_query_v2.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._contains_query_v2_dict import ContainsQueryV2Dict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class ContainsQueryV2(BaseModel): + """Returns objects where the specified array contains a value.""" + + field: PropertyApiName + + value: PropertyValue + + type: Literal["contains"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ContainsQueryV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ContainsQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_contains_query_v2_dict.py b/foundry/v2/ontologies/models/_contains_query_v2_dict.py new file mode 100644 index 00000000..202dc857 --- /dev/null +++ b/foundry/v2/ontologies/models/_contains_query_v2_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class ContainsQueryV2Dict(TypedDict): + """Returns objects where the specified array contains a value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: PropertyValue + + type: Literal["contains"] diff --git a/foundry/v2/ontologies/models/_count_aggregation_v2_dict.py b/foundry/v2/ontologies/models/_count_aggregation_v2_dict.py new file mode 100644 index 00000000..064b83b1 --- /dev/null +++ b/foundry/v2/ontologies/models/_count_aggregation_v2_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._aggregation_metric_name import AggregationMetricName +from foundry.v2.ontologies.models._order_by_direction import OrderByDirection + + +class CountAggregationV2Dict(TypedDict): + """Computes the total count of objects.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + name: NotRequired[AggregationMetricName] + + direction: NotRequired[OrderByDirection] + + type: Literal["count"] diff --git a/foundry/v2/ontologies/models/_count_objects_response_v2.py b/foundry/v2/ontologies/models/_count_objects_response_v2.py new file mode 100644 index 00000000..c1acf59e --- /dev/null +++ b/foundry/v2/ontologies/models/_count_objects_response_v2.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import StrictInt + +from foundry.v2.ontologies.models._count_objects_response_v2_dict import ( + CountObjectsResponseV2Dict, +) # NOQA + + +class CountObjectsResponseV2(BaseModel): + """CountObjectsResponseV2""" + + count: Optional[StrictInt] = None + + model_config = {"extra": "allow"} + + def to_dict(self) -> CountObjectsResponseV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(CountObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_count_objects_response_v2_dict.py b/foundry/v2/ontologies/models/_count_objects_response_v2_dict.py similarity index 100% rename from foundry/v1/models/_count_objects_response_v2_dict.py rename to foundry/v2/ontologies/models/_count_objects_response_v2_dict.py diff --git a/foundry/v2/ontologies/models/_create_interface_object_rule.py b/foundry/v2/ontologies/models/_create_interface_object_rule.py new file mode 100644 index 00000000..7464d25d --- /dev/null +++ b/foundry/v2/ontologies/models/_create_interface_object_rule.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._create_interface_object_rule_dict import ( + CreateInterfaceObjectRuleDict, +) # NOQA + + +class CreateInterfaceObjectRule(BaseModel): + """CreateInterfaceObjectRule""" + + type: Literal["createInterfaceObject"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> CreateInterfaceObjectRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + CreateInterfaceObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_create_interface_object_rule_dict.py b/foundry/v2/ontologies/models/_create_interface_object_rule_dict.py new file mode 100644 index 00000000..37803055 --- /dev/null +++ b/foundry/v2/ontologies/models/_create_interface_object_rule_dict.py @@ -0,0 +1,28 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + + +class CreateInterfaceObjectRuleDict(TypedDict): + """CreateInterfaceObjectRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + type: Literal["createInterfaceObject"] diff --git a/foundry/v2/ontologies/models/_create_link_rule.py b/foundry/v2/ontologies/models/_create_link_rule.py new file mode 100644 index 00000000..1f2d7e8e --- /dev/null +++ b/foundry/v2/ontologies/models/_create_link_rule.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._create_link_rule_dict import CreateLinkRuleDict +from foundry.v2.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class CreateLinkRule(BaseModel): + """CreateLinkRule""" + + link_type_api_name_ato_b: LinkTypeApiName = Field(alias="linkTypeApiNameAtoB") + + link_type_api_name_bto_a: LinkTypeApiName = Field(alias="linkTypeApiNameBtoA") + + a_side_object_type_api_name: ObjectTypeApiName = Field(alias="aSideObjectTypeApiName") + + b_side_object_type_api_name: ObjectTypeApiName = Field(alias="bSideObjectTypeApiName") + + type: Literal["createLink"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> CreateLinkRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(CreateLinkRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_create_link_rule_dict.py b/foundry/v2/ontologies/models/_create_link_rule_dict.py new file mode 100644 index 00000000..123a7239 --- /dev/null +++ b/foundry/v2/ontologies/models/_create_link_rule_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class CreateLinkRuleDict(TypedDict): + """CreateLinkRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + linkTypeApiNameAtoB: LinkTypeApiName + + linkTypeApiNameBtoA: LinkTypeApiName + + aSideObjectTypeApiName: ObjectTypeApiName + + bSideObjectTypeApiName: ObjectTypeApiName + + type: Literal["createLink"] diff --git a/foundry/v2/ontologies/models/_create_object_rule.py b/foundry/v2/ontologies/models/_create_object_rule.py new file mode 100644 index 00000000..6a24d827 --- /dev/null +++ b/foundry/v2/ontologies/models/_create_object_rule.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._create_object_rule_dict import CreateObjectRuleDict +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class CreateObjectRule(BaseModel): + """CreateObjectRule""" + + object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") + + type: Literal["createObject"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> CreateObjectRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(CreateObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_create_object_rule_dict.py b/foundry/v2/ontologies/models/_create_object_rule_dict.py new file mode 100644 index 00000000..88d0a27b --- /dev/null +++ b/foundry/v2/ontologies/models/_create_object_rule_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class CreateObjectRuleDict(TypedDict): + """CreateObjectRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectTypeApiName: ObjectTypeApiName + + type: Literal["createObject"] diff --git a/foundry/v2/ontologies/models/_create_temporary_object_set_response_v2.py b/foundry/v2/ontologies/models/_create_temporary_object_set_response_v2.py new file mode 100644 index 00000000..3f2f05e0 --- /dev/null +++ b/foundry/v2/ontologies/models/_create_temporary_object_set_response_v2.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._create_temporary_object_set_response_v2_dict import ( + CreateTemporaryObjectSetResponseV2Dict, +) # NOQA +from foundry.v2.ontologies.models._object_set_rid import ObjectSetRid + + +class CreateTemporaryObjectSetResponseV2(BaseModel): + """CreateTemporaryObjectSetResponseV2""" + + object_set_rid: ObjectSetRid = Field(alias="objectSetRid") + + model_config = {"extra": "allow"} + + def to_dict(self) -> CreateTemporaryObjectSetResponseV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + CreateTemporaryObjectSetResponseV2Dict, + self.model_dump(by_alias=True, exclude_unset=True), + ) diff --git a/foundry/v2/ontologies/models/_create_temporary_object_set_response_v2_dict.py b/foundry/v2/ontologies/models/_create_temporary_object_set_response_v2_dict.py new file mode 100644 index 00000000..6c0a8047 --- /dev/null +++ b/foundry/v2/ontologies/models/_create_temporary_object_set_response_v2_dict.py @@ -0,0 +1,28 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_set_rid import ObjectSetRid + + +class CreateTemporaryObjectSetResponseV2Dict(TypedDict): + """CreateTemporaryObjectSetResponseV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectSetRid: ObjectSetRid diff --git a/foundry/v2/models/_data_value.py b/foundry/v2/ontologies/models/_data_value.py similarity index 100% rename from foundry/v2/models/_data_value.py rename to foundry/v2/ontologies/models/_data_value.py diff --git a/foundry/v2/ontologies/models/_delete_link_rule.py b/foundry/v2/ontologies/models/_delete_link_rule.py new file mode 100644 index 00000000..9dcb0493 --- /dev/null +++ b/foundry/v2/ontologies/models/_delete_link_rule.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._delete_link_rule_dict import DeleteLinkRuleDict +from foundry.v2.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class DeleteLinkRule(BaseModel): + """DeleteLinkRule""" + + link_type_api_name_ato_b: LinkTypeApiName = Field(alias="linkTypeApiNameAtoB") + + link_type_api_name_bto_a: LinkTypeApiName = Field(alias="linkTypeApiNameBtoA") + + a_side_object_type_api_name: ObjectTypeApiName = Field(alias="aSideObjectTypeApiName") + + b_side_object_type_api_name: ObjectTypeApiName = Field(alias="bSideObjectTypeApiName") + + type: Literal["deleteLink"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> DeleteLinkRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(DeleteLinkRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_delete_link_rule_dict.py b/foundry/v2/ontologies/models/_delete_link_rule_dict.py new file mode 100644 index 00000000..3c5e2af7 --- /dev/null +++ b/foundry/v2/ontologies/models/_delete_link_rule_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class DeleteLinkRuleDict(TypedDict): + """DeleteLinkRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + linkTypeApiNameAtoB: LinkTypeApiName + + linkTypeApiNameBtoA: LinkTypeApiName + + aSideObjectTypeApiName: ObjectTypeApiName + + bSideObjectTypeApiName: ObjectTypeApiName + + type: Literal["deleteLink"] diff --git a/foundry/v2/ontologies/models/_delete_object_rule.py b/foundry/v2/ontologies/models/_delete_object_rule.py new file mode 100644 index 00000000..2339a0b8 --- /dev/null +++ b/foundry/v2/ontologies/models/_delete_object_rule.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._delete_object_rule_dict import DeleteObjectRuleDict +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class DeleteObjectRule(BaseModel): + """DeleteObjectRule""" + + object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") + + type: Literal["deleteObject"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> DeleteObjectRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(DeleteObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_delete_object_rule_dict.py b/foundry/v2/ontologies/models/_delete_object_rule_dict.py new file mode 100644 index 00000000..001bd318 --- /dev/null +++ b/foundry/v2/ontologies/models/_delete_object_rule_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class DeleteObjectRuleDict(TypedDict): + """DeleteObjectRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectTypeApiName: ObjectTypeApiName + + type: Literal["deleteObject"] diff --git a/foundry/v2/ontologies/models/_does_not_intersect_bounding_box_query.py b/foundry/v2/ontologies/models/_does_not_intersect_bounding_box_query.py new file mode 100644 index 00000000..498ee411 --- /dev/null +++ b/foundry/v2/ontologies/models/_does_not_intersect_bounding_box_query.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._bounding_box_value import BoundingBoxValue +from foundry.v2.ontologies.models._does_not_intersect_bounding_box_query_dict import ( + DoesNotIntersectBoundingBoxQueryDict, +) # NOQA +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class DoesNotIntersectBoundingBoxQuery(BaseModel): + """Returns objects where the specified field does not intersect the bounding box provided.""" + + field: PropertyApiName + + value: BoundingBoxValue + + type: Literal["doesNotIntersectBoundingBox"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> DoesNotIntersectBoundingBoxQueryDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + DoesNotIntersectBoundingBoxQueryDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_does_not_intersect_bounding_box_query_dict.py b/foundry/v2/ontologies/models/_does_not_intersect_bounding_box_query_dict.py new file mode 100644 index 00000000..9ab48fae --- /dev/null +++ b/foundry/v2/ontologies/models/_does_not_intersect_bounding_box_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._bounding_box_value_dict import BoundingBoxValueDict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class DoesNotIntersectBoundingBoxQueryDict(TypedDict): + """Returns objects where the specified field does not intersect the bounding box provided.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: BoundingBoxValueDict + + type: Literal["doesNotIntersectBoundingBox"] diff --git a/foundry/v2/ontologies/models/_does_not_intersect_polygon_query.py b/foundry/v2/ontologies/models/_does_not_intersect_polygon_query.py new file mode 100644 index 00000000..7282be24 --- /dev/null +++ b/foundry/v2/ontologies/models/_does_not_intersect_polygon_query.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._does_not_intersect_polygon_query_dict import ( + DoesNotIntersectPolygonQueryDict, +) # NOQA +from foundry.v2.ontologies.models._polygon_value import PolygonValue +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class DoesNotIntersectPolygonQuery(BaseModel): + """Returns objects where the specified field does not intersect the polygon provided.""" + + field: PropertyApiName + + value: PolygonValue + + type: Literal["doesNotIntersectPolygon"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> DoesNotIntersectPolygonQueryDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + DoesNotIntersectPolygonQueryDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_does_not_intersect_polygon_query_dict.py b/foundry/v2/ontologies/models/_does_not_intersect_polygon_query_dict.py new file mode 100644 index 00000000..dea9ab75 --- /dev/null +++ b/foundry/v2/ontologies/models/_does_not_intersect_polygon_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._polygon_value_dict import PolygonValueDict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class DoesNotIntersectPolygonQueryDict(TypedDict): + """Returns objects where the specified field does not intersect the polygon provided.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: PolygonValueDict + + type: Literal["doesNotIntersectPolygon"] diff --git a/foundry/v2/ontologies/models/_equals_query_v2.py b/foundry/v2/ontologies/models/_equals_query_v2.py new file mode 100644 index 00000000..f0a27b07 --- /dev/null +++ b/foundry/v2/ontologies/models/_equals_query_v2.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._equals_query_v2_dict import EqualsQueryV2Dict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class EqualsQueryV2(BaseModel): + """Returns objects where the specified field is equal to a value.""" + + field: PropertyApiName + + value: PropertyValue + + type: Literal["eq"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> EqualsQueryV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(EqualsQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_equals_query_v2_dict.py b/foundry/v2/ontologies/models/_equals_query_v2_dict.py new file mode 100644 index 00000000..33c63627 --- /dev/null +++ b/foundry/v2/ontologies/models/_equals_query_v2_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class EqualsQueryV2Dict(TypedDict): + """Returns objects where the specified field is equal to a value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: PropertyValue + + type: Literal["eq"] diff --git a/foundry/v2/ontologies/models/_exact_distinct_aggregation_v2_dict.py b/foundry/v2/ontologies/models/_exact_distinct_aggregation_v2_dict.py new file mode 100644 index 00000000..bf89ecb2 --- /dev/null +++ b/foundry/v2/ontologies/models/_exact_distinct_aggregation_v2_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._aggregation_metric_name import AggregationMetricName +from foundry.v2.ontologies.models._order_by_direction import OrderByDirection +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class ExactDistinctAggregationV2Dict(TypedDict): + """Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + name: NotRequired[AggregationMetricName] + + direction: NotRequired[OrderByDirection] + + type: Literal["exactDistinct"] diff --git a/foundry/v2/ontologies/models/_execute_query_response.py b/foundry/v2/ontologies/models/_execute_query_response.py new file mode 100644 index 00000000..d9d6051d --- /dev/null +++ b/foundry/v2/ontologies/models/_execute_query_response.py @@ -0,0 +1,37 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._data_value import DataValue +from foundry.v2.ontologies.models._execute_query_response_dict import ( + ExecuteQueryResponseDict, +) # NOQA + + +class ExecuteQueryResponse(BaseModel): + """ExecuteQueryResponse""" + + value: DataValue + + model_config = {"extra": "allow"} + + def to_dict(self) -> ExecuteQueryResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ExecuteQueryResponseDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_execute_query_response_dict.py b/foundry/v2/ontologies/models/_execute_query_response_dict.py new file mode 100644 index 00000000..1682afbe --- /dev/null +++ b/foundry/v2/ontologies/models/_execute_query_response_dict.py @@ -0,0 +1,28 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._data_value import DataValue + + +class ExecuteQueryResponseDict(TypedDict): + """ExecuteQueryResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: DataValue diff --git a/foundry/v2/models/_function_rid.py b/foundry/v2/ontologies/models/_function_rid.py similarity index 100% rename from foundry/v2/models/_function_rid.py rename to foundry/v2/ontologies/models/_function_rid.py diff --git a/foundry/v2/models/_function_version.py b/foundry/v2/ontologies/models/_function_version.py similarity index 100% rename from foundry/v2/models/_function_version.py rename to foundry/v2/ontologies/models/_function_version.py diff --git a/foundry/v1/models/_fuzzy_v2.py b/foundry/v2/ontologies/models/_fuzzy_v2.py similarity index 100% rename from foundry/v1/models/_fuzzy_v2.py rename to foundry/v2/ontologies/models/_fuzzy_v2.py diff --git a/foundry/v2/ontologies/models/_group_member_constraint.py b/foundry/v2/ontologies/models/_group_member_constraint.py new file mode 100644 index 00000000..9a69063c --- /dev/null +++ b/foundry/v2/ontologies/models/_group_member_constraint.py @@ -0,0 +1,37 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._group_member_constraint_dict import ( + GroupMemberConstraintDict, +) # NOQA + + +class GroupMemberConstraint(BaseModel): + """The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint.""" + + type: Literal["groupMember"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> GroupMemberConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(GroupMemberConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_group_member_constraint_dict.py b/foundry/v2/ontologies/models/_group_member_constraint_dict.py similarity index 100% rename from foundry/v2/models/_group_member_constraint_dict.py rename to foundry/v2/ontologies/models/_group_member_constraint_dict.py diff --git a/foundry/v2/ontologies/models/_gt_query_v2.py b/foundry/v2/ontologies/models/_gt_query_v2.py new file mode 100644 index 00000000..c86b283f --- /dev/null +++ b/foundry/v2/ontologies/models/_gt_query_v2.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._gt_query_v2_dict import GtQueryV2Dict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class GtQueryV2(BaseModel): + """Returns objects where the specified field is greater than a value.""" + + field: PropertyApiName + + value: PropertyValue + + type: Literal["gt"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> GtQueryV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(GtQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_gt_query_v2_dict.py b/foundry/v2/ontologies/models/_gt_query_v2_dict.py new file mode 100644 index 00000000..a5051765 --- /dev/null +++ b/foundry/v2/ontologies/models/_gt_query_v2_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class GtQueryV2Dict(TypedDict): + """Returns objects where the specified field is greater than a value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: PropertyValue + + type: Literal["gt"] diff --git a/foundry/v2/ontologies/models/_gte_query_v2.py b/foundry/v2/ontologies/models/_gte_query_v2.py new file mode 100644 index 00000000..e3726ed4 --- /dev/null +++ b/foundry/v2/ontologies/models/_gte_query_v2.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._gte_query_v2_dict import GteQueryV2Dict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class GteQueryV2(BaseModel): + """Returns objects where the specified field is greater than or equal to a value.""" + + field: PropertyApiName + + value: PropertyValue + + type: Literal["gte"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> GteQueryV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(GteQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_gte_query_v2_dict.py b/foundry/v2/ontologies/models/_gte_query_v2_dict.py new file mode 100644 index 00000000..9448bab6 --- /dev/null +++ b/foundry/v2/ontologies/models/_gte_query_v2_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class GteQueryV2Dict(TypedDict): + """Returns objects where the specified field is greater than or equal to a value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: PropertyValue + + type: Literal["gte"] diff --git a/foundry/v2/ontologies/models/_icon.py b/foundry/v2/ontologies/models/_icon.py new file mode 100644 index 00000000..0a00c0bf --- /dev/null +++ b/foundry/v2/ontologies/models/_icon.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry.v2.ontologies.models._blueprint_icon import BlueprintIcon + +Icon = BlueprintIcon +"""A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).""" diff --git a/foundry/v2/ontologies/models/_icon_dict.py b/foundry/v2/ontologies/models/_icon_dict.py new file mode 100644 index 00000000..5fd35d52 --- /dev/null +++ b/foundry/v2/ontologies/models/_icon_dict.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry.v2.ontologies.models._blueprint_icon_dict import BlueprintIconDict + +IconDict = BlueprintIconDict +"""A union currently only consisting of the BlueprintIcon (more icon types may be added in the future).""" diff --git a/foundry/v2/ontologies/models/_interface_link_type.py b/foundry/v2/ontologies/models/_interface_link_type.py new file mode 100644 index 00000000..02237425 --- /dev/null +++ b/foundry/v2/ontologies/models/_interface_link_type.py @@ -0,0 +1,68 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictBool +from pydantic import StrictStr + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.ontologies.models._interface_link_type_api_name import ( + InterfaceLinkTypeApiName, +) # NOQA +from foundry.v2.ontologies.models._interface_link_type_cardinality import ( + InterfaceLinkTypeCardinality, +) # NOQA +from foundry.v2.ontologies.models._interface_link_type_dict import InterfaceLinkTypeDict +from foundry.v2.ontologies.models._interface_link_type_linked_entity_api_name import ( + InterfaceLinkTypeLinkedEntityApiName, +) # NOQA +from foundry.v2.ontologies.models._interface_link_type_rid import InterfaceLinkTypeRid + + +class InterfaceLinkType(BaseModel): + """ + A link type constraint defined at the interface level where the implementation of the links is provided + by the implementing object types. + """ + + rid: InterfaceLinkTypeRid + + api_name: InterfaceLinkTypeApiName = Field(alias="apiName") + + display_name: DisplayName = Field(alias="displayName") + + description: Optional[StrictStr] = None + """The description of the interface link type.""" + + linked_entity_api_name: InterfaceLinkTypeLinkedEntityApiName = Field( + alias="linkedEntityApiName" + ) + + cardinality: InterfaceLinkTypeCardinality + + required: StrictBool + """Whether each implementing object type must declare at least one implementation of this link.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> InterfaceLinkTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(InterfaceLinkTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_interface_link_type_api_name.py b/foundry/v2/ontologies/models/_interface_link_type_api_name.py similarity index 100% rename from foundry/v1/models/_interface_link_type_api_name.py rename to foundry/v2/ontologies/models/_interface_link_type_api_name.py diff --git a/foundry/v1/models/_interface_link_type_cardinality.py b/foundry/v2/ontologies/models/_interface_link_type_cardinality.py similarity index 100% rename from foundry/v1/models/_interface_link_type_cardinality.py rename to foundry/v2/ontologies/models/_interface_link_type_cardinality.py diff --git a/foundry/v2/ontologies/models/_interface_link_type_dict.py b/foundry/v2/ontologies/models/_interface_link_type_dict.py new file mode 100644 index 00000000..328e2d9f --- /dev/null +++ b/foundry/v2/ontologies/models/_interface_link_type_dict.py @@ -0,0 +1,58 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictBool +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.ontologies.models._interface_link_type_api_name import ( + InterfaceLinkTypeApiName, +) # NOQA +from foundry.v2.ontologies.models._interface_link_type_cardinality import ( + InterfaceLinkTypeCardinality, +) # NOQA +from foundry.v2.ontologies.models._interface_link_type_linked_entity_api_name_dict import ( + InterfaceLinkTypeLinkedEntityApiNameDict, +) # NOQA +from foundry.v2.ontologies.models._interface_link_type_rid import InterfaceLinkTypeRid + + +class InterfaceLinkTypeDict(TypedDict): + """ + A link type constraint defined at the interface level where the implementation of the links is provided + by the implementing object types. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + rid: InterfaceLinkTypeRid + + apiName: InterfaceLinkTypeApiName + + displayName: DisplayName + + description: NotRequired[StrictStr] + """The description of the interface link type.""" + + linkedEntityApiName: InterfaceLinkTypeLinkedEntityApiNameDict + + cardinality: InterfaceLinkTypeCardinality + + required: StrictBool + """Whether each implementing object type must declare at least one implementation of this link.""" diff --git a/foundry/v2/ontologies/models/_interface_link_type_linked_entity_api_name.py b/foundry/v2/ontologies/models/_interface_link_type_linked_entity_api_name.py new file mode 100644 index 00000000..d0929cc5 --- /dev/null +++ b/foundry/v2/ontologies/models/_interface_link_type_linked_entity_api_name.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._linked_interface_type_api_name import ( + LinkedInterfaceTypeApiName, +) # NOQA +from foundry.v2.ontologies.models._linked_object_type_api_name import ( + LinkedObjectTypeApiName, +) # NOQA + +InterfaceLinkTypeLinkedEntityApiName = Annotated[ + Union[LinkedObjectTypeApiName, LinkedInterfaceTypeApiName], Field(discriminator="type") +] +"""A reference to the linked entity. This can either be an object or an interface type.""" diff --git a/foundry/v2/ontologies/models/_interface_link_type_linked_entity_api_name_dict.py b/foundry/v2/ontologies/models/_interface_link_type_linked_entity_api_name_dict.py new file mode 100644 index 00000000..95f4c785 --- /dev/null +++ b/foundry/v2/ontologies/models/_interface_link_type_linked_entity_api_name_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._linked_interface_type_api_name_dict import ( + LinkedInterfaceTypeApiNameDict, +) # NOQA +from foundry.v2.ontologies.models._linked_object_type_api_name_dict import ( + LinkedObjectTypeApiNameDict, +) # NOQA + +InterfaceLinkTypeLinkedEntityApiNameDict = Annotated[ + Union[LinkedObjectTypeApiNameDict, LinkedInterfaceTypeApiNameDict], Field(discriminator="type") +] +"""A reference to the linked entity. This can either be an object or an interface type.""" diff --git a/foundry/v1/models/_interface_link_type_rid.py b/foundry/v2/ontologies/models/_interface_link_type_rid.py similarity index 100% rename from foundry/v1/models/_interface_link_type_rid.py rename to foundry/v2/ontologies/models/_interface_link_type_rid.py diff --git a/foundry/v2/ontologies/models/_interface_type.py b/foundry/v2/ontologies/models/_interface_type.py new file mode 100644 index 00000000..7d696ab9 --- /dev/null +++ b/foundry/v2/ontologies/models/_interface_type.py @@ -0,0 +1,75 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.ontologies.models._interface_link_type import InterfaceLinkType +from foundry.v2.ontologies.models._interface_link_type_api_name import ( + InterfaceLinkTypeApiName, +) # NOQA +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName +from foundry.v2.ontologies.models._interface_type_dict import InterfaceTypeDict +from foundry.v2.ontologies.models._interface_type_rid import InterfaceTypeRid +from foundry.v2.ontologies.models._shared_property_type import SharedPropertyType +from foundry.v2.ontologies.models._shared_property_type_api_name import ( + SharedPropertyTypeApiName, +) # NOQA + + +class InterfaceType(BaseModel): + """Represents an interface type in the Ontology.""" + + rid: InterfaceTypeRid + + api_name: InterfaceTypeApiName = Field(alias="apiName") + + display_name: DisplayName = Field(alias="displayName") + + description: Optional[StrictStr] = None + """The description of the interface.""" + + properties: Dict[SharedPropertyTypeApiName, SharedPropertyType] + """ + A map from a shared property type API name to the corresponding shared property type. The map describes the + set of properties the interface has. A shared property type must be unique across all of the properties. + """ + + extends_interfaces: List[InterfaceTypeApiName] = Field(alias="extendsInterfaces") + """ + A list of interface API names that this interface extends. An interface can extend other interfaces to + inherit their properties. + """ + + links: Dict[InterfaceLinkTypeApiName, InterfaceLinkType] + """ + A map from an interface link type API name to the corresponding interface link type. The map describes the + set of link types the interface has. + """ + + model_config = {"extra": "allow"} + + def to_dict(self) -> InterfaceTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(InterfaceTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_interface_type_api_name.py b/foundry/v2/ontologies/models/_interface_type_api_name.py similarity index 100% rename from foundry/v1/models/_interface_type_api_name.py rename to foundry/v2/ontologies/models/_interface_type_api_name.py diff --git a/foundry/v2/ontologies/models/_interface_type_dict.py b/foundry/v2/ontologies/models/_interface_type_dict.py new file mode 100644 index 00000000..8934255d --- /dev/null +++ b/foundry/v2/ontologies/models/_interface_type_dict.py @@ -0,0 +1,68 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.ontologies.models._interface_link_type_api_name import ( + InterfaceLinkTypeApiName, +) # NOQA +from foundry.v2.ontologies.models._interface_link_type_dict import InterfaceLinkTypeDict +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName +from foundry.v2.ontologies.models._interface_type_rid import InterfaceTypeRid +from foundry.v2.ontologies.models._shared_property_type_api_name import ( + SharedPropertyTypeApiName, +) # NOQA +from foundry.v2.ontologies.models._shared_property_type_dict import SharedPropertyTypeDict # NOQA + + +class InterfaceTypeDict(TypedDict): + """Represents an interface type in the Ontology.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + rid: InterfaceTypeRid + + apiName: InterfaceTypeApiName + + displayName: DisplayName + + description: NotRequired[StrictStr] + """The description of the interface.""" + + properties: Dict[SharedPropertyTypeApiName, SharedPropertyTypeDict] + """ + A map from a shared property type API name to the corresponding shared property type. The map describes the + set of properties the interface has. A shared property type must be unique across all of the properties. + """ + + extendsInterfaces: List[InterfaceTypeApiName] + """ + A list of interface API names that this interface extends. An interface can extend other interfaces to + inherit their properties. + """ + + links: Dict[InterfaceLinkTypeApiName, InterfaceLinkTypeDict] + """ + A map from an interface link type API name to the corresponding interface link type. The map describes the + set of link types the interface has. + """ diff --git a/foundry/v1/models/_interface_type_rid.py b/foundry/v2/ontologies/models/_interface_type_rid.py similarity index 100% rename from foundry/v1/models/_interface_type_rid.py rename to foundry/v2/ontologies/models/_interface_type_rid.py diff --git a/foundry/v2/ontologies/models/_intersects_bounding_box_query.py b/foundry/v2/ontologies/models/_intersects_bounding_box_query.py new file mode 100644 index 00000000..6beea533 --- /dev/null +++ b/foundry/v2/ontologies/models/_intersects_bounding_box_query.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._bounding_box_value import BoundingBoxValue +from foundry.v2.ontologies.models._intersects_bounding_box_query_dict import ( + IntersectsBoundingBoxQueryDict, +) # NOQA +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class IntersectsBoundingBoxQuery(BaseModel): + """Returns objects where the specified field intersects the bounding box provided.""" + + field: PropertyApiName + + value: BoundingBoxValue + + type: Literal["intersectsBoundingBox"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> IntersectsBoundingBoxQueryDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + IntersectsBoundingBoxQueryDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_intersects_bounding_box_query_dict.py b/foundry/v2/ontologies/models/_intersects_bounding_box_query_dict.py new file mode 100644 index 00000000..ff406d74 --- /dev/null +++ b/foundry/v2/ontologies/models/_intersects_bounding_box_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._bounding_box_value_dict import BoundingBoxValueDict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class IntersectsBoundingBoxQueryDict(TypedDict): + """Returns objects where the specified field intersects the bounding box provided.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: BoundingBoxValueDict + + type: Literal["intersectsBoundingBox"] diff --git a/foundry/v2/ontologies/models/_intersects_polygon_query.py b/foundry/v2/ontologies/models/_intersects_polygon_query.py new file mode 100644 index 00000000..6c29ea4d --- /dev/null +++ b/foundry/v2/ontologies/models/_intersects_polygon_query.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._intersects_polygon_query_dict import ( + IntersectsPolygonQueryDict, +) # NOQA +from foundry.v2.ontologies.models._polygon_value import PolygonValue +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class IntersectsPolygonQuery(BaseModel): + """Returns objects where the specified field intersects the polygon provided.""" + + field: PropertyApiName + + value: PolygonValue + + type: Literal["intersectsPolygon"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> IntersectsPolygonQueryDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(IntersectsPolygonQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_intersects_polygon_query_dict.py b/foundry/v2/ontologies/models/_intersects_polygon_query_dict.py new file mode 100644 index 00000000..80d5d38c --- /dev/null +++ b/foundry/v2/ontologies/models/_intersects_polygon_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._polygon_value_dict import PolygonValueDict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class IntersectsPolygonQueryDict(TypedDict): + """Returns objects where the specified field intersects the polygon provided.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: PolygonValueDict + + type: Literal["intersectsPolygon"] diff --git a/foundry/v2/ontologies/models/_is_null_query_v2.py b/foundry/v2/ontologies/models/_is_null_query_v2.py new file mode 100644 index 00000000..16483040 --- /dev/null +++ b/foundry/v2/ontologies/models/_is_null_query_v2.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import StrictBool + +from foundry.v2.ontologies.models._is_null_query_v2_dict import IsNullQueryV2Dict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class IsNullQueryV2(BaseModel): + """Returns objects based on the existence of the specified field.""" + + field: PropertyApiName + + value: StrictBool + + type: Literal["isNull"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> IsNullQueryV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(IsNullQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_is_null_query_v2_dict.py b/foundry/v2/ontologies/models/_is_null_query_v2_dict.py new file mode 100644 index 00000000..e072fa1d --- /dev/null +++ b/foundry/v2/ontologies/models/_is_null_query_v2_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictBool +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class IsNullQueryV2Dict(TypedDict): + """Returns objects based on the existence of the specified field.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: StrictBool + + type: Literal["isNull"] diff --git a/foundry/v2/ontologies/models/_link_side_object.py b/foundry/v2/ontologies/models/_link_side_object.py new file mode 100644 index 00000000..655af934 --- /dev/null +++ b/foundry/v2/ontologies/models/_link_side_object.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._link_side_object_dict import LinkSideObjectDict +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class LinkSideObject(BaseModel): + """LinkSideObject""" + + primary_key: PropertyValue = Field(alias="primaryKey") + + object_type: ObjectTypeApiName = Field(alias="objectType") + + model_config = {"extra": "allow"} + + def to_dict(self) -> LinkSideObjectDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(LinkSideObjectDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_link_side_object_dict.py b/foundry/v2/ontologies/models/_link_side_object_dict.py new file mode 100644 index 00000000..bb881c59 --- /dev/null +++ b/foundry/v2/ontologies/models/_link_side_object_dict.py @@ -0,0 +1,31 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class LinkSideObjectDict(TypedDict): + """LinkSideObject""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + primaryKey: PropertyValue + + objectType: ObjectTypeApiName diff --git a/foundry/v2/models/_link_type_api_name.py b/foundry/v2/ontologies/models/_link_type_api_name.py similarity index 100% rename from foundry/v2/models/_link_type_api_name.py rename to foundry/v2/ontologies/models/_link_type_api_name.py diff --git a/foundry/v1/models/_link_type_rid.py b/foundry/v2/ontologies/models/_link_type_rid.py similarity index 100% rename from foundry/v1/models/_link_type_rid.py rename to foundry/v2/ontologies/models/_link_type_rid.py diff --git a/foundry/v2/models/_link_type_side_cardinality.py b/foundry/v2/ontologies/models/_link_type_side_cardinality.py similarity index 100% rename from foundry/v2/models/_link_type_side_cardinality.py rename to foundry/v2/ontologies/models/_link_type_side_cardinality.py diff --git a/foundry/v2/ontologies/models/_link_type_side_v2.py b/foundry/v2/ontologies/models/_link_type_side_v2.py new file mode 100644 index 00000000..a6d246cc --- /dev/null +++ b/foundry/v2/ontologies/models/_link_type_side_v2.py @@ -0,0 +1,57 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.core.models._release_status import ReleaseStatus +from foundry.v2.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v2.ontologies.models._link_type_rid import LinkTypeRid +from foundry.v2.ontologies.models._link_type_side_cardinality import LinkTypeSideCardinality # NOQA +from foundry.v2.ontologies.models._link_type_side_v2_dict import LinkTypeSideV2Dict +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class LinkTypeSideV2(BaseModel): + """LinkTypeSideV2""" + + api_name: LinkTypeApiName = Field(alias="apiName") + + display_name: DisplayName = Field(alias="displayName") + + status: ReleaseStatus + + object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") + + cardinality: LinkTypeSideCardinality + + foreign_key_property_api_name: Optional[PropertyApiName] = Field( + alias="foreignKeyPropertyApiName", default=None + ) + + link_type_rid: LinkTypeRid = Field(alias="linkTypeRid") + + model_config = {"extra": "allow"} + + def to_dict(self) -> LinkTypeSideV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(LinkTypeSideV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_link_type_side_v2_dict.py b/foundry/v2/ontologies/models/_link_type_side_v2_dict.py new file mode 100644 index 00000000..3cffdf68 --- /dev/null +++ b/foundry/v2/ontologies/models/_link_type_side_v2_dict.py @@ -0,0 +1,47 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.core.models._release_status import ReleaseStatus +from foundry.v2.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v2.ontologies.models._link_type_rid import LinkTypeRid +from foundry.v2.ontologies.models._link_type_side_cardinality import LinkTypeSideCardinality # NOQA +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class LinkTypeSideV2Dict(TypedDict): + """LinkTypeSideV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + apiName: LinkTypeApiName + + displayName: DisplayName + + status: ReleaseStatus + + objectTypeApiName: ObjectTypeApiName + + cardinality: LinkTypeSideCardinality + + foreignKeyPropertyApiName: NotRequired[PropertyApiName] + + linkTypeRid: LinkTypeRid diff --git a/foundry/v2/ontologies/models/_linked_interface_type_api_name.py b/foundry/v2/ontologies/models/_linked_interface_type_api_name.py new file mode 100644 index 00000000..157aba15 --- /dev/null +++ b/foundry/v2/ontologies/models/_linked_interface_type_api_name.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName +from foundry.v2.ontologies.models._linked_interface_type_api_name_dict import ( + LinkedInterfaceTypeApiNameDict, +) # NOQA + + +class LinkedInterfaceTypeApiName(BaseModel): + """A reference to the linked interface type.""" + + api_name: InterfaceTypeApiName = Field(alias="apiName") + + type: Literal["interfaceTypeApiName"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> LinkedInterfaceTypeApiNameDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + LinkedInterfaceTypeApiNameDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_linked_interface_type_api_name_dict.py b/foundry/v2/ontologies/models/_linked_interface_type_api_name_dict.py new file mode 100644 index 00000000..d0298024 --- /dev/null +++ b/foundry/v2/ontologies/models/_linked_interface_type_api_name_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName + + +class LinkedInterfaceTypeApiNameDict(TypedDict): + """A reference to the linked interface type.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + apiName: InterfaceTypeApiName + + type: Literal["interfaceTypeApiName"] diff --git a/foundry/v2/ontologies/models/_linked_object_type_api_name.py b/foundry/v2/ontologies/models/_linked_object_type_api_name.py new file mode 100644 index 00000000..f5f6f991 --- /dev/null +++ b/foundry/v2/ontologies/models/_linked_object_type_api_name.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._linked_object_type_api_name_dict import ( + LinkedObjectTypeApiNameDict, +) # NOQA +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class LinkedObjectTypeApiName(BaseModel): + """A reference to the linked object type.""" + + api_name: ObjectTypeApiName = Field(alias="apiName") + + type: Literal["objectTypeApiName"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> LinkedObjectTypeApiNameDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(LinkedObjectTypeApiNameDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_linked_object_type_api_name_dict.py b/foundry/v2/ontologies/models/_linked_object_type_api_name_dict.py new file mode 100644 index 00000000..419111f5 --- /dev/null +++ b/foundry/v2/ontologies/models/_linked_object_type_api_name_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class LinkedObjectTypeApiNameDict(TypedDict): + """A reference to the linked object type.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + apiName: ObjectTypeApiName + + type: Literal["objectTypeApiName"] diff --git a/foundry/v2/ontologies/models/_list_action_types_response_v2.py b/foundry/v2/ontologies/models/_list_action_types_response_v2.py new file mode 100644 index 00000000..ca18d9ed --- /dev/null +++ b/foundry/v2/ontologies/models/_list_action_types_response_v2.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._action_type_v2 import ActionTypeV2 +from foundry.v2.ontologies.models._list_action_types_response_v2_dict import ( + ListActionTypesResponseV2Dict, +) # NOQA + + +class ListActionTypesResponseV2(BaseModel): + """ListActionTypesResponseV2""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[ActionTypeV2] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListActionTypesResponseV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ListActionTypesResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_list_action_types_response_v2_dict.py b/foundry/v2/ontologies/models/_list_action_types_response_v2_dict.py new file mode 100644 index 00000000..d44301b8 --- /dev/null +++ b/foundry/v2/ontologies/models/_list_action_types_response_v2_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._action_type_v2_dict import ActionTypeV2Dict + + +class ListActionTypesResponseV2Dict(TypedDict): + """ListActionTypesResponseV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nextPageToken: NotRequired[PageToken] + + data: List[ActionTypeV2Dict] diff --git a/foundry/v2/ontologies/models/_list_attachments_response_v2.py b/foundry/v2/ontologies/models/_list_attachments_response_v2.py new file mode 100644 index 00000000..06d29cff --- /dev/null +++ b/foundry/v2/ontologies/models/_list_attachments_response_v2.py @@ -0,0 +1,48 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._attachment_v2 import AttachmentV2 +from foundry.v2.ontologies.models._list_attachments_response_v2_dict import ( + ListAttachmentsResponseV2Dict, +) # NOQA + + +class ListAttachmentsResponseV2(BaseModel): + """ListAttachmentsResponseV2""" + + data: List[AttachmentV2] + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + type: Literal["multiple"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListAttachmentsResponseV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ListAttachmentsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_list_attachments_response_v2_dict.py b/foundry/v2/ontologies/models/_list_attachments_response_v2_dict.py new file mode 100644 index 00000000..629cee2a --- /dev/null +++ b/foundry/v2/ontologies/models/_list_attachments_response_v2_dict.py @@ -0,0 +1,37 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._attachment_v2_dict import AttachmentV2Dict + + +class ListAttachmentsResponseV2Dict(TypedDict): + """ListAttachmentsResponseV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + data: List[AttachmentV2Dict] + + nextPageToken: NotRequired[PageToken] + + type: Literal["multiple"] diff --git a/foundry/v2/ontologies/models/_list_interface_types_response.py b/foundry/v2/ontologies/models/_list_interface_types_response.py new file mode 100644 index 00000000..40736ca9 --- /dev/null +++ b/foundry/v2/ontologies/models/_list_interface_types_response.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._interface_type import InterfaceType +from foundry.v2.ontologies.models._list_interface_types_response_dict import ( + ListInterfaceTypesResponseDict, +) # NOQA + + +class ListInterfaceTypesResponse(BaseModel): + """ListInterfaceTypesResponse""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[InterfaceType] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListInterfaceTypesResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ListInterfaceTypesResponseDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_list_interface_types_response_dict.py b/foundry/v2/ontologies/models/_list_interface_types_response_dict.py new file mode 100644 index 00000000..1880d63c --- /dev/null +++ b/foundry/v2/ontologies/models/_list_interface_types_response_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._interface_type_dict import InterfaceTypeDict + + +class ListInterfaceTypesResponseDict(TypedDict): + """ListInterfaceTypesResponse""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nextPageToken: NotRequired[PageToken] + + data: List[InterfaceTypeDict] diff --git a/foundry/v2/ontologies/models/_list_linked_objects_response_v2.py b/foundry/v2/ontologies/models/_list_linked_objects_response_v2.py new file mode 100644 index 00000000..e1a30841 --- /dev/null +++ b/foundry/v2/ontologies/models/_list_linked_objects_response_v2.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._list_linked_objects_response_v2_dict import ( + ListLinkedObjectsResponseV2Dict, +) # NOQA +from foundry.v2.ontologies.models._ontology_object_v2 import OntologyObjectV2 + + +class ListLinkedObjectsResponseV2(BaseModel): + """ListLinkedObjectsResponseV2""" + + data: List[OntologyObjectV2] + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListLinkedObjectsResponseV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ListLinkedObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_list_linked_objects_response_v2_dict.py b/foundry/v2/ontologies/models/_list_linked_objects_response_v2_dict.py new file mode 100644 index 00000000..3a3bceca --- /dev/null +++ b/foundry/v2/ontologies/models/_list_linked_objects_response_v2_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._ontology_object_v2 import OntologyObjectV2 + + +class ListLinkedObjectsResponseV2Dict(TypedDict): + """ListLinkedObjectsResponseV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + data: List[OntologyObjectV2] + + nextPageToken: NotRequired[PageToken] diff --git a/foundry/v2/ontologies/models/_list_object_types_v2_response.py b/foundry/v2/ontologies/models/_list_object_types_v2_response.py new file mode 100644 index 00000000..1f572456 --- /dev/null +++ b/foundry/v2/ontologies/models/_list_object_types_v2_response.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._list_object_types_v2_response_dict import ( + ListObjectTypesV2ResponseDict, +) # NOQA +from foundry.v2.ontologies.models._object_type_v2 import ObjectTypeV2 + + +class ListObjectTypesV2Response(BaseModel): + """ListObjectTypesV2Response""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[ObjectTypeV2] + """The list of object types in the current page.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListObjectTypesV2ResponseDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ListObjectTypesV2ResponseDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_list_object_types_v2_response_dict.py b/foundry/v2/ontologies/models/_list_object_types_v2_response_dict.py new file mode 100644 index 00000000..e98f8d3b --- /dev/null +++ b/foundry/v2/ontologies/models/_list_object_types_v2_response_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._object_type_v2_dict import ObjectTypeV2Dict + + +class ListObjectTypesV2ResponseDict(TypedDict): + """ListObjectTypesV2Response""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nextPageToken: NotRequired[PageToken] + + data: List[ObjectTypeV2Dict] + """The list of object types in the current page.""" diff --git a/foundry/v2/ontologies/models/_list_objects_response_v2.py b/foundry/v2/ontologies/models/_list_objects_response_v2.py new file mode 100644 index 00000000..1ffbea8a --- /dev/null +++ b/foundry/v2/ontologies/models/_list_objects_response_v2.py @@ -0,0 +1,47 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._total_count import TotalCount +from foundry.v2.ontologies.models._list_objects_response_v2_dict import ( + ListObjectsResponseV2Dict, +) # NOQA +from foundry.v2.ontologies.models._ontology_object_v2 import OntologyObjectV2 + + +class ListObjectsResponseV2(BaseModel): + """ListObjectsResponseV2""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[OntologyObjectV2] + """The list of objects in the current page.""" + + total_count: TotalCount = Field(alias="totalCount") + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListObjectsResponseV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ListObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_list_objects_response_v2_dict.py b/foundry/v2/ontologies/models/_list_objects_response_v2_dict.py new file mode 100644 index 00000000..f228c8de --- /dev/null +++ b/foundry/v2/ontologies/models/_list_objects_response_v2_dict.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._total_count import TotalCount +from foundry.v2.ontologies.models._ontology_object_v2 import OntologyObjectV2 + + +class ListObjectsResponseV2Dict(TypedDict): + """ListObjectsResponseV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nextPageToken: NotRequired[PageToken] + + data: List[OntologyObjectV2] + """The list of objects in the current page.""" + + totalCount: TotalCount diff --git a/foundry/v2/ontologies/models/_list_outgoing_link_types_response_v2.py b/foundry/v2/ontologies/models/_list_outgoing_link_types_response_v2.py new file mode 100644 index 00000000..e27d6233 --- /dev/null +++ b/foundry/v2/ontologies/models/_list_outgoing_link_types_response_v2.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._link_type_side_v2 import LinkTypeSideV2 +from foundry.v2.ontologies.models._list_outgoing_link_types_response_v2_dict import ( + ListOutgoingLinkTypesResponseV2Dict, +) # NOQA + + +class ListOutgoingLinkTypesResponseV2(BaseModel): + """ListOutgoingLinkTypesResponseV2""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[LinkTypeSideV2] + """The list of link type sides in the current page.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListOutgoingLinkTypesResponseV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ListOutgoingLinkTypesResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_list_outgoing_link_types_response_v2_dict.py b/foundry/v2/ontologies/models/_list_outgoing_link_types_response_v2_dict.py new file mode 100644 index 00000000..c2209d7c --- /dev/null +++ b/foundry/v2/ontologies/models/_list_outgoing_link_types_response_v2_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._link_type_side_v2_dict import LinkTypeSideV2Dict + + +class ListOutgoingLinkTypesResponseV2Dict(TypedDict): + """ListOutgoingLinkTypesResponseV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nextPageToken: NotRequired[PageToken] + + data: List[LinkTypeSideV2Dict] + """The list of link type sides in the current page.""" diff --git a/foundry/v2/ontologies/models/_list_query_types_response_v2.py b/foundry/v2/ontologies/models/_list_query_types_response_v2.py new file mode 100644 index 00000000..6731fa0e --- /dev/null +++ b/foundry/v2/ontologies/models/_list_query_types_response_v2.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._list_query_types_response_v2_dict import ( + ListQueryTypesResponseV2Dict, +) # NOQA +from foundry.v2.ontologies.models._query_type_v2 import QueryTypeV2 + + +class ListQueryTypesResponseV2(BaseModel): + """ListQueryTypesResponseV2""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + data: List[QueryTypeV2] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ListQueryTypesResponseV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ListQueryTypesResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_list_query_types_response_v2_dict.py b/foundry/v2/ontologies/models/_list_query_types_response_v2_dict.py new file mode 100644 index 00000000..94b9d2bd --- /dev/null +++ b/foundry/v2/ontologies/models/_list_query_types_response_v2_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._query_type_v2_dict import QueryTypeV2Dict + + +class ListQueryTypesResponseV2Dict(TypedDict): + """ListQueryTypesResponseV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + nextPageToken: NotRequired[PageToken] + + data: List[QueryTypeV2Dict] diff --git a/foundry/v2/ontologies/models/_load_object_set_response_v2.py b/foundry/v2/ontologies/models/_load_object_set_response_v2.py new file mode 100644 index 00000000..720c93e7 --- /dev/null +++ b/foundry/v2/ontologies/models/_load_object_set_response_v2.py @@ -0,0 +1,47 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._total_count import TotalCount +from foundry.v2.ontologies.models._load_object_set_response_v2_dict import ( + LoadObjectSetResponseV2Dict, +) # NOQA +from foundry.v2.ontologies.models._ontology_object_v2 import OntologyObjectV2 + + +class LoadObjectSetResponseV2(BaseModel): + """Represents the API response when loading an `ObjectSet`.""" + + data: List[OntologyObjectV2] + """The list of objects in the current Page.""" + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + total_count: TotalCount = Field(alias="totalCount") + + model_config = {"extra": "allow"} + + def to_dict(self) -> LoadObjectSetResponseV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(LoadObjectSetResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_load_object_set_response_v2_dict.py b/foundry/v2/ontologies/models/_load_object_set_response_v2_dict.py new file mode 100644 index 00000000..4c4de409 --- /dev/null +++ b/foundry/v2/ontologies/models/_load_object_set_response_v2_dict.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._total_count import TotalCount +from foundry.v2.ontologies.models._ontology_object_v2 import OntologyObjectV2 + + +class LoadObjectSetResponseV2Dict(TypedDict): + """Represents the API response when loading an `ObjectSet`.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + data: List[OntologyObjectV2] + """The list of objects in the current Page.""" + + nextPageToken: NotRequired[PageToken] + + totalCount: TotalCount diff --git a/foundry/v2/ontologies/models/_logic_rule.py b/foundry/v2/ontologies/models/_logic_rule.py new file mode 100644 index 00000000..89d9c26f --- /dev/null +++ b/foundry/v2/ontologies/models/_logic_rule.py @@ -0,0 +1,47 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._create_interface_object_rule import ( + CreateInterfaceObjectRule, +) # NOQA +from foundry.v2.ontologies.models._create_link_rule import CreateLinkRule +from foundry.v2.ontologies.models._create_object_rule import CreateObjectRule +from foundry.v2.ontologies.models._delete_link_rule import DeleteLinkRule +from foundry.v2.ontologies.models._delete_object_rule import DeleteObjectRule +from foundry.v2.ontologies.models._modify_interface_object_rule import ( + ModifyInterfaceObjectRule, +) # NOQA +from foundry.v2.ontologies.models._modify_object_rule import ModifyObjectRule + +LogicRule = Annotated[ + Union[ + ModifyInterfaceObjectRule, + ModifyObjectRule, + DeleteObjectRule, + CreateInterfaceObjectRule, + DeleteLinkRule, + CreateObjectRule, + CreateLinkRule, + ], + Field(discriminator="type"), +] +"""LogicRule""" diff --git a/foundry/v2/ontologies/models/_logic_rule_dict.py b/foundry/v2/ontologies/models/_logic_rule_dict.py new file mode 100644 index 00000000..5745bba2 --- /dev/null +++ b/foundry/v2/ontologies/models/_logic_rule_dict.py @@ -0,0 +1,47 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._create_interface_object_rule_dict import ( + CreateInterfaceObjectRuleDict, +) # NOQA +from foundry.v2.ontologies.models._create_link_rule_dict import CreateLinkRuleDict +from foundry.v2.ontologies.models._create_object_rule_dict import CreateObjectRuleDict +from foundry.v2.ontologies.models._delete_link_rule_dict import DeleteLinkRuleDict +from foundry.v2.ontologies.models._delete_object_rule_dict import DeleteObjectRuleDict +from foundry.v2.ontologies.models._modify_interface_object_rule_dict import ( + ModifyInterfaceObjectRuleDict, +) # NOQA +from foundry.v2.ontologies.models._modify_object_rule_dict import ModifyObjectRuleDict + +LogicRuleDict = Annotated[ + Union[ + ModifyInterfaceObjectRuleDict, + ModifyObjectRuleDict, + DeleteObjectRuleDict, + CreateInterfaceObjectRuleDict, + DeleteLinkRuleDict, + CreateObjectRuleDict, + CreateLinkRuleDict, + ], + Field(discriminator="type"), +] +"""LogicRule""" diff --git a/foundry/v2/ontologies/models/_lt_query_v2.py b/foundry/v2/ontologies/models/_lt_query_v2.py new file mode 100644 index 00000000..35097707 --- /dev/null +++ b/foundry/v2/ontologies/models/_lt_query_v2.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._lt_query_v2_dict import LtQueryV2Dict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class LtQueryV2(BaseModel): + """Returns objects where the specified field is less than a value.""" + + field: PropertyApiName + + value: PropertyValue + + type: Literal["lt"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> LtQueryV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(LtQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_lt_query_v2_dict.py b/foundry/v2/ontologies/models/_lt_query_v2_dict.py new file mode 100644 index 00000000..3eac3fa2 --- /dev/null +++ b/foundry/v2/ontologies/models/_lt_query_v2_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class LtQueryV2Dict(TypedDict): + """Returns objects where the specified field is less than a value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: PropertyValue + + type: Literal["lt"] diff --git a/foundry/v2/ontologies/models/_lte_query_v2.py b/foundry/v2/ontologies/models/_lte_query_v2.py new file mode 100644 index 00000000..d648b378 --- /dev/null +++ b/foundry/v2/ontologies/models/_lte_query_v2.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._lte_query_v2_dict import LteQueryV2Dict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class LteQueryV2(BaseModel): + """Returns objects where the specified field is less than or equal to a value.""" + + field: PropertyApiName + + value: PropertyValue + + type: Literal["lte"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> LteQueryV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(LteQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_lte_query_v2_dict.py b/foundry/v2/ontologies/models/_lte_query_v2_dict.py new file mode 100644 index 00000000..55a77f4a --- /dev/null +++ b/foundry/v2/ontologies/models/_lte_query_v2_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class LteQueryV2Dict(TypedDict): + """Returns objects where the specified field is less than or equal to a value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: PropertyValue + + type: Literal["lte"] diff --git a/foundry/v2/ontologies/models/_max_aggregation_v2_dict.py b/foundry/v2/ontologies/models/_max_aggregation_v2_dict.py new file mode 100644 index 00000000..881a6844 --- /dev/null +++ b/foundry/v2/ontologies/models/_max_aggregation_v2_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._aggregation_metric_name import AggregationMetricName +from foundry.v2.ontologies.models._order_by_direction import OrderByDirection +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class MaxAggregationV2Dict(TypedDict): + """Computes the maximum value for the provided field.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + name: NotRequired[AggregationMetricName] + + direction: NotRequired[OrderByDirection] + + type: Literal["max"] diff --git a/foundry/v2/ontologies/models/_min_aggregation_v2_dict.py b/foundry/v2/ontologies/models/_min_aggregation_v2_dict.py new file mode 100644 index 00000000..1251c758 --- /dev/null +++ b/foundry/v2/ontologies/models/_min_aggregation_v2_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._aggregation_metric_name import AggregationMetricName +from foundry.v2.ontologies.models._order_by_direction import OrderByDirection +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class MinAggregationV2Dict(TypedDict): + """Computes the minimum value for the provided field.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + name: NotRequired[AggregationMetricName] + + direction: NotRequired[OrderByDirection] + + type: Literal["min"] diff --git a/foundry/v2/ontologies/models/_modify_interface_object_rule.py b/foundry/v2/ontologies/models/_modify_interface_object_rule.py new file mode 100644 index 00000000..d750232a --- /dev/null +++ b/foundry/v2/ontologies/models/_modify_interface_object_rule.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._modify_interface_object_rule_dict import ( + ModifyInterfaceObjectRuleDict, +) # NOQA + + +class ModifyInterfaceObjectRule(BaseModel): + """ModifyInterfaceObjectRule""" + + type: Literal["modifyInterfaceObject"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ModifyInterfaceObjectRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ModifyInterfaceObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_modify_interface_object_rule_dict.py b/foundry/v2/ontologies/models/_modify_interface_object_rule_dict.py new file mode 100644 index 00000000..2ce1db20 --- /dev/null +++ b/foundry/v2/ontologies/models/_modify_interface_object_rule_dict.py @@ -0,0 +1,28 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + + +class ModifyInterfaceObjectRuleDict(TypedDict): + """ModifyInterfaceObjectRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + type: Literal["modifyInterfaceObject"] diff --git a/foundry/v2/ontologies/models/_modify_object.py b/foundry/v2/ontologies/models/_modify_object.py new file mode 100644 index 00000000..24cb408a --- /dev/null +++ b/foundry/v2/ontologies/models/_modify_object.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._modify_object_dict import ModifyObjectDict +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class ModifyObject(BaseModel): + """ModifyObject""" + + primary_key: PropertyValue = Field(alias="primaryKey") + + object_type: ObjectTypeApiName = Field(alias="objectType") + + type: Literal["modifyObject"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ModifyObjectDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ModifyObjectDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_modify_object_dict.py b/foundry/v2/ontologies/models/_modify_object_dict.py new file mode 100644 index 00000000..9985a435 --- /dev/null +++ b/foundry/v2/ontologies/models/_modify_object_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + + +class ModifyObjectDict(TypedDict): + """ModifyObject""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + primaryKey: PropertyValue + + objectType: ObjectTypeApiName + + type: Literal["modifyObject"] diff --git a/foundry/v2/ontologies/models/_modify_object_rule.py b/foundry/v2/ontologies/models/_modify_object_rule.py new file mode 100644 index 00000000..5c3389cd --- /dev/null +++ b/foundry/v2/ontologies/models/_modify_object_rule.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._modify_object_rule_dict import ModifyObjectRuleDict +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class ModifyObjectRule(BaseModel): + """ModifyObjectRule""" + + object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") + + type: Literal["modifyObject"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ModifyObjectRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ModifyObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_modify_object_rule_dict.py b/foundry/v2/ontologies/models/_modify_object_rule_dict.py new file mode 100644 index 00000000..7a16c6d8 --- /dev/null +++ b/foundry/v2/ontologies/models/_modify_object_rule_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class ModifyObjectRuleDict(TypedDict): + """ModifyObjectRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectTypeApiName: ObjectTypeApiName + + type: Literal["modifyObject"] diff --git a/foundry/v2/ontologies/models/_not_query_v2.py b/foundry/v2/ontologies/models/_not_query_v2.py new file mode 100644 index 00000000..45a39424 --- /dev/null +++ b/foundry/v2/ontologies/models/_not_query_v2.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._not_query_v2_dict import NotQueryV2Dict +from foundry.v2.ontologies.models._search_json_query_v2 import SearchJsonQueryV2 + + +class NotQueryV2(BaseModel): + """Returns objects where the query is not satisfied.""" + + value: SearchJsonQueryV2 + + type: Literal["not"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> NotQueryV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(NotQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_not_query_v2_dict.py b/foundry/v2/ontologies/models/_not_query_v2_dict.py new file mode 100644 index 00000000..a9f55d49 --- /dev/null +++ b/foundry/v2/ontologies/models/_not_query_v2_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._search_json_query_v2_dict import SearchJsonQueryV2Dict # NOQA + + +class NotQueryV2Dict(TypedDict): + """Returns objects where the query is not satisfied.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: SearchJsonQueryV2Dict + + type: Literal["not"] diff --git a/foundry/v2/ontologies/models/_object_edit.py b/foundry/v2/ontologies/models/_object_edit.py new file mode 100644 index 00000000..aca4b93d --- /dev/null +++ b/foundry/v2/ontologies/models/_object_edit.py @@ -0,0 +1,28 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._add_link import AddLink +from foundry.v2.ontologies.models._add_object import AddObject +from foundry.v2.ontologies.models._modify_object import ModifyObject + +ObjectEdit = Annotated[Union[ModifyObject, AddObject, AddLink], Field(discriminator="type")] +"""ObjectEdit""" diff --git a/foundry/v2/ontologies/models/_object_edit_dict.py b/foundry/v2/ontologies/models/_object_edit_dict.py new file mode 100644 index 00000000..ecd11104 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_edit_dict.py @@ -0,0 +1,30 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._add_link_dict import AddLinkDict +from foundry.v2.ontologies.models._add_object_dict import AddObjectDict +from foundry.v2.ontologies.models._modify_object_dict import ModifyObjectDict + +ObjectEditDict = Annotated[ + Union[ModifyObjectDict, AddObjectDict, AddLinkDict], Field(discriminator="type") +] +"""ObjectEdit""" diff --git a/foundry/v2/ontologies/models/_object_edits.py b/foundry/v2/ontologies/models/_object_edits.py new file mode 100644 index 00000000..c6b9c9ed --- /dev/null +++ b/foundry/v2/ontologies/models/_object_edits.py @@ -0,0 +1,51 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictInt + +from foundry.v2.ontologies.models._object_edit import ObjectEdit +from foundry.v2.ontologies.models._object_edits_dict import ObjectEditsDict + + +class ObjectEdits(BaseModel): + """ObjectEdits""" + + edits: List[ObjectEdit] + + added_object_count: StrictInt = Field(alias="addedObjectCount") + + modified_objects_count: StrictInt = Field(alias="modifiedObjectsCount") + + deleted_objects_count: StrictInt = Field(alias="deletedObjectsCount") + + added_links_count: StrictInt = Field(alias="addedLinksCount") + + deleted_links_count: StrictInt = Field(alias="deletedLinksCount") + + type: Literal["edits"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectEditsDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ObjectEditsDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_object_edits_dict.py b/foundry/v2/ontologies/models/_object_edits_dict.py new file mode 100644 index 00000000..56119218 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_edits_dict.py @@ -0,0 +1,44 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from pydantic import StrictInt +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_edit_dict import ObjectEditDict + + +class ObjectEditsDict(TypedDict): + """ObjectEdits""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + edits: List[ObjectEditDict] + + addedObjectCount: StrictInt + + modifiedObjectsCount: StrictInt + + deletedObjectsCount: StrictInt + + addedLinksCount: StrictInt + + deletedLinksCount: StrictInt + + type: Literal["edits"] diff --git a/foundry/v2/ontologies/models/_object_property_type.py b/foundry/v2/ontologies/models/_object_property_type.py new file mode 100644 index 00000000..2c487d33 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_property_type.py @@ -0,0 +1,83 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import Union +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.core.models._attachment_type import AttachmentType +from foundry.v2.core.models._boolean_type import BooleanType +from foundry.v2.core.models._byte_type import ByteType +from foundry.v2.core.models._date_type import DateType +from foundry.v2.core.models._decimal_type import DecimalType +from foundry.v2.core.models._double_type import DoubleType +from foundry.v2.core.models._float_type import FloatType +from foundry.v2.core.models._geo_point_type import GeoPointType +from foundry.v2.core.models._geo_shape_type import GeoShapeType +from foundry.v2.core.models._integer_type import IntegerType +from foundry.v2.core.models._long_type import LongType +from foundry.v2.core.models._marking_type import MarkingType +from foundry.v2.core.models._short_type import ShortType +from foundry.v2.core.models._string_type import StringType +from foundry.v2.core.models._timeseries_type import TimeseriesType +from foundry.v2.core.models._timestamp_type import TimestampType +from foundry.v2.ontologies.models._ontology_object_array_type_dict import ( + OntologyObjectArrayTypeDict, +) # NOQA + + +class OntologyObjectArrayType(BaseModel): + """OntologyObjectArrayType""" + + sub_type: ObjectPropertyType = Field(alias="subType") + + type: Literal["array"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyObjectArrayTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyObjectArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +ObjectPropertyType = Annotated[ + Union[ + DateType, + StringType, + ByteType, + DoubleType, + GeoPointType, + IntegerType, + FloatType, + GeoShapeType, + LongType, + BooleanType, + MarkingType, + AttachmentType, + TimeseriesType, + OntologyObjectArrayType, + ShortType, + DecimalType, + TimestampType, + ], + Field(discriminator="type"), +] +"""A union of all the types supported by Ontology Object properties.""" diff --git a/foundry/v2/ontologies/models/_object_property_type_dict.py b/foundry/v2/ontologies/models/_object_property_type_dict.py new file mode 100644 index 00000000..6b91c053 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_property_type_dict.py @@ -0,0 +1,75 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry.v2.core.models._attachment_type_dict import AttachmentTypeDict +from foundry.v2.core.models._boolean_type_dict import BooleanTypeDict +from foundry.v2.core.models._byte_type_dict import ByteTypeDict +from foundry.v2.core.models._date_type_dict import DateTypeDict +from foundry.v2.core.models._decimal_type_dict import DecimalTypeDict +from foundry.v2.core.models._double_type_dict import DoubleTypeDict +from foundry.v2.core.models._float_type_dict import FloatTypeDict +from foundry.v2.core.models._geo_point_type_dict import GeoPointTypeDict +from foundry.v2.core.models._geo_shape_type_dict import GeoShapeTypeDict +from foundry.v2.core.models._integer_type_dict import IntegerTypeDict +from foundry.v2.core.models._long_type_dict import LongTypeDict +from foundry.v2.core.models._marking_type_dict import MarkingTypeDict +from foundry.v2.core.models._short_type_dict import ShortTypeDict +from foundry.v2.core.models._string_type_dict import StringTypeDict +from foundry.v2.core.models._timeseries_type_dict import TimeseriesTypeDict +from foundry.v2.core.models._timestamp_type_dict import TimestampTypeDict + + +class OntologyObjectArrayTypeDict(TypedDict): + """OntologyObjectArrayType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + subType: ObjectPropertyTypeDict + + type: Literal["array"] + + +ObjectPropertyTypeDict = Annotated[ + Union[ + DateTypeDict, + StringTypeDict, + ByteTypeDict, + DoubleTypeDict, + GeoPointTypeDict, + IntegerTypeDict, + FloatTypeDict, + GeoShapeTypeDict, + LongTypeDict, + BooleanTypeDict, + MarkingTypeDict, + AttachmentTypeDict, + TimeseriesTypeDict, + OntologyObjectArrayTypeDict, + ShortTypeDict, + DecimalTypeDict, + TimestampTypeDict, + ], + Field(discriminator="type"), +] +"""A union of all the types supported by Ontology Object properties.""" diff --git a/foundry/v2/ontologies/models/_object_property_value_constraint.py b/foundry/v2/ontologies/models/_object_property_value_constraint.py new file mode 100644 index 00000000..926b0cec --- /dev/null +++ b/foundry/v2/ontologies/models/_object_property_value_constraint.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._object_property_value_constraint_dict import ( + ObjectPropertyValueConstraintDict, +) # NOQA + + +class ObjectPropertyValueConstraint(BaseModel): + """The parameter value must be a property value of an object found within an object set.""" + + type: Literal["objectPropertyValue"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectPropertyValueConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ObjectPropertyValueConstraintDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/models/_object_property_value_constraint_dict.py b/foundry/v2/ontologies/models/_object_property_value_constraint_dict.py similarity index 100% rename from foundry/v2/models/_object_property_value_constraint_dict.py rename to foundry/v2/ontologies/models/_object_property_value_constraint_dict.py diff --git a/foundry/v2/ontologies/models/_object_query_result_constraint.py b/foundry/v2/ontologies/models/_object_query_result_constraint.py new file mode 100644 index 00000000..ac043b1f --- /dev/null +++ b/foundry/v2/ontologies/models/_object_query_result_constraint.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._object_query_result_constraint_dict import ( + ObjectQueryResultConstraintDict, +) # NOQA + + +class ObjectQueryResultConstraint(BaseModel): + """The parameter value must be the primary key of an object found within an object set.""" + + type: Literal["objectQueryResult"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectQueryResultConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ObjectQueryResultConstraintDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/models/_object_query_result_constraint_dict.py b/foundry/v2/ontologies/models/_object_query_result_constraint_dict.py similarity index 100% rename from foundry/v2/models/_object_query_result_constraint_dict.py rename to foundry/v2/ontologies/models/_object_query_result_constraint_dict.py diff --git a/foundry/v2/models/_object_rid.py b/foundry/v2/ontologies/models/_object_rid.py similarity index 100% rename from foundry/v2/models/_object_rid.py rename to foundry/v2/ontologies/models/_object_rid.py diff --git a/foundry/v2/ontologies/models/_object_set.py b/foundry/v2/ontologies/models/_object_set.py new file mode 100644 index 00000000..c45c88d3 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set.py @@ -0,0 +1,138 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import Union +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v2.ontologies.models._object_set_base_type import ObjectSetBaseType +from foundry.v2.ontologies.models._object_set_filter_type_dict import ( + ObjectSetFilterTypeDict, +) # NOQA +from foundry.v2.ontologies.models._object_set_intersection_type_dict import ( + ObjectSetIntersectionTypeDict, +) # NOQA +from foundry.v2.ontologies.models._object_set_reference_type import ObjectSetReferenceType # NOQA +from foundry.v2.ontologies.models._object_set_search_around_type_dict import ( + ObjectSetSearchAroundTypeDict, +) # NOQA +from foundry.v2.ontologies.models._object_set_static_type import ObjectSetStaticType +from foundry.v2.ontologies.models._object_set_subtract_type_dict import ( + ObjectSetSubtractTypeDict, +) # NOQA +from foundry.v2.ontologies.models._object_set_union_type_dict import ObjectSetUnionTypeDict # NOQA +from foundry.v2.ontologies.models._search_json_query_v2 import SearchJsonQueryV2 + + +class ObjectSetFilterType(BaseModel): + """ObjectSetFilterType""" + + object_set: ObjectSet = Field(alias="objectSet") + + where: SearchJsonQueryV2 + + type: Literal["filter"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectSetFilterTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ObjectSetFilterTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +class ObjectSetSearchAroundType(BaseModel): + """ObjectSetSearchAroundType""" + + object_set: ObjectSet = Field(alias="objectSet") + + link: LinkTypeApiName + + type: Literal["searchAround"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectSetSearchAroundTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ObjectSetSearchAroundTypeDict, self.model_dump(by_alias=True, exclude_unset=True) + ) + + +class ObjectSetIntersectionType(BaseModel): + """ObjectSetIntersectionType""" + + object_sets: List[ObjectSet] = Field(alias="objectSets") + + type: Literal["intersect"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectSetIntersectionTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ObjectSetIntersectionTypeDict, self.model_dump(by_alias=True, exclude_unset=True) + ) + + +class ObjectSetSubtractType(BaseModel): + """ObjectSetSubtractType""" + + object_sets: List[ObjectSet] = Field(alias="objectSets") + + type: Literal["subtract"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectSetSubtractTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ObjectSetSubtractTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +class ObjectSetUnionType(BaseModel): + """ObjectSetUnionType""" + + object_sets: List[ObjectSet] = Field(alias="objectSets") + + type: Literal["union"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectSetUnionTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ObjectSetUnionTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +ObjectSet = Annotated[ + Union[ + ObjectSetReferenceType, + ObjectSetFilterType, + ObjectSetSearchAroundType, + ObjectSetStaticType, + ObjectSetIntersectionType, + ObjectSetSubtractType, + ObjectSetUnionType, + ObjectSetBaseType, + ], + Field(discriminator="type"), +] +"""Represents the definition of an `ObjectSet` in the `Ontology`.""" diff --git a/foundry/v2/ontologies/models/_object_set_base_type.py b/foundry/v2/ontologies/models/_object_set_base_type.py new file mode 100644 index 00000000..3636e76b --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_base_type.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.ontologies.models._object_set_base_type_dict import ObjectSetBaseTypeDict # NOQA + + +class ObjectSetBaseType(BaseModel): + """ObjectSetBaseType""" + + object_type: StrictStr = Field(alias="objectType") + + type: Literal["base"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectSetBaseTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ObjectSetBaseTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_object_set_base_type_dict.py b/foundry/v2/ontologies/models/_object_set_base_type_dict.py similarity index 100% rename from foundry/v1/models/_object_set_base_type_dict.py rename to foundry/v2/ontologies/models/_object_set_base_type_dict.py diff --git a/foundry/v2/ontologies/models/_object_set_dict.py b/foundry/v2/ontologies/models/_object_set_dict.py new file mode 100644 index 00000000..e8df4600 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_dict.py @@ -0,0 +1,104 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v2.ontologies.models._object_set_base_type_dict import ObjectSetBaseTypeDict # NOQA +from foundry.v2.ontologies.models._object_set_reference_type_dict import ( + ObjectSetReferenceTypeDict, +) # NOQA +from foundry.v2.ontologies.models._object_set_static_type_dict import ( + ObjectSetStaticTypeDict, +) # NOQA +from foundry.v2.ontologies.models._search_json_query_v2_dict import SearchJsonQueryV2Dict # NOQA + + +class ObjectSetFilterTypeDict(TypedDict): + """ObjectSetFilterType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectSet: ObjectSetDict + + where: SearchJsonQueryV2Dict + + type: Literal["filter"] + + +class ObjectSetSearchAroundTypeDict(TypedDict): + """ObjectSetSearchAroundType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectSet: ObjectSetDict + + link: LinkTypeApiName + + type: Literal["searchAround"] + + +class ObjectSetIntersectionTypeDict(TypedDict): + """ObjectSetIntersectionType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectSets: List[ObjectSetDict] + + type: Literal["intersect"] + + +class ObjectSetSubtractTypeDict(TypedDict): + """ObjectSetSubtractType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectSets: List[ObjectSetDict] + + type: Literal["subtract"] + + +class ObjectSetUnionTypeDict(TypedDict): + """ObjectSetUnionType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectSets: List[ObjectSetDict] + + type: Literal["union"] + + +ObjectSetDict = Annotated[ + Union[ + ObjectSetReferenceTypeDict, + ObjectSetFilterTypeDict, + ObjectSetSearchAroundTypeDict, + ObjectSetStaticTypeDict, + ObjectSetIntersectionTypeDict, + ObjectSetSubtractTypeDict, + ObjectSetUnionTypeDict, + ObjectSetBaseTypeDict, + ], + Field(discriminator="type"), +] +"""Represents the definition of an `ObjectSet` in the `Ontology`.""" diff --git a/foundry/v2/ontologies/models/_object_set_filter_type.py b/foundry/v2/ontologies/models/_object_set_filter_type.py new file mode 100644 index 00000000..81370c41 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_filter_type.py @@ -0,0 +1,44 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._object_set import ObjectSet +from foundry.v2.ontologies.models._object_set_filter_type_dict import ( + ObjectSetFilterTypeDict, +) # NOQA +from foundry.v2.ontologies.models._search_json_query_v2 import SearchJsonQueryV2 + + +class ObjectSetFilterType(BaseModel): + """ObjectSetFilterType""" + + object_set: ObjectSet = Field(alias="objectSet") + + where: SearchJsonQueryV2 + + type: Literal["filter"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectSetFilterTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ObjectSetFilterTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_object_set_filter_type_dict.py b/foundry/v2/ontologies/models/_object_set_filter_type_dict.py new file mode 100644 index 00000000..7252323c --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_filter_type_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_set_dict import ObjectSetDict +from foundry.v2.ontologies.models._search_json_query_v2_dict import SearchJsonQueryV2Dict # NOQA + + +class ObjectSetFilterTypeDict(TypedDict): + """ObjectSetFilterType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectSet: ObjectSetDict + + where: SearchJsonQueryV2Dict + + type: Literal["filter"] diff --git a/foundry/v2/ontologies/models/_object_set_intersection_type.py b/foundry/v2/ontologies/models/_object_set_intersection_type.py new file mode 100644 index 00000000..a4fb8a33 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_intersection_type.py @@ -0,0 +1,44 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._object_set import ObjectSet +from foundry.v2.ontologies.models._object_set_intersection_type_dict import ( + ObjectSetIntersectionTypeDict, +) # NOQA + + +class ObjectSetIntersectionType(BaseModel): + """ObjectSetIntersectionType""" + + object_sets: List[ObjectSet] = Field(alias="objectSets") + + type: Literal["intersect"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectSetIntersectionTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ObjectSetIntersectionTypeDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_object_set_intersection_type_dict.py b/foundry/v2/ontologies/models/_object_set_intersection_type_dict.py new file mode 100644 index 00000000..ef2c1001 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_intersection_type_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_set_dict import ObjectSetDict + + +class ObjectSetIntersectionTypeDict(TypedDict): + """ObjectSetIntersectionType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectSets: List[ObjectSetDict] + + type: Literal["intersect"] diff --git a/foundry/v2/ontologies/models/_object_set_reference_type.py b/foundry/v2/ontologies/models/_object_set_reference_type.py new file mode 100644 index 00000000..b4744c39 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_reference_type.py @@ -0,0 +1,40 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry._core.utils import RID +from foundry.v2.ontologies.models._object_set_reference_type_dict import ( + ObjectSetReferenceTypeDict, +) # NOQA + + +class ObjectSetReferenceType(BaseModel): + """ObjectSetReferenceType""" + + reference: RID + + type: Literal["reference"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectSetReferenceTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ObjectSetReferenceTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_object_set_reference_type_dict.py b/foundry/v2/ontologies/models/_object_set_reference_type_dict.py similarity index 100% rename from foundry/v1/models/_object_set_reference_type_dict.py rename to foundry/v2/ontologies/models/_object_set_reference_type_dict.py diff --git a/foundry/v1/models/_object_set_rid.py b/foundry/v2/ontologies/models/_object_set_rid.py similarity index 100% rename from foundry/v1/models/_object_set_rid.py rename to foundry/v2/ontologies/models/_object_set_rid.py diff --git a/foundry/v2/ontologies/models/_object_set_search_around_type.py b/foundry/v2/ontologies/models/_object_set_search_around_type.py new file mode 100644 index 00000000..9d377a02 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_search_around_type.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v2.ontologies.models._object_set import ObjectSet +from foundry.v2.ontologies.models._object_set_search_around_type_dict import ( + ObjectSetSearchAroundTypeDict, +) # NOQA + + +class ObjectSetSearchAroundType(BaseModel): + """ObjectSetSearchAroundType""" + + object_set: ObjectSet = Field(alias="objectSet") + + link: LinkTypeApiName + + type: Literal["searchAround"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectSetSearchAroundTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ObjectSetSearchAroundTypeDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_object_set_search_around_type_dict.py b/foundry/v2/ontologies/models/_object_set_search_around_type_dict.py new file mode 100644 index 00000000..68fc4d37 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_search_around_type_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v2.ontologies.models._object_set_dict import ObjectSetDict + + +class ObjectSetSearchAroundTypeDict(TypedDict): + """ObjectSetSearchAroundType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectSet: ObjectSetDict + + link: LinkTypeApiName + + type: Literal["searchAround"] diff --git a/foundry/v2/ontologies/models/_object_set_static_type.py b/foundry/v2/ontologies/models/_object_set_static_type.py new file mode 100644 index 00000000..d74f115d --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_static_type.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._object_rid import ObjectRid +from foundry.v2.ontologies.models._object_set_static_type_dict import ( + ObjectSetStaticTypeDict, +) # NOQA + + +class ObjectSetStaticType(BaseModel): + """ObjectSetStaticType""" + + objects: List[ObjectRid] + + type: Literal["static"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectSetStaticTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ObjectSetStaticTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_object_set_static_type_dict.py b/foundry/v2/ontologies/models/_object_set_static_type_dict.py new file mode 100644 index 00000000..be3af738 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_static_type_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_rid import ObjectRid + + +class ObjectSetStaticTypeDict(TypedDict): + """ObjectSetStaticType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objects: List[ObjectRid] + + type: Literal["static"] diff --git a/foundry/v2/ontologies/models/_object_set_subtract_type.py b/foundry/v2/ontologies/models/_object_set_subtract_type.py new file mode 100644 index 00000000..c378fcfa --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_subtract_type.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._object_set import ObjectSet +from foundry.v2.ontologies.models._object_set_subtract_type_dict import ( + ObjectSetSubtractTypeDict, +) # NOQA + + +class ObjectSetSubtractType(BaseModel): + """ObjectSetSubtractType""" + + object_sets: List[ObjectSet] = Field(alias="objectSets") + + type: Literal["subtract"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectSetSubtractTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ObjectSetSubtractTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_object_set_subtract_type_dict.py b/foundry/v2/ontologies/models/_object_set_subtract_type_dict.py new file mode 100644 index 00000000..b2ac1aae --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_subtract_type_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_set_dict import ObjectSetDict + + +class ObjectSetSubtractTypeDict(TypedDict): + """ObjectSetSubtractType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectSets: List[ObjectSetDict] + + type: Literal["subtract"] diff --git a/foundry/v2/ontologies/models/_object_set_union_type.py b/foundry/v2/ontologies/models/_object_set_union_type.py new file mode 100644 index 00000000..641cd40a --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_union_type.py @@ -0,0 +1,40 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._object_set import ObjectSet +from foundry.v2.ontologies.models._object_set_union_type_dict import ObjectSetUnionTypeDict # NOQA + + +class ObjectSetUnionType(BaseModel): + """ObjectSetUnionType""" + + object_sets: List[ObjectSet] = Field(alias="objectSets") + + type: Literal["union"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectSetUnionTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ObjectSetUnionTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_object_set_union_type_dict.py b/foundry/v2/ontologies/models/_object_set_union_type_dict.py new file mode 100644 index 00000000..6d1f945d --- /dev/null +++ b/foundry/v2/ontologies/models/_object_set_union_type_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_set_dict import ObjectSetDict + + +class ObjectSetUnionTypeDict(TypedDict): + """ObjectSetUnionType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectSets: List[ObjectSetDict] + + type: Literal["union"] diff --git a/foundry/v2/models/_object_type_api_name.py b/foundry/v2/ontologies/models/_object_type_api_name.py similarity index 100% rename from foundry/v2/models/_object_type_api_name.py rename to foundry/v2/ontologies/models/_object_type_api_name.py diff --git a/foundry/v2/ontologies/models/_object_type_edits.py b/foundry/v2/ontologies/models/_object_type_edits.py new file mode 100644 index 00000000..15febe5f --- /dev/null +++ b/foundry/v2/ontologies/models/_object_type_edits.py @@ -0,0 +1,40 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._object_type_edits_dict import ObjectTypeEditsDict + + +class ObjectTypeEdits(BaseModel): + """ObjectTypeEdits""" + + edited_object_types: List[ObjectTypeApiName] = Field(alias="editedObjectTypes") + + type: Literal["largeScaleEdits"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectTypeEditsDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ObjectTypeEditsDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_object_type_edits_dict.py b/foundry/v2/ontologies/models/_object_type_edits_dict.py new file mode 100644 index 00000000..cd6439e6 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_type_edits_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class ObjectTypeEditsDict(TypedDict): + """ObjectTypeEdits""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + editedObjectTypes: List[ObjectTypeApiName] + + type: Literal["largeScaleEdits"] diff --git a/foundry/v2/ontologies/models/_object_type_full_metadata.py b/foundry/v2/ontologies/models/_object_type_full_metadata.py new file mode 100644 index 00000000..9deb5b23 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_type_full_metadata.py @@ -0,0 +1,67 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName +from foundry.v2.ontologies.models._link_type_side_v2 import LinkTypeSideV2 +from foundry.v2.ontologies.models._object_type_full_metadata_dict import ( + ObjectTypeFullMetadataDict, +) # NOQA +from foundry.v2.ontologies.models._object_type_interface_implementation import ( + ObjectTypeInterfaceImplementation, +) # NOQA +from foundry.v2.ontologies.models._object_type_v2 import ObjectTypeV2 +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._shared_property_type_api_name import ( + SharedPropertyTypeApiName, +) # NOQA + + +class ObjectTypeFullMetadata(BaseModel): + """ObjectTypeFullMetadata""" + + object_type: ObjectTypeV2 = Field(alias="objectType") + + link_types: List[LinkTypeSideV2] = Field(alias="linkTypes") + + implements_interfaces: List[InterfaceTypeApiName] = Field(alias="implementsInterfaces") + """A list of interfaces that this object type implements.""" + + implements_interfaces2: Dict[InterfaceTypeApiName, ObjectTypeInterfaceImplementation] = Field( + alias="implementsInterfaces2" + ) + """A list of interfaces that this object type implements and how it implements them.""" + + shared_property_type_mapping: Dict[SharedPropertyTypeApiName, PropertyApiName] = Field( + alias="sharedPropertyTypeMapping" + ) + """ + A map from shared property type API name to backing local property API name for the shared property types + present on this object type. + """ + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectTypeFullMetadataDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ObjectTypeFullMetadataDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_object_type_full_metadata_dict.py b/foundry/v2/ontologies/models/_object_type_full_metadata_dict.py new file mode 100644 index 00000000..e93e86a8 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_type_full_metadata_dict.py @@ -0,0 +1,54 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName +from foundry.v2.ontologies.models._link_type_side_v2_dict import LinkTypeSideV2Dict +from foundry.v2.ontologies.models._object_type_interface_implementation_dict import ( + ObjectTypeInterfaceImplementationDict, +) # NOQA +from foundry.v2.ontologies.models._object_type_v2_dict import ObjectTypeV2Dict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._shared_property_type_api_name import ( + SharedPropertyTypeApiName, +) # NOQA + + +class ObjectTypeFullMetadataDict(TypedDict): + """ObjectTypeFullMetadata""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectType: ObjectTypeV2Dict + + linkTypes: List[LinkTypeSideV2Dict] + + implementsInterfaces: List[InterfaceTypeApiName] + """A list of interfaces that this object type implements.""" + + implementsInterfaces2: Dict[InterfaceTypeApiName, ObjectTypeInterfaceImplementationDict] + """A list of interfaces that this object type implements and how it implements them.""" + + sharedPropertyTypeMapping: Dict[SharedPropertyTypeApiName, PropertyApiName] + """ + A map from shared property type API name to backing local property API name for the shared property types + present on this object type. + """ diff --git a/foundry/v2/ontologies/models/_object_type_interface_implementation.py b/foundry/v2/ontologies/models/_object_type_interface_implementation.py new file mode 100644 index 00000000..cc59b871 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_type_interface_implementation.py @@ -0,0 +1,44 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._object_type_interface_implementation_dict import ( + ObjectTypeInterfaceImplementationDict, +) # NOQA +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._shared_property_type_api_name import ( + SharedPropertyTypeApiName, +) # NOQA + + +class ObjectTypeInterfaceImplementation(BaseModel): + """ObjectTypeInterfaceImplementation""" + + properties: Dict[SharedPropertyTypeApiName, PropertyApiName] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectTypeInterfaceImplementationDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ObjectTypeInterfaceImplementationDict, + self.model_dump(by_alias=True, exclude_unset=True), + ) diff --git a/foundry/v2/ontologies/models/_object_type_interface_implementation_dict.py b/foundry/v2/ontologies/models/_object_type_interface_implementation_dict.py new file mode 100644 index 00000000..2ac8e89f --- /dev/null +++ b/foundry/v2/ontologies/models/_object_type_interface_implementation_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._shared_property_type_api_name import ( + SharedPropertyTypeApiName, +) # NOQA + + +class ObjectTypeInterfaceImplementationDict(TypedDict): + """ObjectTypeInterfaceImplementation""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + properties: Dict[SharedPropertyTypeApiName, PropertyApiName] diff --git a/foundry/v2/models/_object_type_rid.py b/foundry/v2/ontologies/models/_object_type_rid.py similarity index 100% rename from foundry/v2/models/_object_type_rid.py rename to foundry/v2/ontologies/models/_object_type_rid.py diff --git a/foundry/v2/ontologies/models/_object_type_v2.py b/foundry/v2/ontologies/models/_object_type_v2.py new file mode 100644 index 00000000..922d4e90 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_type_v2.py @@ -0,0 +1,69 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.core.models._release_status import ReleaseStatus +from foundry.v2.ontologies.models._icon import Icon +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._object_type_rid import ObjectTypeRid +from foundry.v2.ontologies.models._object_type_v2_dict import ObjectTypeV2Dict +from foundry.v2.ontologies.models._object_type_visibility import ObjectTypeVisibility +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_v2 import PropertyV2 + + +class ObjectTypeV2(BaseModel): + """Represents an object type in the Ontology.""" + + api_name: ObjectTypeApiName = Field(alias="apiName") + + display_name: DisplayName = Field(alias="displayName") + + status: ReleaseStatus + + description: Optional[StrictStr] = None + """The description of the object type.""" + + plural_display_name: StrictStr = Field(alias="pluralDisplayName") + """The plural display name of the object type.""" + + icon: Icon + + primary_key: PropertyApiName = Field(alias="primaryKey") + + properties: Dict[PropertyApiName, PropertyV2] + """A map of the properties of the object type.""" + + rid: ObjectTypeRid + + title_property: PropertyApiName = Field(alias="titleProperty") + + visibility: Optional[ObjectTypeVisibility] = None + + model_config = {"extra": "allow"} + + def to_dict(self) -> ObjectTypeV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ObjectTypeV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_object_type_v2_dict.py b/foundry/v2/ontologies/models/_object_type_v2_dict.py new file mode 100644 index 00000000..d0ec18c0 --- /dev/null +++ b/foundry/v2/ontologies/models/_object_type_v2_dict.py @@ -0,0 +1,62 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.core.models._release_status import ReleaseStatus +from foundry.v2.ontologies.models._icon_dict import IconDict +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._object_type_rid import ObjectTypeRid +from foundry.v2.ontologies.models._object_type_visibility import ObjectTypeVisibility +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_v2_dict import PropertyV2Dict + + +class ObjectTypeV2Dict(TypedDict): + """Represents an object type in the Ontology.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + apiName: ObjectTypeApiName + + displayName: DisplayName + + status: ReleaseStatus + + description: NotRequired[StrictStr] + """The description of the object type.""" + + pluralDisplayName: StrictStr + """The plural display name of the object type.""" + + icon: IconDict + + primaryKey: PropertyApiName + + properties: Dict[PropertyApiName, PropertyV2Dict] + """A map of the properties of the object type.""" + + rid: ObjectTypeRid + + titleProperty: PropertyApiName + + visibility: NotRequired[ObjectTypeVisibility] diff --git a/foundry/v2/models/_object_type_visibility.py b/foundry/v2/ontologies/models/_object_type_visibility.py similarity index 100% rename from foundry/v2/models/_object_type_visibility.py rename to foundry/v2/ontologies/models/_object_type_visibility.py diff --git a/foundry/v2/ontologies/models/_one_of_constraint.py b/foundry/v2/ontologies/models/_one_of_constraint.py new file mode 100644 index 00000000..27aa0573 --- /dev/null +++ b/foundry/v2/ontologies/models/_one_of_constraint.py @@ -0,0 +1,44 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictBool + +from foundry.v2.ontologies.models._one_of_constraint_dict import OneOfConstraintDict +from foundry.v2.ontologies.models._parameter_option import ParameterOption + + +class OneOfConstraint(BaseModel): + """The parameter has a manually predefined set of options.""" + + options: List[ParameterOption] + + other_values_allowed: StrictBool = Field(alias="otherValuesAllowed") + """A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**.""" + + type: Literal["oneOf"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OneOfConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OneOfConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_one_of_constraint_dict.py b/foundry/v2/ontologies/models/_one_of_constraint_dict.py new file mode 100644 index 00000000..1729dfd3 --- /dev/null +++ b/foundry/v2/ontologies/models/_one_of_constraint_dict.py @@ -0,0 +1,37 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from pydantic import StrictBool +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._parameter_option_dict import ParameterOptionDict + + +class OneOfConstraintDict(TypedDict): + """The parameter has a manually predefined set of options.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + options: List[ParameterOptionDict] + + otherValuesAllowed: StrictBool + """A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed "Other" value** toggle in the **Ontology Manager**.""" + + type: Literal["oneOf"] diff --git a/foundry/v2/models/_ontology_api_name.py b/foundry/v2/ontologies/models/_ontology_api_name.py similarity index 100% rename from foundry/v2/models/_ontology_api_name.py rename to foundry/v2/ontologies/models/_ontology_api_name.py diff --git a/foundry/v2/ontologies/models/_ontology_full_metadata.py b/foundry/v2/ontologies/models/_ontology_full_metadata.py new file mode 100644 index 00000000..8573e29b --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_full_metadata.py @@ -0,0 +1,63 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._action_type_api_name import ActionTypeApiName +from foundry.v2.ontologies.models._action_type_v2 import ActionTypeV2 +from foundry.v2.ontologies.models._interface_type import InterfaceType +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._object_type_full_metadata import ObjectTypeFullMetadata # NOQA +from foundry.v2.ontologies.models._ontology_full_metadata_dict import ( + OntologyFullMetadataDict, +) # NOQA +from foundry.v2.ontologies.models._ontology_v2 import OntologyV2 +from foundry.v2.ontologies.models._query_api_name import QueryApiName +from foundry.v2.ontologies.models._query_type_v2 import QueryTypeV2 +from foundry.v2.ontologies.models._shared_property_type import SharedPropertyType +from foundry.v2.ontologies.models._shared_property_type_api_name import ( + SharedPropertyTypeApiName, +) # NOQA + + +class OntologyFullMetadata(BaseModel): + """OntologyFullMetadata""" + + ontology: OntologyV2 + + object_types: Dict[ObjectTypeApiName, ObjectTypeFullMetadata] = Field(alias="objectTypes") + + action_types: Dict[ActionTypeApiName, ActionTypeV2] = Field(alias="actionTypes") + + query_types: Dict[QueryApiName, QueryTypeV2] = Field(alias="queryTypes") + + interface_types: Dict[InterfaceTypeApiName, InterfaceType] = Field(alias="interfaceTypes") + + shared_property_types: Dict[SharedPropertyTypeApiName, SharedPropertyType] = Field( + alias="sharedPropertyTypes" + ) + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyFullMetadataDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyFullMetadataDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_ontology_full_metadata_dict.py b/foundry/v2/ontologies/models/_ontology_full_metadata_dict.py new file mode 100644 index 00000000..03e945cc --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_full_metadata_dict.py @@ -0,0 +1,54 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._action_type_api_name import ActionTypeApiName +from foundry.v2.ontologies.models._action_type_v2_dict import ActionTypeV2Dict +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName +from foundry.v2.ontologies.models._interface_type_dict import InterfaceTypeDict +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._object_type_full_metadata_dict import ( + ObjectTypeFullMetadataDict, +) # NOQA +from foundry.v2.ontologies.models._ontology_v2_dict import OntologyV2Dict +from foundry.v2.ontologies.models._query_api_name import QueryApiName +from foundry.v2.ontologies.models._query_type_v2_dict import QueryTypeV2Dict +from foundry.v2.ontologies.models._shared_property_type_api_name import ( + SharedPropertyTypeApiName, +) # NOQA +from foundry.v2.ontologies.models._shared_property_type_dict import SharedPropertyTypeDict # NOQA + + +class OntologyFullMetadataDict(TypedDict): + """OntologyFullMetadata""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + ontology: OntologyV2Dict + + objectTypes: Dict[ObjectTypeApiName, ObjectTypeFullMetadataDict] + + actionTypes: Dict[ActionTypeApiName, ActionTypeV2Dict] + + queryTypes: Dict[QueryApiName, QueryTypeV2Dict] + + interfaceTypes: Dict[InterfaceTypeApiName, InterfaceTypeDict] + + sharedPropertyTypes: Dict[SharedPropertyTypeApiName, SharedPropertyTypeDict] diff --git a/foundry/v1/models/_ontology_identifier.py b/foundry/v2/ontologies/models/_ontology_identifier.py similarity index 100% rename from foundry/v1/models/_ontology_identifier.py rename to foundry/v2/ontologies/models/_ontology_identifier.py diff --git a/foundry/v2/ontologies/models/_ontology_object_array_type.py b/foundry/v2/ontologies/models/_ontology_object_array_type.py new file mode 100644 index 00000000..a91d720e --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_object_array_type.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._object_property_type import ObjectPropertyType +from foundry.v2.ontologies.models._ontology_object_array_type_dict import ( + OntologyObjectArrayTypeDict, +) # NOQA + + +class OntologyObjectArrayType(BaseModel): + """OntologyObjectArrayType""" + + sub_type: ObjectPropertyType = Field(alias="subType") + + type: Literal["array"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyObjectArrayTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyObjectArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_ontology_object_array_type_dict.py b/foundry/v2/ontologies/models/_ontology_object_array_type_dict.py new file mode 100644 index 00000000..1eb075e1 --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_object_array_type_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_property_type_dict import ObjectPropertyTypeDict # NOQA + + +class OntologyObjectArrayTypeDict(TypedDict): + """OntologyObjectArrayType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + subType: ObjectPropertyTypeDict + + type: Literal["array"] diff --git a/foundry/v2/ontologies/models/_ontology_object_set_type.py b/foundry/v2/ontologies/models/_ontology_object_set_type.py new file mode 100644 index 00000000..646d03ee --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_object_set_type.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._ontology_object_set_type_dict import ( + OntologyObjectSetTypeDict, +) # NOQA + + +class OntologyObjectSetType(BaseModel): + """OntologyObjectSetType""" + + object_api_name: Optional[ObjectTypeApiName] = Field(alias="objectApiName", default=None) + + object_type_api_name: Optional[ObjectTypeApiName] = Field( + alias="objectTypeApiName", default=None + ) + + type: Literal["objectSet"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyObjectSetTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyObjectSetTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_ontology_object_set_type_dict.py b/foundry/v2/ontologies/models/_ontology_object_set_type_dict.py new file mode 100644 index 00000000..5487f711 --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_object_set_type_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class OntologyObjectSetTypeDict(TypedDict): + """OntologyObjectSetType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectApiName: NotRequired[ObjectTypeApiName] + + objectTypeApiName: NotRequired[ObjectTypeApiName] + + type: Literal["objectSet"] diff --git a/foundry/v2/ontologies/models/_ontology_object_type.py b/foundry/v2/ontologies/models/_ontology_object_type.py new file mode 100644 index 00000000..7d3d9195 --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_object_type.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._ontology_object_type_dict import OntologyObjectTypeDict # NOQA + + +class OntologyObjectType(BaseModel): + """OntologyObjectType""" + + object_api_name: ObjectTypeApiName = Field(alias="objectApiName") + + object_type_api_name: ObjectTypeApiName = Field(alias="objectTypeApiName") + + type: Literal["object"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyObjectTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyObjectTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_ontology_object_type_dict.py b/foundry/v2/ontologies/models/_ontology_object_type_dict.py new file mode 100644 index 00000000..a0598f7a --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_object_type_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName + + +class OntologyObjectTypeDict(TypedDict): + """OntologyObjectType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + objectApiName: ObjectTypeApiName + + objectTypeApiName: ObjectTypeApiName + + type: Literal["object"] diff --git a/foundry/v2/ontologies/models/_ontology_object_v2.py b/foundry/v2/ontologies/models/_ontology_object_v2.py new file mode 100644 index 00000000..6a83e70d --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_object_v2.py @@ -0,0 +1,24 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value import PropertyValue + +OntologyObjectV2 = Dict[PropertyApiName, PropertyValue] +"""Represents an object in the Ontology.""" diff --git a/foundry/v2/models/_ontology_rid.py b/foundry/v2/ontologies/models/_ontology_rid.py similarity index 100% rename from foundry/v2/models/_ontology_rid.py rename to foundry/v2/ontologies/models/_ontology_rid.py diff --git a/foundry/v2/ontologies/models/_ontology_v2.py b/foundry/v2/ontologies/models/_ontology_v2.py new file mode 100644 index 00000000..a3e8f9c9 --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_v2.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.ontologies.models._ontology_api_name import OntologyApiName +from foundry.v2.ontologies.models._ontology_rid import OntologyRid +from foundry.v2.ontologies.models._ontology_v2_dict import OntologyV2Dict + + +class OntologyV2(BaseModel): + """Metadata about an Ontology.""" + + api_name: OntologyApiName = Field(alias="apiName") + + display_name: DisplayName = Field(alias="displayName") + + description: StrictStr + + rid: OntologyRid + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OntologyV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_ontology_v2_dict.py b/foundry/v2/ontologies/models/_ontology_v2_dict.py new file mode 100644 index 00000000..d6447bfc --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_v2_dict.py @@ -0,0 +1,37 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr +from typing_extensions import TypedDict + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.ontologies.models._ontology_api_name import OntologyApiName +from foundry.v2.ontologies.models._ontology_rid import OntologyRid + + +class OntologyV2Dict(TypedDict): + """Metadata about an Ontology.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + apiName: OntologyApiName + + displayName: DisplayName + + description: StrictStr + + rid: OntologyRid diff --git a/foundry/v2/ontologies/models/_or_query_v2.py b/foundry/v2/ontologies/models/_or_query_v2.py new file mode 100644 index 00000000..cbc3199a --- /dev/null +++ b/foundry/v2/ontologies/models/_or_query_v2.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._or_query_v2_dict import OrQueryV2Dict +from foundry.v2.ontologies.models._search_json_query_v2 import SearchJsonQueryV2 + + +class OrQueryV2(BaseModel): + """Returns objects where at least 1 query is satisfied.""" + + value: List[SearchJsonQueryV2] + + type: Literal["or"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OrQueryV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OrQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_or_query_v2_dict.py b/foundry/v2/ontologies/models/_or_query_v2_dict.py new file mode 100644 index 00000000..ce1779d5 --- /dev/null +++ b/foundry/v2/ontologies/models/_or_query_v2_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._search_json_query_v2_dict import SearchJsonQueryV2Dict # NOQA + + +class OrQueryV2Dict(TypedDict): + """Returns objects where at least 1 query is satisfied.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: List[SearchJsonQueryV2Dict] + + type: Literal["or"] diff --git a/foundry/v2/models/_order_by.py b/foundry/v2/ontologies/models/_order_by.py similarity index 100% rename from foundry/v2/models/_order_by.py rename to foundry/v2/ontologies/models/_order_by.py diff --git a/foundry/v1/models/_order_by_direction.py b/foundry/v2/ontologies/models/_order_by_direction.py similarity index 100% rename from foundry/v1/models/_order_by_direction.py rename to foundry/v2/ontologies/models/_order_by_direction.py diff --git a/foundry/v2/ontologies/models/_parameter_evaluated_constraint.py b/foundry/v2/ontologies/models/_parameter_evaluated_constraint.py new file mode 100644 index 00000000..e63583c2 --- /dev/null +++ b/foundry/v2/ontologies/models/_parameter_evaluated_constraint.py @@ -0,0 +1,71 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._array_size_constraint import ArraySizeConstraint +from foundry.v2.ontologies.models._group_member_constraint import GroupMemberConstraint +from foundry.v2.ontologies.models._object_property_value_constraint import ( + ObjectPropertyValueConstraint, +) # NOQA +from foundry.v2.ontologies.models._object_query_result_constraint import ( + ObjectQueryResultConstraint, +) # NOQA +from foundry.v2.ontologies.models._one_of_constraint import OneOfConstraint +from foundry.v2.ontologies.models._range_constraint import RangeConstraint +from foundry.v2.ontologies.models._string_length_constraint import StringLengthConstraint # NOQA +from foundry.v2.ontologies.models._string_regex_match_constraint import ( + StringRegexMatchConstraint, +) # NOQA +from foundry.v2.ontologies.models._unevaluable_constraint import UnevaluableConstraint + +ParameterEvaluatedConstraint = Annotated[ + Union[ + OneOfConstraint, + GroupMemberConstraint, + ObjectPropertyValueConstraint, + RangeConstraint, + ArraySizeConstraint, + ObjectQueryResultConstraint, + StringLengthConstraint, + StringRegexMatchConstraint, + UnevaluableConstraint, + ], + Field(discriminator="type"), +] +""" +A constraint that an action parameter value must satisfy in order to be considered valid. +Constraints can be configured on action parameters in the **Ontology Manager**. +Applicable constraints are determined dynamically based on parameter inputs. +Parameter values are evaluated against the final set of constraints. + +The type of the constraint. +| Type | Description | +|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | +| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | +| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | +| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | +| `oneOf` | The parameter has a manually predefined set of options. | +| `range` | The parameter value must be within the defined range. | +| `stringLength` | The parameter value must have a length within the defined range. | +| `stringRegexMatch` | The parameter value must match a predefined regular expression. | +| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | +""" diff --git a/foundry/v2/ontologies/models/_parameter_evaluated_constraint_dict.py b/foundry/v2/ontologies/models/_parameter_evaluated_constraint_dict.py new file mode 100644 index 00000000..475b9895 --- /dev/null +++ b/foundry/v2/ontologies/models/_parameter_evaluated_constraint_dict.py @@ -0,0 +1,77 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._array_size_constraint_dict import ArraySizeConstraintDict # NOQA +from foundry.v2.ontologies.models._group_member_constraint_dict import ( + GroupMemberConstraintDict, +) # NOQA +from foundry.v2.ontologies.models._object_property_value_constraint_dict import ( + ObjectPropertyValueConstraintDict, +) # NOQA +from foundry.v2.ontologies.models._object_query_result_constraint_dict import ( + ObjectQueryResultConstraintDict, +) # NOQA +from foundry.v2.ontologies.models._one_of_constraint_dict import OneOfConstraintDict +from foundry.v2.ontologies.models._range_constraint_dict import RangeConstraintDict +from foundry.v2.ontologies.models._string_length_constraint_dict import ( + StringLengthConstraintDict, +) # NOQA +from foundry.v2.ontologies.models._string_regex_match_constraint_dict import ( + StringRegexMatchConstraintDict, +) # NOQA +from foundry.v2.ontologies.models._unevaluable_constraint_dict import ( + UnevaluableConstraintDict, +) # NOQA + +ParameterEvaluatedConstraintDict = Annotated[ + Union[ + OneOfConstraintDict, + GroupMemberConstraintDict, + ObjectPropertyValueConstraintDict, + RangeConstraintDict, + ArraySizeConstraintDict, + ObjectQueryResultConstraintDict, + StringLengthConstraintDict, + StringRegexMatchConstraintDict, + UnevaluableConstraintDict, + ], + Field(discriminator="type"), +] +""" +A constraint that an action parameter value must satisfy in order to be considered valid. +Constraints can be configured on action parameters in the **Ontology Manager**. +Applicable constraints are determined dynamically based on parameter inputs. +Parameter values are evaluated against the final set of constraints. + +The type of the constraint. +| Type | Description | +|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. | +| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. | +| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. | +| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. | +| `oneOf` | The parameter has a manually predefined set of options. | +| `range` | The parameter value must be within the defined range. | +| `stringLength` | The parameter value must have a length within the defined range. | +| `stringRegexMatch` | The parameter value must match a predefined regular expression. | +| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. | +""" diff --git a/foundry/v2/ontologies/models/_parameter_evaluation_result.py b/foundry/v2/ontologies/models/_parameter_evaluation_result.py new file mode 100644 index 00000000..b282e98d --- /dev/null +++ b/foundry/v2/ontologies/models/_parameter_evaluation_result.py @@ -0,0 +1,50 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictBool + +from foundry.v2.ontologies.models._parameter_evaluated_constraint import ( + ParameterEvaluatedConstraint, +) # NOQA +from foundry.v2.ontologies.models._parameter_evaluation_result_dict import ( + ParameterEvaluationResultDict, +) # NOQA +from foundry.v2.ontologies.models._validation_result import ValidationResult + + +class ParameterEvaluationResult(BaseModel): + """Represents the validity of a parameter against the configured constraints.""" + + result: ValidationResult + + evaluated_constraints: List[ParameterEvaluatedConstraint] = Field(alias="evaluatedConstraints") + + required: StrictBool + """Represents whether the parameter is a required input to the action.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ParameterEvaluationResultDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ParameterEvaluationResultDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_parameter_evaluation_result_dict.py b/foundry/v2/ontologies/models/_parameter_evaluation_result_dict.py new file mode 100644 index 00000000..5f6fc7d1 --- /dev/null +++ b/foundry/v2/ontologies/models/_parameter_evaluation_result_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from pydantic import StrictBool +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._parameter_evaluated_constraint_dict import ( + ParameterEvaluatedConstraintDict, +) # NOQA +from foundry.v2.ontologies.models._validation_result import ValidationResult + + +class ParameterEvaluationResultDict(TypedDict): + """Represents the validity of a parameter against the configured constraints.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + result: ValidationResult + + evaluatedConstraints: List[ParameterEvaluatedConstraintDict] + + required: StrictBool + """Represents whether the parameter is a required input to the action.""" diff --git a/foundry/v2/models/_parameter_id.py b/foundry/v2/ontologies/models/_parameter_id.py similarity index 100% rename from foundry/v2/models/_parameter_id.py rename to foundry/v2/ontologies/models/_parameter_id.py diff --git a/foundry/v2/ontologies/models/_parameter_option.py b/foundry/v2/ontologies/models/_parameter_option.py new file mode 100644 index 00000000..f562215e --- /dev/null +++ b/foundry/v2/ontologies/models/_parameter_option.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.ontologies.models._parameter_option_dict import ParameterOptionDict + + +class ParameterOption(BaseModel): + """A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.""" + + display_name: Optional[DisplayName] = Field(alias="displayName", default=None) + + value: Optional[Any] = None + """An allowed configured value for a parameter within an action.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ParameterOptionDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ParameterOptionDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_parameter_option_dict.py b/foundry/v2/ontologies/models/_parameter_option_dict.py new file mode 100644 index 00000000..c9a2b90e --- /dev/null +++ b/foundry/v2/ontologies/models/_parameter_option_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._display_name import DisplayName + + +class ParameterOptionDict(TypedDict): + """A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + displayName: NotRequired[DisplayName] + + value: NotRequired[Any] + """An allowed configured value for a parameter within an action.""" diff --git a/foundry/v2/ontologies/models/_polygon_value.py b/foundry/v2/ontologies/models/_polygon_value.py new file mode 100644 index 00000000..c5b722f4 --- /dev/null +++ b/foundry/v2/ontologies/models/_polygon_value.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry.v2.geo.models._polygon import Polygon + +PolygonValue = Polygon +"""PolygonValue""" diff --git a/foundry/v2/ontologies/models/_polygon_value_dict.py b/foundry/v2/ontologies/models/_polygon_value_dict.py new file mode 100644 index 00000000..6cb557a0 --- /dev/null +++ b/foundry/v2/ontologies/models/_polygon_value_dict.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry.v2.geo.models._polygon_dict import PolygonDict + +PolygonValueDict = PolygonDict +"""PolygonValue""" diff --git a/foundry/v2/models/_property_api_name.py b/foundry/v2/ontologies/models/_property_api_name.py similarity index 100% rename from foundry/v2/models/_property_api_name.py rename to foundry/v2/ontologies/models/_property_api_name.py diff --git a/foundry/v2/ontologies/models/_property_v2.py b/foundry/v2/ontologies/models/_property_v2.py new file mode 100644 index 00000000..bdf8034c --- /dev/null +++ b/foundry/v2/ontologies/models/_property_v2.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.ontologies.models._object_property_type import ObjectPropertyType +from foundry.v2.ontologies.models._property_v2_dict import PropertyV2Dict + + +class PropertyV2(BaseModel): + """Details about some property of an object.""" + + description: Optional[StrictStr] = None + + display_name: Optional[DisplayName] = Field(alias="displayName", default=None) + + data_type: ObjectPropertyType = Field(alias="dataType") + + model_config = {"extra": "allow"} + + def to_dict(self) -> PropertyV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(PropertyV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_property_v2_dict.py b/foundry/v2/ontologies/models/_property_v2_dict.py new file mode 100644 index 00000000..3d62a204 --- /dev/null +++ b/foundry/v2/ontologies/models/_property_v2_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.ontologies.models._object_property_type_dict import ObjectPropertyTypeDict # NOQA + + +class PropertyV2Dict(TypedDict): + """Details about some property of an object.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + description: NotRequired[StrictStr] + + displayName: NotRequired[DisplayName] + + dataType: ObjectPropertyTypeDict diff --git a/foundry/v2/models/_property_value.py b/foundry/v2/ontologies/models/_property_value.py similarity index 100% rename from foundry/v2/models/_property_value.py rename to foundry/v2/ontologies/models/_property_value.py diff --git a/foundry/v2/models/_property_value_escaped_string.py b/foundry/v2/ontologies/models/_property_value_escaped_string.py similarity index 100% rename from foundry/v2/models/_property_value_escaped_string.py rename to foundry/v2/ontologies/models/_property_value_escaped_string.py diff --git a/foundry/v2/ontologies/models/_query_aggregation_key_type.py b/foundry/v2/ontologies/models/_query_aggregation_key_type.py new file mode 100644 index 00000000..69591aef --- /dev/null +++ b/foundry/v2/ontologies/models/_query_aggregation_key_type.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.core.models._boolean_type import BooleanType +from foundry.v2.core.models._date_type import DateType +from foundry.v2.core.models._double_type import DoubleType +from foundry.v2.core.models._integer_type import IntegerType +from foundry.v2.core.models._string_type import StringType +from foundry.v2.core.models._timestamp_type import TimestampType +from foundry.v2.ontologies.models._query_aggregation_range_type import ( + QueryAggregationRangeType, +) # NOQA + +QueryAggregationKeyType = Annotated[ + Union[ + DateType, + BooleanType, + StringType, + DoubleType, + QueryAggregationRangeType, + IntegerType, + TimestampType, + ], + Field(discriminator="type"), +] +"""A union of all the types supported by query aggregation keys.""" diff --git a/foundry/v2/ontologies/models/_query_aggregation_key_type_dict.py b/foundry/v2/ontologies/models/_query_aggregation_key_type_dict.py new file mode 100644 index 00000000..13c767ee --- /dev/null +++ b/foundry/v2/ontologies/models/_query_aggregation_key_type_dict.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.core.models._boolean_type_dict import BooleanTypeDict +from foundry.v2.core.models._date_type_dict import DateTypeDict +from foundry.v2.core.models._double_type_dict import DoubleTypeDict +from foundry.v2.core.models._integer_type_dict import IntegerTypeDict +from foundry.v2.core.models._string_type_dict import StringTypeDict +from foundry.v2.core.models._timestamp_type_dict import TimestampTypeDict +from foundry.v2.ontologies.models._query_aggregation_range_type_dict import ( + QueryAggregationRangeTypeDict, +) # NOQA + +QueryAggregationKeyTypeDict = Annotated[ + Union[ + DateTypeDict, + BooleanTypeDict, + StringTypeDict, + DoubleTypeDict, + QueryAggregationRangeTypeDict, + IntegerTypeDict, + TimestampTypeDict, + ], + Field(discriminator="type"), +] +"""A union of all the types supported by query aggregation keys.""" diff --git a/foundry/v2/ontologies/models/_query_aggregation_range_sub_type.py b/foundry/v2/ontologies/models/_query_aggregation_range_sub_type.py new file mode 100644 index 00000000..4a4f1f5a --- /dev/null +++ b/foundry/v2/ontologies/models/_query_aggregation_range_sub_type.py @@ -0,0 +1,31 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.core.models._date_type import DateType +from foundry.v2.core.models._double_type import DoubleType +from foundry.v2.core.models._integer_type import IntegerType +from foundry.v2.core.models._timestamp_type import TimestampType + +QueryAggregationRangeSubType = Annotated[ + Union[DateType, DoubleType, IntegerType, TimestampType], Field(discriminator="type") +] +"""A union of all the types supported by query aggregation ranges.""" diff --git a/foundry/v2/ontologies/models/_query_aggregation_range_sub_type_dict.py b/foundry/v2/ontologies/models/_query_aggregation_range_sub_type_dict.py new file mode 100644 index 00000000..fa1a8d99 --- /dev/null +++ b/foundry/v2/ontologies/models/_query_aggregation_range_sub_type_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.core.models._date_type_dict import DateTypeDict +from foundry.v2.core.models._double_type_dict import DoubleTypeDict +from foundry.v2.core.models._integer_type_dict import IntegerTypeDict +from foundry.v2.core.models._timestamp_type_dict import TimestampTypeDict + +QueryAggregationRangeSubTypeDict = Annotated[ + Union[DateTypeDict, DoubleTypeDict, IntegerTypeDict, TimestampTypeDict], + Field(discriminator="type"), +] +"""A union of all the types supported by query aggregation ranges.""" diff --git a/foundry/v2/ontologies/models/_query_aggregation_range_type.py b/foundry/v2/ontologies/models/_query_aggregation_range_type.py new file mode 100644 index 00000000..f9e3baac --- /dev/null +++ b/foundry/v2/ontologies/models/_query_aggregation_range_type.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._query_aggregation_range_sub_type import ( + QueryAggregationRangeSubType, +) # NOQA +from foundry.v2.ontologies.models._query_aggregation_range_type_dict import ( + QueryAggregationRangeTypeDict, +) # NOQA + + +class QueryAggregationRangeType(BaseModel): + """QueryAggregationRangeType""" + + sub_type: QueryAggregationRangeSubType = Field(alias="subType") + + type: Literal["range"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> QueryAggregationRangeTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + QueryAggregationRangeTypeDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_query_aggregation_range_type_dict.py b/foundry/v2/ontologies/models/_query_aggregation_range_type_dict.py new file mode 100644 index 00000000..70221d17 --- /dev/null +++ b/foundry/v2/ontologies/models/_query_aggregation_range_type_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._query_aggregation_range_sub_type_dict import ( + QueryAggregationRangeSubTypeDict, +) # NOQA + + +class QueryAggregationRangeTypeDict(TypedDict): + """QueryAggregationRangeType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + subType: QueryAggregationRangeSubTypeDict + + type: Literal["range"] diff --git a/foundry/v2/ontologies/models/_query_aggregation_value_type.py b/foundry/v2/ontologies/models/_query_aggregation_value_type.py new file mode 100644 index 00000000..61592d35 --- /dev/null +++ b/foundry/v2/ontologies/models/_query_aggregation_value_type.py @@ -0,0 +1,30 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.core.models._date_type import DateType +from foundry.v2.core.models._double_type import DoubleType +from foundry.v2.core.models._timestamp_type import TimestampType + +QueryAggregationValueType = Annotated[ + Union[DateType, DoubleType, TimestampType], Field(discriminator="type") +] +"""A union of all the types supported by query aggregation keys.""" diff --git a/foundry/v2/ontologies/models/_query_aggregation_value_type_dict.py b/foundry/v2/ontologies/models/_query_aggregation_value_type_dict.py new file mode 100644 index 00000000..30517d25 --- /dev/null +++ b/foundry/v2/ontologies/models/_query_aggregation_value_type_dict.py @@ -0,0 +1,30 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.core.models._date_type_dict import DateTypeDict +from foundry.v2.core.models._double_type_dict import DoubleTypeDict +from foundry.v2.core.models._timestamp_type_dict import TimestampTypeDict + +QueryAggregationValueTypeDict = Annotated[ + Union[DateTypeDict, DoubleTypeDict, TimestampTypeDict], Field(discriminator="type") +] +"""A union of all the types supported by query aggregation keys.""" diff --git a/foundry/v2/models/_query_api_name.py b/foundry/v2/ontologies/models/_query_api_name.py similarity index 100% rename from foundry/v2/models/_query_api_name.py rename to foundry/v2/ontologies/models/_query_api_name.py diff --git a/foundry/v2/ontologies/models/_query_array_type.py b/foundry/v2/ontologies/models/_query_array_type.py new file mode 100644 index 00000000..afa3dd98 --- /dev/null +++ b/foundry/v2/ontologies/models/_query_array_type.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._query_array_type_dict import QueryArrayTypeDict +from foundry.v2.ontologies.models._query_data_type import QueryDataType + + +class QueryArrayType(BaseModel): + """QueryArrayType""" + + sub_type: QueryDataType = Field(alias="subType") + + type: Literal["array"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> QueryArrayTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(QueryArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_query_array_type_dict.py b/foundry/v2/ontologies/models/_query_array_type_dict.py new file mode 100644 index 00000000..6abb127a --- /dev/null +++ b/foundry/v2/ontologies/models/_query_array_type_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._query_data_type_dict import QueryDataTypeDict + + +class QueryArrayTypeDict(TypedDict): + """QueryArrayType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + subType: QueryDataTypeDict + + type: Literal["array"] diff --git a/foundry/v2/ontologies/models/_query_data_type.py b/foundry/v2/ontologies/models/_query_data_type.py new file mode 100644 index 00000000..44bdcbf8 --- /dev/null +++ b/foundry/v2/ontologies/models/_query_data_type.py @@ -0,0 +1,148 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import Union +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.core.models._attachment_type import AttachmentType +from foundry.v2.core.models._boolean_type import BooleanType +from foundry.v2.core.models._date_type import DateType +from foundry.v2.core.models._double_type import DoubleType +from foundry.v2.core.models._float_type import FloatType +from foundry.v2.core.models._integer_type import IntegerType +from foundry.v2.core.models._long_type import LongType +from foundry.v2.core.models._null_type import NullType +from foundry.v2.core.models._string_type import StringType +from foundry.v2.core.models._struct_field_name import StructFieldName +from foundry.v2.core.models._timestamp_type import TimestampType +from foundry.v2.core.models._unsupported_type import UnsupportedType +from foundry.v2.ontologies.models._ontology_object_set_type import OntologyObjectSetType +from foundry.v2.ontologies.models._ontology_object_type import OntologyObjectType +from foundry.v2.ontologies.models._query_array_type_dict import QueryArrayTypeDict +from foundry.v2.ontologies.models._query_set_type_dict import QuerySetTypeDict +from foundry.v2.ontologies.models._query_struct_field_dict import QueryStructFieldDict +from foundry.v2.ontologies.models._query_struct_type_dict import QueryStructTypeDict +from foundry.v2.ontologies.models._query_union_type_dict import QueryUnionTypeDict +from foundry.v2.ontologies.models._three_dimensional_aggregation import ( + ThreeDimensionalAggregation, +) # NOQA +from foundry.v2.ontologies.models._two_dimensional_aggregation import ( + TwoDimensionalAggregation, +) # NOQA + + +class QueryStructField(BaseModel): + """QueryStructField""" + + name: StructFieldName + + field_type: QueryDataType = Field(alias="fieldType") + + model_config = {"extra": "allow"} + + def to_dict(self) -> QueryStructFieldDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(QueryStructFieldDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +class QueryStructType(BaseModel): + """QueryStructType""" + + fields: List[QueryStructField] + + type: Literal["struct"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> QueryStructTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(QueryStructTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +class QuerySetType(BaseModel): + """QuerySetType""" + + sub_type: QueryDataType = Field(alias="subType") + + type: Literal["set"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> QuerySetTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(QuerySetTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +class QueryUnionType(BaseModel): + """QueryUnionType""" + + union_types: List[QueryDataType] = Field(alias="unionTypes") + + type: Literal["union"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> QueryUnionTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(QueryUnionTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +class QueryArrayType(BaseModel): + """QueryArrayType""" + + sub_type: QueryDataType = Field(alias="subType") + + type: Literal["array"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> QueryArrayTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(QueryArrayTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +QueryDataType = Annotated[ + Union[ + DateType, + QueryStructType, + QuerySetType, + StringType, + DoubleType, + IntegerType, + ThreeDimensionalAggregation, + QueryUnionType, + FloatType, + LongType, + BooleanType, + UnsupportedType, + AttachmentType, + NullType, + QueryArrayType, + OntologyObjectSetType, + TwoDimensionalAggregation, + OntologyObjectType, + TimestampType, + ], + Field(discriminator="type"), +] +"""A union of all the types supported by Ontology Query parameters or outputs.""" diff --git a/foundry/v2/ontologies/models/_query_data_type_dict.py b/foundry/v2/ontologies/models/_query_data_type_dict.py new file mode 100644 index 00000000..7273b7f4 --- /dev/null +++ b/foundry/v2/ontologies/models/_query_data_type_dict.py @@ -0,0 +1,124 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry.v2.core.models._attachment_type_dict import AttachmentTypeDict +from foundry.v2.core.models._boolean_type_dict import BooleanTypeDict +from foundry.v2.core.models._date_type_dict import DateTypeDict +from foundry.v2.core.models._double_type_dict import DoubleTypeDict +from foundry.v2.core.models._float_type_dict import FloatTypeDict +from foundry.v2.core.models._integer_type_dict import IntegerTypeDict +from foundry.v2.core.models._long_type_dict import LongTypeDict +from foundry.v2.core.models._null_type_dict import NullTypeDict +from foundry.v2.core.models._string_type_dict import StringTypeDict +from foundry.v2.core.models._struct_field_name import StructFieldName +from foundry.v2.core.models._timestamp_type_dict import TimestampTypeDict +from foundry.v2.core.models._unsupported_type_dict import UnsupportedTypeDict +from foundry.v2.ontologies.models._ontology_object_set_type_dict import ( + OntologyObjectSetTypeDict, +) # NOQA +from foundry.v2.ontologies.models._ontology_object_type_dict import OntologyObjectTypeDict # NOQA +from foundry.v2.ontologies.models._three_dimensional_aggregation_dict import ( + ThreeDimensionalAggregationDict, +) # NOQA +from foundry.v2.ontologies.models._two_dimensional_aggregation_dict import ( + TwoDimensionalAggregationDict, +) # NOQA + + +class QueryStructFieldDict(TypedDict): + """QueryStructField""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + name: StructFieldName + + fieldType: QueryDataTypeDict + + +class QueryStructTypeDict(TypedDict): + """QueryStructType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + fields: List[QueryStructFieldDict] + + type: Literal["struct"] + + +class QuerySetTypeDict(TypedDict): + """QuerySetType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + subType: QueryDataTypeDict + + type: Literal["set"] + + +class QueryUnionTypeDict(TypedDict): + """QueryUnionType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + unionTypes: List[QueryDataTypeDict] + + type: Literal["union"] + + +class QueryArrayTypeDict(TypedDict): + """QueryArrayType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + subType: QueryDataTypeDict + + type: Literal["array"] + + +QueryDataTypeDict = Annotated[ + Union[ + DateTypeDict, + QueryStructTypeDict, + QuerySetTypeDict, + StringTypeDict, + DoubleTypeDict, + IntegerTypeDict, + ThreeDimensionalAggregationDict, + QueryUnionTypeDict, + FloatTypeDict, + LongTypeDict, + BooleanTypeDict, + UnsupportedTypeDict, + AttachmentTypeDict, + NullTypeDict, + QueryArrayTypeDict, + OntologyObjectSetTypeDict, + TwoDimensionalAggregationDict, + OntologyObjectTypeDict, + TimestampTypeDict, + ], + Field(discriminator="type"), +] +"""A union of all the types supported by Ontology Query parameters or outputs.""" diff --git a/foundry/v2/ontologies/models/_query_parameter_v2.py b/foundry/v2/ontologies/models/_query_parameter_v2.py new file mode 100644 index 00000000..22c6fd0c --- /dev/null +++ b/foundry/v2/ontologies/models/_query_parameter_v2.py @@ -0,0 +1,40 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.ontologies.models._query_data_type import QueryDataType +from foundry.v2.ontologies.models._query_parameter_v2_dict import QueryParameterV2Dict + + +class QueryParameterV2(BaseModel): + """Details about a parameter of a query.""" + + description: Optional[StrictStr] = None + + data_type: QueryDataType = Field(alias="dataType") + + model_config = {"extra": "allow"} + + def to_dict(self) -> QueryParameterV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(QueryParameterV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_query_parameter_v2_dict.py b/foundry/v2/ontologies/models/_query_parameter_v2_dict.py new file mode 100644 index 00000000..f08e34e0 --- /dev/null +++ b/foundry/v2/ontologies/models/_query_parameter_v2_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._query_data_type_dict import QueryDataTypeDict + + +class QueryParameterV2Dict(TypedDict): + """Details about a parameter of a query.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + description: NotRequired[StrictStr] + + dataType: QueryDataTypeDict diff --git a/foundry/v2/ontologies/models/_query_set_type.py b/foundry/v2/ontologies/models/_query_set_type.py new file mode 100644 index 00000000..2b728481 --- /dev/null +++ b/foundry/v2/ontologies/models/_query_set_type.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._query_data_type import QueryDataType +from foundry.v2.ontologies.models._query_set_type_dict import QuerySetTypeDict + + +class QuerySetType(BaseModel): + """QuerySetType""" + + sub_type: QueryDataType = Field(alias="subType") + + type: Literal["set"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> QuerySetTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(QuerySetTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_query_set_type_dict.py b/foundry/v2/ontologies/models/_query_set_type_dict.py new file mode 100644 index 00000000..3c24e962 --- /dev/null +++ b/foundry/v2/ontologies/models/_query_set_type_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._query_data_type_dict import QueryDataTypeDict + + +class QuerySetTypeDict(TypedDict): + """QuerySetType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + subType: QueryDataTypeDict + + type: Literal["set"] diff --git a/foundry/v2/ontologies/models/_query_struct_field.py b/foundry/v2/ontologies/models/_query_struct_field.py new file mode 100644 index 00000000..965f2f2d --- /dev/null +++ b/foundry/v2/ontologies/models/_query_struct_field.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._struct_field_name import StructFieldName +from foundry.v2.ontologies.models._query_data_type import QueryDataType +from foundry.v2.ontologies.models._query_struct_field_dict import QueryStructFieldDict + + +class QueryStructField(BaseModel): + """QueryStructField""" + + name: StructFieldName + + field_type: QueryDataType = Field(alias="fieldType") + + model_config = {"extra": "allow"} + + def to_dict(self) -> QueryStructFieldDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(QueryStructFieldDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_query_struct_field_dict.py b/foundry/v2/ontologies/models/_query_struct_field_dict.py new file mode 100644 index 00000000..c2ed88d2 --- /dev/null +++ b/foundry/v2/ontologies/models/_query_struct_field_dict.py @@ -0,0 +1,31 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import TypedDict + +from foundry.v2.core.models._struct_field_name import StructFieldName +from foundry.v2.ontologies.models._query_data_type_dict import QueryDataTypeDict + + +class QueryStructFieldDict(TypedDict): + """QueryStructField""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + name: StructFieldName + + fieldType: QueryDataTypeDict diff --git a/foundry/v2/ontologies/models/_query_struct_type.py b/foundry/v2/ontologies/models/_query_struct_type.py new file mode 100644 index 00000000..0e85381a --- /dev/null +++ b/foundry/v2/ontologies/models/_query_struct_type.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._query_struct_field import QueryStructField +from foundry.v2.ontologies.models._query_struct_type_dict import QueryStructTypeDict + + +class QueryStructType(BaseModel): + """QueryStructType""" + + fields: List[QueryStructField] + + type: Literal["struct"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> QueryStructTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(QueryStructTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_query_struct_type_dict.py b/foundry/v2/ontologies/models/_query_struct_type_dict.py new file mode 100644 index 00000000..0bea2eb4 --- /dev/null +++ b/foundry/v2/ontologies/models/_query_struct_type_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._query_struct_field_dict import QueryStructFieldDict + + +class QueryStructTypeDict(TypedDict): + """QueryStructType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + fields: List[QueryStructFieldDict] + + type: Literal["struct"] diff --git a/foundry/v2/ontologies/models/_query_type_v2.py b/foundry/v2/ontologies/models/_query_type_v2.py new file mode 100644 index 00000000..960f6dc8 --- /dev/null +++ b/foundry/v2/ontologies/models/_query_type_v2.py @@ -0,0 +1,57 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.ontologies.models._function_rid import FunctionRid +from foundry.v2.ontologies.models._function_version import FunctionVersion +from foundry.v2.ontologies.models._parameter_id import ParameterId +from foundry.v2.ontologies.models._query_api_name import QueryApiName +from foundry.v2.ontologies.models._query_data_type import QueryDataType +from foundry.v2.ontologies.models._query_parameter_v2 import QueryParameterV2 +from foundry.v2.ontologies.models._query_type_v2_dict import QueryTypeV2Dict + + +class QueryTypeV2(BaseModel): + """Represents a query type in the Ontology.""" + + api_name: QueryApiName = Field(alias="apiName") + + description: Optional[StrictStr] = None + + display_name: Optional[DisplayName] = Field(alias="displayName", default=None) + + parameters: Dict[ParameterId, QueryParameterV2] + + output: QueryDataType + + rid: FunctionRid + + version: FunctionVersion + + model_config = {"extra": "allow"} + + def to_dict(self) -> QueryTypeV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(QueryTypeV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_query_type_v2_dict.py b/foundry/v2/ontologies/models/_query_type_v2_dict.py new file mode 100644 index 00000000..8c946152 --- /dev/null +++ b/foundry/v2/ontologies/models/_query_type_v2_dict.py @@ -0,0 +1,50 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.ontologies.models._function_rid import FunctionRid +from foundry.v2.ontologies.models._function_version import FunctionVersion +from foundry.v2.ontologies.models._parameter_id import ParameterId +from foundry.v2.ontologies.models._query_api_name import QueryApiName +from foundry.v2.ontologies.models._query_data_type_dict import QueryDataTypeDict +from foundry.v2.ontologies.models._query_parameter_v2_dict import QueryParameterV2Dict + + +class QueryTypeV2Dict(TypedDict): + """Represents a query type in the Ontology.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + apiName: QueryApiName + + description: NotRequired[StrictStr] + + displayName: NotRequired[DisplayName] + + parameters: Dict[ParameterId, QueryParameterV2Dict] + + output: QueryDataTypeDict + + rid: FunctionRid + + version: FunctionVersion diff --git a/foundry/v2/ontologies/models/_query_union_type.py b/foundry/v2/ontologies/models/_query_union_type.py new file mode 100644 index 00000000..707de5de --- /dev/null +++ b/foundry/v2/ontologies/models/_query_union_type.py @@ -0,0 +1,40 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._query_data_type import QueryDataType +from foundry.v2.ontologies.models._query_union_type_dict import QueryUnionTypeDict + + +class QueryUnionType(BaseModel): + """QueryUnionType""" + + union_types: List[QueryDataType] = Field(alias="unionTypes") + + type: Literal["union"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> QueryUnionTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(QueryUnionTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_query_union_type_dict.py b/foundry/v2/ontologies/models/_query_union_type_dict.py new file mode 100644 index 00000000..2d8e1c2b --- /dev/null +++ b/foundry/v2/ontologies/models/_query_union_type_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._query_data_type_dict import QueryDataTypeDict + + +class QueryUnionTypeDict(TypedDict): + """QueryUnionType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + unionTypes: List[QueryDataTypeDict] + + type: Literal["union"] diff --git a/foundry/v2/ontologies/models/_range_constraint.py b/foundry/v2/ontologies/models/_range_constraint.py new file mode 100644 index 00000000..e3527f5b --- /dev/null +++ b/foundry/v2/ontologies/models/_range_constraint.py @@ -0,0 +1,49 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._range_constraint_dict import RangeConstraintDict + + +class RangeConstraint(BaseModel): + """The parameter value must be within the defined range.""" + + lt: Optional[Any] = None + """Less than""" + + lte: Optional[Any] = None + """Less than or equal""" + + gt: Optional[Any] = None + """Greater than""" + + gte: Optional[Any] = None + """Greater than or equal""" + + type: Literal["range"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> RangeConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(RangeConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_range_constraint_dict.py b/foundry/v2/ontologies/models/_range_constraint_dict.py similarity index 100% rename from foundry/v2/models/_range_constraint_dict.py rename to foundry/v2/ontologies/models/_range_constraint_dict.py diff --git a/foundry/v2/ontologies/models/_relative_time_dict.py b/foundry/v2/ontologies/models/_relative_time_dict.py new file mode 100644 index 00000000..ece85ce7 --- /dev/null +++ b/foundry/v2/ontologies/models/_relative_time_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictInt +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._relative_time_relation import RelativeTimeRelation +from foundry.v2.ontologies.models._relative_time_series_time_unit import ( + RelativeTimeSeriesTimeUnit, +) # NOQA + + +class RelativeTimeDict(TypedDict): + """A relative time, such as "3 days before" or "2 hours after" the current moment.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + when: RelativeTimeRelation + + value: StrictInt + + unit: RelativeTimeSeriesTimeUnit diff --git a/foundry/v2/ontologies/models/_relative_time_range_dict.py b/foundry/v2/ontologies/models/_relative_time_range_dict.py new file mode 100644 index 00000000..bed3996e --- /dev/null +++ b/foundry/v2/ontologies/models/_relative_time_range_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._relative_time_dict import RelativeTimeDict + + +class RelativeTimeRangeDict(TypedDict): + """A relative time range for a time series query.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + startTime: NotRequired[RelativeTimeDict] + + endTime: NotRequired[RelativeTimeDict] + + type: Literal["relative"] diff --git a/foundry/v1/models/_relative_time_relation.py b/foundry/v2/ontologies/models/_relative_time_relation.py similarity index 100% rename from foundry/v1/models/_relative_time_relation.py rename to foundry/v2/ontologies/models/_relative_time_relation.py diff --git a/foundry/v1/models/_relative_time_series_time_unit.py b/foundry/v2/ontologies/models/_relative_time_series_time_unit.py similarity index 100% rename from foundry/v1/models/_relative_time_series_time_unit.py rename to foundry/v2/ontologies/models/_relative_time_series_time_unit.py diff --git a/foundry/v1/models/_return_edits_mode.py b/foundry/v2/ontologies/models/_return_edits_mode.py similarity index 100% rename from foundry/v1/models/_return_edits_mode.py rename to foundry/v2/ontologies/models/_return_edits_mode.py diff --git a/foundry/v1/models/_sdk_package_name.py b/foundry/v2/ontologies/models/_sdk_package_name.py similarity index 100% rename from foundry/v1/models/_sdk_package_name.py rename to foundry/v2/ontologies/models/_sdk_package_name.py diff --git a/foundry/v2/ontologies/models/_search_json_query_v2.py b/foundry/v2/ontologies/models/_search_json_query_v2.py new file mode 100644 index 00000000..f4afa344 --- /dev/null +++ b/foundry/v2/ontologies/models/_search_json_query_v2.py @@ -0,0 +1,130 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import Union +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._and_query_v2_dict import AndQueryV2Dict +from foundry.v2.ontologies.models._contains_all_terms_in_order_prefix_last_term import ( + ContainsAllTermsInOrderPrefixLastTerm, +) # NOQA +from foundry.v2.ontologies.models._contains_all_terms_in_order_query import ( + ContainsAllTermsInOrderQuery, +) # NOQA +from foundry.v2.ontologies.models._contains_all_terms_query import ContainsAllTermsQuery +from foundry.v2.ontologies.models._contains_any_term_query import ContainsAnyTermQuery +from foundry.v2.ontologies.models._contains_query_v2 import ContainsQueryV2 +from foundry.v2.ontologies.models._does_not_intersect_bounding_box_query import ( + DoesNotIntersectBoundingBoxQuery, +) # NOQA +from foundry.v2.ontologies.models._does_not_intersect_polygon_query import ( + DoesNotIntersectPolygonQuery, +) # NOQA +from foundry.v2.ontologies.models._equals_query_v2 import EqualsQueryV2 +from foundry.v2.ontologies.models._gt_query_v2 import GtQueryV2 +from foundry.v2.ontologies.models._gte_query_v2 import GteQueryV2 +from foundry.v2.ontologies.models._intersects_bounding_box_query import ( + IntersectsBoundingBoxQuery, +) # NOQA +from foundry.v2.ontologies.models._intersects_polygon_query import IntersectsPolygonQuery # NOQA +from foundry.v2.ontologies.models._is_null_query_v2 import IsNullQueryV2 +from foundry.v2.ontologies.models._lt_query_v2 import LtQueryV2 +from foundry.v2.ontologies.models._lte_query_v2 import LteQueryV2 +from foundry.v2.ontologies.models._not_query_v2_dict import NotQueryV2Dict +from foundry.v2.ontologies.models._or_query_v2_dict import OrQueryV2Dict +from foundry.v2.ontologies.models._starts_with_query import StartsWithQuery +from foundry.v2.ontologies.models._within_bounding_box_query import WithinBoundingBoxQuery # NOQA +from foundry.v2.ontologies.models._within_distance_of_query import WithinDistanceOfQuery +from foundry.v2.ontologies.models._within_polygon_query import WithinPolygonQuery + + +class OrQueryV2(BaseModel): + """Returns objects where at least 1 query is satisfied.""" + + value: List[SearchJsonQueryV2] + + type: Literal["or"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OrQueryV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OrQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) + + +class NotQueryV2(BaseModel): + """Returns objects where the query is not satisfied.""" + + value: SearchJsonQueryV2 + + type: Literal["not"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> NotQueryV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(NotQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) + + +class AndQueryV2(BaseModel): + """Returns objects where every query is satisfied.""" + + value: List[SearchJsonQueryV2] + + type: Literal["and"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> AndQueryV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(AndQueryV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) + + +SearchJsonQueryV2 = Annotated[ + Union[ + OrQueryV2, + DoesNotIntersectPolygonQuery, + LtQueryV2, + DoesNotIntersectBoundingBoxQuery, + EqualsQueryV2, + ContainsAllTermsQuery, + GtQueryV2, + WithinDistanceOfQuery, + WithinBoundingBoxQuery, + ContainsQueryV2, + NotQueryV2, + IntersectsBoundingBoxQuery, + AndQueryV2, + IsNullQueryV2, + ContainsAllTermsInOrderPrefixLastTerm, + ContainsAnyTermQuery, + GteQueryV2, + ContainsAllTermsInOrderQuery, + WithinPolygonQuery, + IntersectsPolygonQuery, + LteQueryV2, + StartsWithQuery, + ], + Field(discriminator="type"), +] +"""SearchJsonQueryV2""" diff --git a/foundry/v2/ontologies/models/_search_json_query_v2_dict.py b/foundry/v2/ontologies/models/_search_json_query_v2_dict.py new file mode 100644 index 00000000..0c3b86ba --- /dev/null +++ b/foundry/v2/ontologies/models/_search_json_query_v2_dict.py @@ -0,0 +1,124 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._contains_all_terms_in_order_prefix_last_term_dict import ( + ContainsAllTermsInOrderPrefixLastTermDict, +) # NOQA +from foundry.v2.ontologies.models._contains_all_terms_in_order_query_dict import ( + ContainsAllTermsInOrderQueryDict, +) # NOQA +from foundry.v2.ontologies.models._contains_all_terms_query_dict import ( + ContainsAllTermsQueryDict, +) # NOQA +from foundry.v2.ontologies.models._contains_any_term_query_dict import ( + ContainsAnyTermQueryDict, +) # NOQA +from foundry.v2.ontologies.models._contains_query_v2_dict import ContainsQueryV2Dict +from foundry.v2.ontologies.models._does_not_intersect_bounding_box_query_dict import ( + DoesNotIntersectBoundingBoxQueryDict, +) # NOQA +from foundry.v2.ontologies.models._does_not_intersect_polygon_query_dict import ( + DoesNotIntersectPolygonQueryDict, +) # NOQA +from foundry.v2.ontologies.models._equals_query_v2_dict import EqualsQueryV2Dict +from foundry.v2.ontologies.models._gt_query_v2_dict import GtQueryV2Dict +from foundry.v2.ontologies.models._gte_query_v2_dict import GteQueryV2Dict +from foundry.v2.ontologies.models._intersects_bounding_box_query_dict import ( + IntersectsBoundingBoxQueryDict, +) # NOQA +from foundry.v2.ontologies.models._intersects_polygon_query_dict import ( + IntersectsPolygonQueryDict, +) # NOQA +from foundry.v2.ontologies.models._is_null_query_v2_dict import IsNullQueryV2Dict +from foundry.v2.ontologies.models._lt_query_v2_dict import LtQueryV2Dict +from foundry.v2.ontologies.models._lte_query_v2_dict import LteQueryV2Dict +from foundry.v2.ontologies.models._starts_with_query_dict import StartsWithQueryDict +from foundry.v2.ontologies.models._within_bounding_box_query_dict import ( + WithinBoundingBoxQueryDict, +) # NOQA +from foundry.v2.ontologies.models._within_distance_of_query_dict import ( + WithinDistanceOfQueryDict, +) # NOQA +from foundry.v2.ontologies.models._within_polygon_query_dict import WithinPolygonQueryDict # NOQA + + +class OrQueryV2Dict(TypedDict): + """Returns objects where at least 1 query is satisfied.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: List[SearchJsonQueryV2Dict] + + type: Literal["or"] + + +class NotQueryV2Dict(TypedDict): + """Returns objects where the query is not satisfied.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: SearchJsonQueryV2Dict + + type: Literal["not"] + + +class AndQueryV2Dict(TypedDict): + """Returns objects where every query is satisfied.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + value: List[SearchJsonQueryV2Dict] + + type: Literal["and"] + + +SearchJsonQueryV2Dict = Annotated[ + Union[ + OrQueryV2Dict, + DoesNotIntersectPolygonQueryDict, + LtQueryV2Dict, + DoesNotIntersectBoundingBoxQueryDict, + EqualsQueryV2Dict, + ContainsAllTermsQueryDict, + GtQueryV2Dict, + WithinDistanceOfQueryDict, + WithinBoundingBoxQueryDict, + ContainsQueryV2Dict, + NotQueryV2Dict, + IntersectsBoundingBoxQueryDict, + AndQueryV2Dict, + IsNullQueryV2Dict, + ContainsAllTermsInOrderPrefixLastTermDict, + ContainsAnyTermQueryDict, + GteQueryV2Dict, + ContainsAllTermsInOrderQueryDict, + WithinPolygonQueryDict, + IntersectsPolygonQueryDict, + LteQueryV2Dict, + StartsWithQueryDict, + ], + Field(discriminator="type"), +] +"""SearchJsonQueryV2""" diff --git a/foundry/v2/ontologies/models/_search_objects_response_v2.py b/foundry/v2/ontologies/models/_search_objects_response_v2.py new file mode 100644 index 00000000..157c2c0e --- /dev/null +++ b/foundry/v2/ontologies/models/_search_objects_response_v2.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._total_count import TotalCount +from foundry.v2.ontologies.models._ontology_object_v2 import OntologyObjectV2 +from foundry.v2.ontologies.models._search_objects_response_v2_dict import ( + SearchObjectsResponseV2Dict, +) # NOQA + + +class SearchObjectsResponseV2(BaseModel): + """SearchObjectsResponseV2""" + + data: List[OntologyObjectV2] + + next_page_token: Optional[PageToken] = Field(alias="nextPageToken", default=None) + + total_count: TotalCount = Field(alias="totalCount") + + model_config = {"extra": "allow"} + + def to_dict(self) -> SearchObjectsResponseV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(SearchObjectsResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_search_objects_response_v2_dict.py b/foundry/v2/ontologies/models/_search_objects_response_v2_dict.py new file mode 100644 index 00000000..7a353fd5 --- /dev/null +++ b/foundry/v2/ontologies/models/_search_objects_response_v2_dict.py @@ -0,0 +1,37 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._total_count import TotalCount +from foundry.v2.ontologies.models._ontology_object_v2 import OntologyObjectV2 + + +class SearchObjectsResponseV2Dict(TypedDict): + """SearchObjectsResponseV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + data: List[OntologyObjectV2] + + nextPageToken: NotRequired[PageToken] + + totalCount: TotalCount diff --git a/foundry/v2/ontologies/models/_search_order_by_v2_dict.py b/foundry/v2/ontologies/models/_search_order_by_v2_dict.py new file mode 100644 index 00000000..9f65182e --- /dev/null +++ b/foundry/v2/ontologies/models/_search_order_by_v2_dict.py @@ -0,0 +1,30 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._search_ordering_v2_dict import SearchOrderingV2Dict + + +class SearchOrderByV2Dict(TypedDict): + """Specifies the ordering of search results by a field and an ordering direction.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + fields: List[SearchOrderingV2Dict] diff --git a/foundry/v2/ontologies/models/_search_ordering_v2_dict.py b/foundry/v2/ontologies/models/_search_ordering_v2_dict.py new file mode 100644 index 00000000..f0e2a6e0 --- /dev/null +++ b/foundry/v2/ontologies/models/_search_ordering_v2_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class SearchOrderingV2Dict(TypedDict): + """SearchOrderingV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + direction: NotRequired[StrictStr] + """Specifies the ordering direction (can be either `asc` or `desc`)""" diff --git a/foundry/v2/models/_selected_property_api_name.py b/foundry/v2/ontologies/models/_selected_property_api_name.py similarity index 100% rename from foundry/v2/models/_selected_property_api_name.py rename to foundry/v2/ontologies/models/_selected_property_api_name.py diff --git a/foundry/v2/ontologies/models/_shared_property_type.py b/foundry/v2/ontologies/models/_shared_property_type.py new file mode 100644 index 00000000..dd7fbeb6 --- /dev/null +++ b/foundry/v2/ontologies/models/_shared_property_type.py @@ -0,0 +1,52 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.ontologies.models._object_property_type import ObjectPropertyType +from foundry.v2.ontologies.models._shared_property_type_api_name import ( + SharedPropertyTypeApiName, +) # NOQA +from foundry.v2.ontologies.models._shared_property_type_dict import SharedPropertyTypeDict # NOQA +from foundry.v2.ontologies.models._shared_property_type_rid import SharedPropertyTypeRid + + +class SharedPropertyType(BaseModel): + """A property type that can be shared across object types.""" + + rid: SharedPropertyTypeRid + + api_name: SharedPropertyTypeApiName = Field(alias="apiName") + + display_name: DisplayName = Field(alias="displayName") + + description: Optional[StrictStr] = None + """A short text that describes the SharedPropertyType.""" + + data_type: ObjectPropertyType = Field(alias="dataType") + + model_config = {"extra": "allow"} + + def to_dict(self) -> SharedPropertyTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(SharedPropertyTypeDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_shared_property_type_api_name.py b/foundry/v2/ontologies/models/_shared_property_type_api_name.py similarity index 100% rename from foundry/v1/models/_shared_property_type_api_name.py rename to foundry/v2/ontologies/models/_shared_property_type_api_name.py diff --git a/foundry/v2/ontologies/models/_shared_property_type_dict.py b/foundry/v2/ontologies/models/_shared_property_type_dict.py new file mode 100644 index 00000000..038516fd --- /dev/null +++ b/foundry/v2/ontologies/models/_shared_property_type_dict.py @@ -0,0 +1,44 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._display_name import DisplayName +from foundry.v2.ontologies.models._object_property_type_dict import ObjectPropertyTypeDict # NOQA +from foundry.v2.ontologies.models._shared_property_type_api_name import ( + SharedPropertyTypeApiName, +) # NOQA +from foundry.v2.ontologies.models._shared_property_type_rid import SharedPropertyTypeRid + + +class SharedPropertyTypeDict(TypedDict): + """A property type that can be shared across object types.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + rid: SharedPropertyTypeRid + + apiName: SharedPropertyTypeApiName + + displayName: DisplayName + + description: NotRequired[StrictStr] + """A short text that describes the SharedPropertyType.""" + + dataType: ObjectPropertyTypeDict diff --git a/foundry/v1/models/_shared_property_type_rid.py b/foundry/v2/ontologies/models/_shared_property_type_rid.py similarity index 100% rename from foundry/v1/models/_shared_property_type_rid.py rename to foundry/v2/ontologies/models/_shared_property_type_rid.py diff --git a/foundry/v2/ontologies/models/_starts_with_query.py b/foundry/v2/ontologies/models/_starts_with_query.py new file mode 100644 index 00000000..8c06381e --- /dev/null +++ b/foundry/v2/ontologies/models/_starts_with_query.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import StrictStr + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._starts_with_query_dict import StartsWithQueryDict + + +class StartsWithQuery(BaseModel): + """Returns objects where the specified field starts with the provided value.""" + + field: PropertyApiName + + value: StrictStr + + type: Literal["startsWith"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> StartsWithQueryDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(StartsWithQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_starts_with_query_dict.py b/foundry/v2/ontologies/models/_starts_with_query_dict.py new file mode 100644 index 00000000..ef6a2e4a --- /dev/null +++ b/foundry/v2/ontologies/models/_starts_with_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from pydantic import StrictStr +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class StartsWithQueryDict(TypedDict): + """Returns objects where the specified field starts with the provided value.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: StrictStr + + type: Literal["startsWith"] diff --git a/foundry/v2/ontologies/models/_string_length_constraint.py b/foundry/v2/ontologies/models/_string_length_constraint.py new file mode 100644 index 00000000..10bd933d --- /dev/null +++ b/foundry/v2/ontologies/models/_string_length_constraint.py @@ -0,0 +1,54 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._string_length_constraint_dict import ( + StringLengthConstraintDict, +) # NOQA + + +class StringLengthConstraint(BaseModel): + """ + The parameter value must have a length within the defined range. + *This range is always inclusive.* + """ + + lt: Optional[Any] = None + """Less than""" + + lte: Optional[Any] = None + """Less than or equal""" + + gt: Optional[Any] = None + """Greater than""" + + gte: Optional[Any] = None + """Greater than or equal""" + + type: Literal["stringLength"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> StringLengthConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(StringLengthConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_string_length_constraint_dict.py b/foundry/v2/ontologies/models/_string_length_constraint_dict.py similarity index 100% rename from foundry/v2/models/_string_length_constraint_dict.py rename to foundry/v2/ontologies/models/_string_length_constraint_dict.py diff --git a/foundry/v2/ontologies/models/_string_regex_match_constraint.py b/foundry/v2/ontologies/models/_string_regex_match_constraint.py new file mode 100644 index 00000000..87dbdff8 --- /dev/null +++ b/foundry/v2/ontologies/models/_string_regex_match_constraint.py @@ -0,0 +1,53 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.ontologies.models._string_regex_match_constraint_dict import ( + StringRegexMatchConstraintDict, +) # NOQA + + +class StringRegexMatchConstraint(BaseModel): + """The parameter value must match a predefined regular expression.""" + + regex: StrictStr + """The regular expression configured in the **Ontology Manager**.""" + + configured_failure_message: Optional[StrictStr] = Field( + alias="configuredFailureMessage", default=None + ) + """ + The message indicating that the regular expression was not matched. + This is configured per parameter in the **Ontology Manager**. + """ + + type: Literal["stringRegexMatch"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> StringRegexMatchConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + StringRegexMatchConstraintDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/models/_string_regex_match_constraint_dict.py b/foundry/v2/ontologies/models/_string_regex_match_constraint_dict.py similarity index 100% rename from foundry/v2/models/_string_regex_match_constraint_dict.py rename to foundry/v2/ontologies/models/_string_regex_match_constraint_dict.py diff --git a/foundry/v2/ontologies/models/_submission_criteria_evaluation.py b/foundry/v2/ontologies/models/_submission_criteria_evaluation.py new file mode 100644 index 00000000..9d925e08 --- /dev/null +++ b/foundry/v2/ontologies/models/_submission_criteria_evaluation.py @@ -0,0 +1,54 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.ontologies.models._submission_criteria_evaluation_dict import ( + SubmissionCriteriaEvaluationDict, +) # NOQA +from foundry.v2.ontologies.models._validation_result import ValidationResult + + +class SubmissionCriteriaEvaluation(BaseModel): + """ + Contains the status of the **submission criteria**. + **Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. + These are configured in the **Ontology Manager**. + """ + + configured_failure_message: Optional[StrictStr] = Field( + alias="configuredFailureMessage", default=None + ) + """ + The message indicating one of the **submission criteria** was not satisfied. + This is configured per **submission criteria** in the **Ontology Manager**. + """ + + result: ValidationResult + + model_config = {"extra": "allow"} + + def to_dict(self) -> SubmissionCriteriaEvaluationDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + SubmissionCriteriaEvaluationDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_submission_criteria_evaluation_dict.py b/foundry/v2/ontologies/models/_submission_criteria_evaluation_dict.py new file mode 100644 index 00000000..bf54d917 --- /dev/null +++ b/foundry/v2/ontologies/models/_submission_criteria_evaluation_dict.py @@ -0,0 +1,40 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._validation_result import ValidationResult + + +class SubmissionCriteriaEvaluationDict(TypedDict): + """ + Contains the status of the **submission criteria**. + **Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. + These are configured in the **Ontology Manager**. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + configuredFailureMessage: NotRequired[StrictStr] + """ + The message indicating one of the **submission criteria** was not satisfied. + This is configured per **submission criteria** in the **Ontology Manager**. + """ + + result: ValidationResult diff --git a/foundry/v2/ontologies/models/_sum_aggregation_v2_dict.py b/foundry/v2/ontologies/models/_sum_aggregation_v2_dict.py new file mode 100644 index 00000000..1c4141ac --- /dev/null +++ b/foundry/v2/ontologies/models/_sum_aggregation_v2_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._aggregation_metric_name import AggregationMetricName +from foundry.v2.ontologies.models._order_by_direction import OrderByDirection +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class SumAggregationV2Dict(TypedDict): + """Computes the sum of values for the provided field.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + name: NotRequired[AggregationMetricName] + + direction: NotRequired[OrderByDirection] + + type: Literal["sum"] diff --git a/foundry/v2/ontologies/models/_sync_apply_action_response_v2.py b/foundry/v2/ontologies/models/_sync_apply_action_response_v2.py new file mode 100644 index 00000000..1dd23684 --- /dev/null +++ b/foundry/v2/ontologies/models/_sync_apply_action_response_v2.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._action_results import ActionResults +from foundry.v2.ontologies.models._sync_apply_action_response_v2_dict import ( + SyncApplyActionResponseV2Dict, +) # NOQA +from foundry.v2.ontologies.models._validate_action_response_v2 import ( + ValidateActionResponseV2, +) # NOQA + + +class SyncApplyActionResponseV2(BaseModel): + """SyncApplyActionResponseV2""" + + validation: Optional[ValidateActionResponseV2] = None + + edits: Optional[ActionResults] = None + + model_config = {"extra": "allow"} + + def to_dict(self) -> SyncApplyActionResponseV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + SyncApplyActionResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_sync_apply_action_response_v2_dict.py b/foundry/v2/ontologies/models/_sync_apply_action_response_v2_dict.py new file mode 100644 index 00000000..598c3463 --- /dev/null +++ b/foundry/v2/ontologies/models/_sync_apply_action_response_v2_dict.py @@ -0,0 +1,34 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._action_results_dict import ActionResultsDict +from foundry.v2.ontologies.models._validate_action_response_v2_dict import ( + ValidateActionResponseV2Dict, +) # NOQA + + +class SyncApplyActionResponseV2Dict(TypedDict): + """SyncApplyActionResponseV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + validation: NotRequired[ValidateActionResponseV2Dict] + + edits: NotRequired[ActionResultsDict] diff --git a/foundry/v2/ontologies/models/_three_dimensional_aggregation.py b/foundry/v2/ontologies/models/_three_dimensional_aggregation.py new file mode 100644 index 00000000..924ee9bd --- /dev/null +++ b/foundry/v2/ontologies/models/_three_dimensional_aggregation.py @@ -0,0 +1,48 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._query_aggregation_key_type import QueryAggregationKeyType # NOQA +from foundry.v2.ontologies.models._three_dimensional_aggregation_dict import ( + ThreeDimensionalAggregationDict, +) # NOQA +from foundry.v2.ontologies.models._two_dimensional_aggregation import ( + TwoDimensionalAggregation, +) # NOQA + + +class ThreeDimensionalAggregation(BaseModel): + """ThreeDimensionalAggregation""" + + key_type: QueryAggregationKeyType = Field(alias="keyType") + + value_type: TwoDimensionalAggregation = Field(alias="valueType") + + type: Literal["threeDimensionalAggregation"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ThreeDimensionalAggregationDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ThreeDimensionalAggregationDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_three_dimensional_aggregation_dict.py b/foundry/v2/ontologies/models/_three_dimensional_aggregation_dict.py new file mode 100644 index 00000000..89ade8cb --- /dev/null +++ b/foundry/v2/ontologies/models/_three_dimensional_aggregation_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._query_aggregation_key_type_dict import ( + QueryAggregationKeyTypeDict, +) # NOQA +from foundry.v2.ontologies.models._two_dimensional_aggregation_dict import ( + TwoDimensionalAggregationDict, +) # NOQA + + +class ThreeDimensionalAggregationDict(TypedDict): + """ThreeDimensionalAggregation""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + keyType: QueryAggregationKeyTypeDict + + valueType: TwoDimensionalAggregationDict + + type: Literal["threeDimensionalAggregation"] diff --git a/foundry/v2/ontologies/models/_time_range_dict.py b/foundry/v2/ontologies/models/_time_range_dict.py new file mode 100644 index 00000000..bee67d5e --- /dev/null +++ b/foundry/v2/ontologies/models/_time_range_dict.py @@ -0,0 +1,29 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._absolute_time_range_dict import AbsoluteTimeRangeDict +from foundry.v2.ontologies.models._relative_time_range_dict import RelativeTimeRangeDict + +TimeRangeDict = Annotated[ + Union[AbsoluteTimeRangeDict, RelativeTimeRangeDict], Field(discriminator="type") +] +"""An absolute or relative range for a time series query.""" diff --git a/foundry/v2/ontologies/models/_time_series_point.py b/foundry/v2/ontologies/models/_time_series_point.py new file mode 100644 index 00000000..aa29b1bf --- /dev/null +++ b/foundry/v2/ontologies/models/_time_series_point.py @@ -0,0 +1,40 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from datetime import datetime +from typing import Any +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._time_series_point_dict import TimeSeriesPointDict + + +class TimeSeriesPoint(BaseModel): + """A time and value pair.""" + + time: datetime + """An ISO 8601 timestamp""" + + value: Any + """An object which is either an enum String or a double number.""" + + model_config = {"extra": "allow"} + + def to_dict(self) -> TimeSeriesPointDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(TimeSeriesPointDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v1/models/_time_series_point_dict.py b/foundry/v2/ontologies/models/_time_series_point_dict.py similarity index 100% rename from foundry/v1/models/_time_series_point_dict.py rename to foundry/v2/ontologies/models/_time_series_point_dict.py diff --git a/foundry/v2/ontologies/models/_two_dimensional_aggregation.py b/foundry/v2/ontologies/models/_two_dimensional_aggregation.py new file mode 100644 index 00000000..5e236fd5 --- /dev/null +++ b/foundry/v2/ontologies/models/_two_dimensional_aggregation.py @@ -0,0 +1,48 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._query_aggregation_key_type import QueryAggregationKeyType # NOQA +from foundry.v2.ontologies.models._query_aggregation_value_type import ( + QueryAggregationValueType, +) # NOQA +from foundry.v2.ontologies.models._two_dimensional_aggregation_dict import ( + TwoDimensionalAggregationDict, +) # NOQA + + +class TwoDimensionalAggregation(BaseModel): + """TwoDimensionalAggregation""" + + key_type: QueryAggregationKeyType = Field(alias="keyType") + + value_type: QueryAggregationValueType = Field(alias="valueType") + + type: Literal["twoDimensionalAggregation"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> TwoDimensionalAggregationDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + TwoDimensionalAggregationDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_two_dimensional_aggregation_dict.py b/foundry/v2/ontologies/models/_two_dimensional_aggregation_dict.py new file mode 100644 index 00000000..addd63e7 --- /dev/null +++ b/foundry/v2/ontologies/models/_two_dimensional_aggregation_dict.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._query_aggregation_key_type_dict import ( + QueryAggregationKeyTypeDict, +) # NOQA +from foundry.v2.ontologies.models._query_aggregation_value_type_dict import ( + QueryAggregationValueTypeDict, +) # NOQA + + +class TwoDimensionalAggregationDict(TypedDict): + """TwoDimensionalAggregation""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + keyType: QueryAggregationKeyTypeDict + + valueType: QueryAggregationValueTypeDict + + type: Literal["twoDimensionalAggregation"] diff --git a/foundry/v2/ontologies/models/_unevaluable_constraint.py b/foundry/v2/ontologies/models/_unevaluable_constraint.py new file mode 100644 index 00000000..0c9fb563 --- /dev/null +++ b/foundry/v2/ontologies/models/_unevaluable_constraint.py @@ -0,0 +1,40 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._unevaluable_constraint_dict import ( + UnevaluableConstraintDict, +) # NOQA + + +class UnevaluableConstraint(BaseModel): + """ + The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. + This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. + """ + + type: Literal["unevaluable"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> UnevaluableConstraintDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(UnevaluableConstraintDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/models/_unevaluable_constraint_dict.py b/foundry/v2/ontologies/models/_unevaluable_constraint_dict.py similarity index 100% rename from foundry/v2/models/_unevaluable_constraint_dict.py rename to foundry/v2/ontologies/models/_unevaluable_constraint_dict.py diff --git a/foundry/v2/ontologies/models/_validate_action_response_v2.py b/foundry/v2/ontologies/models/_validate_action_response_v2.py new file mode 100644 index 00000000..05fb68aa --- /dev/null +++ b/foundry/v2/ontologies/models/_validate_action_response_v2.py @@ -0,0 +1,53 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.ontologies.models._parameter_evaluation_result import ( + ParameterEvaluationResult, +) # NOQA +from foundry.v2.ontologies.models._parameter_id import ParameterId +from foundry.v2.ontologies.models._submission_criteria_evaluation import ( + SubmissionCriteriaEvaluation, +) # NOQA +from foundry.v2.ontologies.models._validate_action_response_v2_dict import ( + ValidateActionResponseV2Dict, +) # NOQA +from foundry.v2.ontologies.models._validation_result import ValidationResult + + +class ValidateActionResponseV2(BaseModel): + """ValidateActionResponseV2""" + + result: ValidationResult + + submission_criteria: List[SubmissionCriteriaEvaluation] = Field(alias="submissionCriteria") + + parameters: Dict[ParameterId, ParameterEvaluationResult] + + model_config = {"extra": "allow"} + + def to_dict(self) -> ValidateActionResponseV2Dict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ValidateActionResponseV2Dict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_validate_action_response_v2_dict.py b/foundry/v2/ontologies/models/_validate_action_response_v2_dict.py new file mode 100644 index 00000000..73abea5a --- /dev/null +++ b/foundry/v2/ontologies/models/_validate_action_response_v2_dict.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Dict +from typing import List + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._parameter_evaluation_result_dict import ( + ParameterEvaluationResultDict, +) # NOQA +from foundry.v2.ontologies.models._parameter_id import ParameterId +from foundry.v2.ontologies.models._submission_criteria_evaluation_dict import ( + SubmissionCriteriaEvaluationDict, +) # NOQA +from foundry.v2.ontologies.models._validation_result import ValidationResult + + +class ValidateActionResponseV2Dict(TypedDict): + """ValidateActionResponseV2""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + result: ValidationResult + + submissionCriteria: List[SubmissionCriteriaEvaluationDict] + + parameters: Dict[ParameterId, ParameterEvaluationResultDict] diff --git a/foundry/v2/models/_validation_result.py b/foundry/v2/ontologies/models/_validation_result.py similarity index 100% rename from foundry/v2/models/_validation_result.py rename to foundry/v2/ontologies/models/_validation_result.py diff --git a/foundry/v2/ontologies/models/_within_bounding_box_point.py b/foundry/v2/ontologies/models/_within_bounding_box_point.py new file mode 100644 index 00000000..5d639912 --- /dev/null +++ b/foundry/v2/ontologies/models/_within_bounding_box_point.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry.v2.geo.models._geo_point import GeoPoint + +WithinBoundingBoxPoint = GeoPoint +"""WithinBoundingBoxPoint""" diff --git a/foundry/v2/ontologies/models/_within_bounding_box_point_dict.py b/foundry/v2/ontologies/models/_within_bounding_box_point_dict.py new file mode 100644 index 00000000..1f9549ad --- /dev/null +++ b/foundry/v2/ontologies/models/_within_bounding_box_point_dict.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry.v2.geo.models._geo_point_dict import GeoPointDict + +WithinBoundingBoxPointDict = GeoPointDict +"""WithinBoundingBoxPoint""" diff --git a/foundry/v2/ontologies/models/_within_bounding_box_query.py b/foundry/v2/ontologies/models/_within_bounding_box_query.py new file mode 100644 index 00000000..27e5479d --- /dev/null +++ b/foundry/v2/ontologies/models/_within_bounding_box_query.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._bounding_box_value import BoundingBoxValue +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._within_bounding_box_query_dict import ( + WithinBoundingBoxQueryDict, +) # NOQA + + +class WithinBoundingBoxQuery(BaseModel): + """Returns objects where the specified field contains a point within the bounding box provided.""" + + field: PropertyApiName + + value: BoundingBoxValue + + type: Literal["withinBoundingBox"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> WithinBoundingBoxQueryDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(WithinBoundingBoxQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_within_bounding_box_query_dict.py b/foundry/v2/ontologies/models/_within_bounding_box_query_dict.py new file mode 100644 index 00000000..41356de6 --- /dev/null +++ b/foundry/v2/ontologies/models/_within_bounding_box_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._bounding_box_value_dict import BoundingBoxValueDict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class WithinBoundingBoxQueryDict(TypedDict): + """Returns objects where the specified field contains a point within the bounding box provided.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: BoundingBoxValueDict + + type: Literal["withinBoundingBox"] diff --git a/foundry/v2/ontologies/models/_within_distance_of_query.py b/foundry/v2/ontologies/models/_within_distance_of_query.py new file mode 100644 index 00000000..debe3401 --- /dev/null +++ b/foundry/v2/ontologies/models/_within_distance_of_query.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._center_point import CenterPoint +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._within_distance_of_query_dict import ( + WithinDistanceOfQueryDict, +) # NOQA + + +class WithinDistanceOfQuery(BaseModel): + """Returns objects where the specified field contains a point within the distance provided of the center point.""" + + field: PropertyApiName + + value: CenterPoint + + type: Literal["withinDistanceOf"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> WithinDistanceOfQueryDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(WithinDistanceOfQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_within_distance_of_query_dict.py b/foundry/v2/ontologies/models/_within_distance_of_query_dict.py new file mode 100644 index 00000000..60c98884 --- /dev/null +++ b/foundry/v2/ontologies/models/_within_distance_of_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._center_point_dict import CenterPointDict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class WithinDistanceOfQueryDict(TypedDict): + """Returns objects where the specified field contains a point within the distance provided of the center point.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: CenterPointDict + + type: Literal["withinDistanceOf"] diff --git a/foundry/v2/ontologies/models/_within_polygon_query.py b/foundry/v2/ontologies/models/_within_polygon_query.py new file mode 100644 index 00000000..e580d265 --- /dev/null +++ b/foundry/v2/ontologies/models/_within_polygon_query.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.ontologies.models._polygon_value import PolygonValue +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._within_polygon_query_dict import WithinPolygonQueryDict # NOQA + + +class WithinPolygonQuery(BaseModel): + """Returns objects where the specified field contains a point within the polygon provided.""" + + field: PropertyApiName + + value: PolygonValue + + type: Literal["withinPolygon"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> WithinPolygonQueryDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(WithinPolygonQueryDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/ontologies/models/_within_polygon_query_dict.py b/foundry/v2/ontologies/models/_within_polygon_query_dict.py new file mode 100644 index 00000000..8680ff8b --- /dev/null +++ b/foundry/v2/ontologies/models/_within_polygon_query_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._polygon_value_dict import PolygonValueDict +from foundry.v2.ontologies.models._property_api_name import PropertyApiName + + +class WithinPolygonQueryDict(TypedDict): + """Returns objects where the specified field contains a point within the polygon provided.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + field: PropertyApiName + + value: PolygonValueDict + + type: Literal["withinPolygon"] diff --git a/foundry/v2/ontologies/object_type.py b/foundry/v2/ontologies/object_type.py new file mode 100644 index 00000000..d3b03472 --- /dev/null +++ b/foundry/v2/ontologies/object_type.py @@ -0,0 +1,342 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._link_type_api_name import LinkTypeApiName +from foundry.v2.ontologies.models._link_type_side_v2 import LinkTypeSideV2 +from foundry.v2.ontologies.models._list_object_types_v2_response import ( + ListObjectTypesV2Response, +) # NOQA +from foundry.v2.ontologies.models._list_outgoing_link_types_response_v2 import ( + ListOutgoingLinkTypesResponseV2, +) # NOQA +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._object_type_v2 import ObjectTypeV2 +from foundry.v2.ontologies.models._ontology_identifier import OntologyIdentifier + + +class ObjectTypeClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ObjectTypeV2: + """ + Gets a specific object type with the given API name. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ObjectTypeV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objectTypes/{objectType}", + query_params={}, + path_params={ + "ontology": ontology, + "objectType": object_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ObjectTypeV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get_outgoing_link_type( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + link_type: LinkTypeApiName, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> LinkTypeSideV2: + """ + Get an outgoing link for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param link_type: linkType + :type link_type: LinkTypeApiName + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: LinkTypeSideV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}", + query_params={}, + path_params={ + "ontology": ontology, + "objectType": object_type, + "linkType": link_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=LinkTypeSideV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + ontology: OntologyIdentifier, + *, + page_size: Optional[PageSize] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[ObjectTypeV2]: + """ + Lists the object types for the given Ontology. + + Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are + more results available, at least one result will be present in the + response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[ObjectTypeV2] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objectTypes", + query_params={ + "pageSize": page_size, + }, + path_params={ + "ontology": ontology, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListObjectTypesV2Response, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list_outgoing_link_types( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + *, + page_size: Optional[PageSize] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[LinkTypeSideV2]: + """ + List the outgoing links for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[LinkTypeSideV2] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes", + query_params={ + "pageSize": page_size, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListOutgoingLinkTypesResponseV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + ontology: OntologyIdentifier, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListObjectTypesV2Response: + """ + Lists the object types for the given Ontology. + + Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are + more results available, at least one result will be present in the + response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListObjectTypesV2Response + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objectTypes", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + }, + path_params={ + "ontology": ontology, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListObjectTypesV2Response, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page_outgoing_link_types( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListOutgoingLinkTypesResponseV2: + """ + List the outgoing links for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListOutgoingLinkTypesResponseV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListOutgoingLinkTypesResponseV2, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/ontologies/ontology.py b/foundry/v2/ontologies/ontology.py new file mode 100644 index 00000000..d13d134b --- /dev/null +++ b/foundry/v2/ontologies/ontology.py @@ -0,0 +1,121 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v2.ontologies.action_type import ActionTypeClient +from foundry.v2.ontologies.models._ontology_full_metadata import OntologyFullMetadata +from foundry.v2.ontologies.models._ontology_identifier import OntologyIdentifier +from foundry.v2.ontologies.models._ontology_v2 import OntologyV2 +from foundry.v2.ontologies.object_type import ObjectTypeClient +from foundry.v2.ontologies.query_type import QueryTypeClient + + +class OntologyClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + self.ActionType = ActionTypeClient(auth=auth, hostname=hostname) + self.ObjectType = ObjectTypeClient(auth=auth, hostname=hostname) + self.QueryType = QueryTypeClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get( + self, + ontology: OntologyIdentifier, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> OntologyV2: + """ + Gets a specific ontology with the given Ontology RID. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: OntologyV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}", + query_params={}, + path_params={ + "ontology": ontology, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=OntologyV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get_full_metadata( + self, + ontology: OntologyIdentifier, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> OntologyFullMetadata: + """ + Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: OntologyFullMetadata + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/fullMetadata", + query_params={}, + path_params={ + "ontology": ontology, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=OntologyFullMetadata, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/ontologies/ontology_interface.py b/foundry/v2/ontologies/ontology_interface.py new file mode 100644 index 00000000..61f78770 --- /dev/null +++ b/foundry/v2/ontologies/ontology_interface.py @@ -0,0 +1,307 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import List +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.ontologies.models._aggregate_objects_response_v2 import ( + AggregateObjectsResponseV2, +) # NOQA +from foundry.v2.ontologies.models._aggregation_accuracy_request import ( + AggregationAccuracyRequest, +) # NOQA +from foundry.v2.ontologies.models._aggregation_group_by_v2_dict import ( + AggregationGroupByV2Dict, +) # NOQA +from foundry.v2.ontologies.models._aggregation_v2_dict import AggregationV2Dict +from foundry.v2.ontologies.models._interface_type import InterfaceType +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName +from foundry.v2.ontologies.models._list_interface_types_response import ( + ListInterfaceTypesResponse, +) # NOQA +from foundry.v2.ontologies.models._ontology_identifier import OntologyIdentifier +from foundry.v2.ontologies.models._search_json_query_v2_dict import SearchJsonQueryV2Dict # NOQA + + +class OntologyInterfaceClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def aggregate( + self, + ontology: OntologyIdentifier, + interface_type: InterfaceTypeApiName, + *, + aggregation: List[AggregationV2Dict], + group_by: List[AggregationGroupByV2Dict], + accuracy: Optional[AggregationAccuracyRequest] = None, + preview: Optional[PreviewMode] = None, + where: Optional[SearchJsonQueryV2Dict] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> AggregateObjectsResponseV2: + """ + :::callout{theme=warning title=Warning} + This endpoint is in preview and may be modified or removed at any time. + To use this endpoint, add `preview=true` to the request query parameters. + ::: + + Perform functions on object fields in the specified ontology and of the specified interface type. Any + properties specified in the query must be shared property type API names defined on the interface. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param interface_type: interfaceType + :type interface_type: InterfaceTypeApiName + :param aggregation: + :type aggregation: List[AggregationV2Dict] + :param group_by: + :type group_by: List[AggregationGroupByV2Dict] + :param accuracy: + :type accuracy: Optional[AggregationAccuracyRequest] + :param preview: preview + :type preview: Optional[PreviewMode] + :param where: + :type where: Optional[SearchJsonQueryV2Dict] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: AggregateObjectsResponseV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate", + query_params={ + "preview": preview, + }, + path_params={ + "ontology": ontology, + "interfaceType": interface_type, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "aggregation": aggregation, + "where": where, + "groupBy": group_by, + "accuracy": accuracy, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "aggregation": List[AggregationV2Dict], + "where": Optional[SearchJsonQueryV2Dict], + "groupBy": List[AggregationGroupByV2Dict], + "accuracy": Optional[AggregationAccuracyRequest], + }, + ), + response_type=AggregateObjectsResponseV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + ontology: OntologyIdentifier, + interface_type: InterfaceTypeApiName, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> InterfaceType: + """ + :::callout{theme=warning title=Warning} + This endpoint is in preview and may be modified or removed at any time. + To use this endpoint, add `preview=true` to the request query parameters. + ::: + + Gets a specific object type with the given API name. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param interface_type: interfaceType + :type interface_type: InterfaceTypeApiName + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: InterfaceType + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/interfaceTypes/{interfaceType}", + query_params={ + "preview": preview, + }, + path_params={ + "ontology": ontology, + "interfaceType": interface_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=InterfaceType, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + ontology: OntologyIdentifier, + *, + page_size: Optional[PageSize] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[InterfaceType]: + """ + :::callout{theme=warning title=Warning} + This endpoint is in preview and may be modified or removed at any time. + To use this endpoint, add `preview=true` to the request query parameters. + ::: + + Lists the interface types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[InterfaceType] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/interfaceTypes", + query_params={ + "pageSize": page_size, + "preview": preview, + }, + path_params={ + "ontology": ontology, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListInterfaceTypesResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + ontology: OntologyIdentifier, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListInterfaceTypesResponse: + """ + :::callout{theme=warning title=Warning} + This endpoint is in preview and may be modified or removed at any time. + To use this endpoint, add `preview=true` to the request query parameters. + ::: + + Lists the interface types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListInterfaceTypesResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/interfaceTypes", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + "preview": preview, + }, + path_params={ + "ontology": ontology, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListInterfaceTypesResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/ontologies/ontology_object.py b/foundry/v2/ontologies/ontology_object.py new file mode 100644 index 00000000..94b5fec9 --- /dev/null +++ b/foundry/v2/ontologies/ontology_object.py @@ -0,0 +1,532 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import List +from typing import Optional + +from pydantic import Field +from pydantic import StrictBool +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._aggregate_objects_response_v2 import ( + AggregateObjectsResponseV2, +) # NOQA +from foundry.v2.ontologies.models._aggregation_accuracy_request import ( + AggregationAccuracyRequest, +) # NOQA +from foundry.v2.ontologies.models._aggregation_group_by_v2_dict import ( + AggregationGroupByV2Dict, +) # NOQA +from foundry.v2.ontologies.models._aggregation_v2_dict import AggregationV2Dict +from foundry.v2.ontologies.models._artifact_repository_rid import ArtifactRepositoryRid +from foundry.v2.ontologies.models._count_objects_response_v2 import CountObjectsResponseV2 # NOQA +from foundry.v2.ontologies.models._list_objects_response_v2 import ListObjectsResponseV2 +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._ontology_identifier import OntologyIdentifier +from foundry.v2.ontologies.models._ontology_object_v2 import OntologyObjectV2 +from foundry.v2.ontologies.models._order_by import OrderBy +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value_escaped_string import ( + PropertyValueEscapedString, +) # NOQA +from foundry.v2.ontologies.models._sdk_package_name import SdkPackageName +from foundry.v2.ontologies.models._search_json_query_v2_dict import SearchJsonQueryV2Dict # NOQA +from foundry.v2.ontologies.models._search_objects_response_v2 import SearchObjectsResponseV2 # NOQA +from foundry.v2.ontologies.models._search_order_by_v2_dict import SearchOrderByV2Dict +from foundry.v2.ontologies.models._selected_property_api_name import SelectedPropertyApiName # NOQA + + +class OntologyObjectClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def aggregate( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + *, + aggregation: List[AggregationV2Dict], + group_by: List[AggregationGroupByV2Dict], + accuracy: Optional[AggregationAccuracyRequest] = None, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + package_name: Optional[SdkPackageName] = None, + where: Optional[SearchJsonQueryV2Dict] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> AggregateObjectsResponseV2: + """ + Perform functions on object fields in the specified ontology and object type. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param aggregation: + :type aggregation: List[AggregationV2Dict] + :param group_by: + :type group_by: List[AggregationGroupByV2Dict] + :param accuracy: + :type accuracy: Optional[AggregationAccuracyRequest] + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param where: + :type where: Optional[SearchJsonQueryV2Dict] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: AggregateObjectsResponseV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/aggregate", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "aggregation": aggregation, + "where": where, + "groupBy": group_by, + "accuracy": accuracy, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "aggregation": List[AggregationV2Dict], + "where": Optional[SearchJsonQueryV2Dict], + "groupBy": List[AggregationGroupByV2Dict], + "accuracy": Optional[AggregationAccuracyRequest], + }, + ), + response_type=AggregateObjectsResponseV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def count( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + *, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + package_name: Optional[SdkPackageName] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> CountObjectsResponseV2: + """ + Returns a count of the objects of the given object type. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: CountObjectsResponseV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/count", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=CountObjectsResponseV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + *, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + exclude_rid: Optional[StrictBool] = None, + package_name: Optional[SdkPackageName] = None, + select: Optional[List[SelectedPropertyApiName]] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> OntologyObjectV2: + """ + Gets a specific object with the given primary key. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param exclude_rid: excludeRid + :type exclude_rid: Optional[StrictBool] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param select: select + :type select: Optional[List[SelectedPropertyApiName]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: OntologyObjectV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}", + query_params={ + "artifactRepository": artifact_repository, + "excludeRid": exclude_rid, + "packageName": package_name, + "select": select, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + "primaryKey": primary_key, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=OntologyObjectV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + *, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + exclude_rid: Optional[StrictBool] = None, + order_by: Optional[OrderBy] = None, + package_name: Optional[SdkPackageName] = None, + page_size: Optional[PageSize] = None, + select: Optional[List[SelectedPropertyApiName]] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[OntologyObjectV2]: + """ + Lists the objects for the given Ontology and object type. + + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param exclude_rid: excludeRid + :type exclude_rid: Optional[StrictBool] + :param order_by: orderBy + :type order_by: Optional[OrderBy] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param select: select + :type select: Optional[List[SelectedPropertyApiName]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[OntologyObjectV2] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}", + query_params={ + "artifactRepository": artifact_repository, + "excludeRid": exclude_rid, + "orderBy": order_by, + "packageName": package_name, + "pageSize": page_size, + "select": select, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListObjectsResponseV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + *, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + exclude_rid: Optional[StrictBool] = None, + order_by: Optional[OrderBy] = None, + package_name: Optional[SdkPackageName] = None, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + select: Optional[List[SelectedPropertyApiName]] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListObjectsResponseV2: + """ + Lists the objects for the given Ontology and object type. + + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param exclude_rid: excludeRid + :type exclude_rid: Optional[StrictBool] + :param order_by: orderBy + :type order_by: Optional[OrderBy] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param select: select + :type select: Optional[List[SelectedPropertyApiName]] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListObjectsResponseV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}", + query_params={ + "artifactRepository": artifact_repository, + "excludeRid": exclude_rid, + "orderBy": order_by, + "packageName": package_name, + "pageSize": page_size, + "pageToken": page_token, + "select": select, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListObjectsResponseV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def search( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + *, + select: List[PropertyApiName], + artifact_repository: Optional[ArtifactRepositoryRid] = None, + exclude_rid: Optional[StrictBool] = None, + order_by: Optional[SearchOrderByV2Dict] = None, + package_name: Optional[SdkPackageName] = None, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + where: Optional[SearchJsonQueryV2Dict] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> SearchObjectsResponseV2: + """ + Search for objects in the specified ontology and object type. The request body is used + to filter objects based on the specified query. The supported queries are: + + | Query type | Description | Supported Types | + |-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------| + | lt | The provided property is less than the provided value. | number, string, date, timestamp | + | gt | The provided property is greater than the provided value. | number, string, date, timestamp | + | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp | + | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp | + | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp | + | isNull | The provided property is (or is not) null. | all | + | contains | The provided property contains the provided value. | array | + | not | The sub-query does not match. | N/A (applied on a query) | + | and | All the sub-queries match. | N/A (applied on queries) | + | or | At least one of the sub-queries match. | N/A (applied on queries) | + | startsWith | The provided property starts with the provided value. | string | + | containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string | + | containsAllTermsInOrder | The provided property contains the provided value as a substring. | string | + | containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string | + | containsAllTerms | The provided property contains all the terms separated by whitespace. | string | + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param select: The API names of the object type properties to include in the response. + :type select: List[PropertyApiName] + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param exclude_rid: A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. + :type exclude_rid: Optional[StrictBool] + :param order_by: + :type order_by: Optional[SearchOrderByV2Dict] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param page_size: + :type page_size: Optional[PageSize] + :param page_token: + :type page_token: Optional[PageToken] + :param where: + :type where: Optional[SearchJsonQueryV2Dict] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: SearchObjectsResponseV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/search", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "where": where, + "orderBy": order_by, + "pageSize": page_size, + "pageToken": page_token, + "select": select, + "excludeRid": exclude_rid, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "where": Optional[SearchJsonQueryV2Dict], + "orderBy": Optional[SearchOrderByV2Dict], + "pageSize": Optional[PageSize], + "pageToken": Optional[PageToken], + "select": List[PropertyApiName], + "excludeRid": Optional[StrictBool], + }, + ), + response_type=SearchObjectsResponseV2, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/ontologies/ontology_object_set.py b/foundry/v2/ontologies/ontology_object_set.py new file mode 100644 index 00000000..47721199 --- /dev/null +++ b/foundry/v2/ontologies/ontology_object_set.py @@ -0,0 +1,321 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import List +from typing import Optional + +from pydantic import Field +from pydantic import StrictBool +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._aggregate_objects_response_v2 import ( + AggregateObjectsResponseV2, +) # NOQA +from foundry.v2.ontologies.models._aggregation_accuracy_request import ( + AggregationAccuracyRequest, +) # NOQA +from foundry.v2.ontologies.models._aggregation_group_by_v2_dict import ( + AggregationGroupByV2Dict, +) # NOQA +from foundry.v2.ontologies.models._aggregation_v2_dict import AggregationV2Dict +from foundry.v2.ontologies.models._artifact_repository_rid import ArtifactRepositoryRid +from foundry.v2.ontologies.models._create_temporary_object_set_response_v2 import ( + CreateTemporaryObjectSetResponseV2, +) # NOQA +from foundry.v2.ontologies.models._load_object_set_response_v2 import ( + LoadObjectSetResponseV2, +) # NOQA +from foundry.v2.ontologies.models._object_set import ObjectSet +from foundry.v2.ontologies.models._object_set_dict import ObjectSetDict +from foundry.v2.ontologies.models._object_set_rid import ObjectSetRid +from foundry.v2.ontologies.models._ontology_identifier import OntologyIdentifier +from foundry.v2.ontologies.models._sdk_package_name import SdkPackageName +from foundry.v2.ontologies.models._search_order_by_v2_dict import SearchOrderByV2Dict +from foundry.v2.ontologies.models._selected_property_api_name import SelectedPropertyApiName # NOQA + + +class OntologyObjectSetClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def aggregate( + self, + ontology: OntologyIdentifier, + *, + aggregation: List[AggregationV2Dict], + group_by: List[AggregationGroupByV2Dict], + object_set: ObjectSetDict, + accuracy: Optional[AggregationAccuracyRequest] = None, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + package_name: Optional[SdkPackageName] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> AggregateObjectsResponseV2: + """ + Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param aggregation: + :type aggregation: List[AggregationV2Dict] + :param group_by: + :type group_by: List[AggregationGroupByV2Dict] + :param object_set: + :type object_set: ObjectSetDict + :param accuracy: + :type accuracy: Optional[AggregationAccuracyRequest] + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: AggregateObjectsResponseV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/objectSets/aggregate", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "aggregation": aggregation, + "objectSet": object_set, + "groupBy": group_by, + "accuracy": accuracy, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "aggregation": List[AggregationV2Dict], + "objectSet": ObjectSetDict, + "groupBy": List[AggregationGroupByV2Dict], + "accuracy": Optional[AggregationAccuracyRequest], + }, + ), + response_type=AggregateObjectsResponseV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def create_temporary( + self, + ontology: OntologyIdentifier, + *, + object_set: ObjectSetDict, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> CreateTemporaryObjectSetResponseV2: + """ + Creates a temporary `ObjectSet` from the given definition. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read api:ontologies-write`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_set: + :type object_set: ObjectSetDict + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: CreateTemporaryObjectSetResponseV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/objectSets/createTemporary", + query_params={}, + path_params={ + "ontology": ontology, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "objectSet": object_set, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "objectSet": ObjectSetDict, + }, + ), + response_type=CreateTemporaryObjectSetResponseV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + ontology: OntologyIdentifier, + object_set_rid: ObjectSetRid, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ObjectSet: + """ + Gets the definition of the `ObjectSet` with the given RID. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_set_rid: objectSetRid + :type object_set_rid: ObjectSetRid + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ObjectSet + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objectSets/{objectSetRid}", + query_params={}, + path_params={ + "ontology": ontology, + "objectSetRid": object_set_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ObjectSet, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def load( + self, + ontology: OntologyIdentifier, + *, + object_set: ObjectSetDict, + select: List[SelectedPropertyApiName], + artifact_repository: Optional[ArtifactRepositoryRid] = None, + exclude_rid: Optional[StrictBool] = None, + order_by: Optional[SearchOrderByV2Dict] = None, + package_name: Optional[SdkPackageName] = None, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> LoadObjectSetResponseV2: + """ + Load the ontology objects present in the `ObjectSet` from the provided object set definition. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_set: + :type object_set: ObjectSetDict + :param select: + :type select: List[SelectedPropertyApiName] + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param exclude_rid: A flag to exclude the retrieval of the `__rid` property. Setting this to true may improve performance of this endpoint for object types in OSV2. + :type exclude_rid: Optional[StrictBool] + :param order_by: + :type order_by: Optional[SearchOrderByV2Dict] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param page_size: + :type page_size: Optional[PageSize] + :param page_token: + :type page_token: Optional[PageToken] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: LoadObjectSetResponseV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/objectSets/loadObjects", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "objectSet": object_set, + "orderBy": order_by, + "select": select, + "pageToken": page_token, + "pageSize": page_size, + "excludeRid": exclude_rid, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "objectSet": ObjectSetDict, + "orderBy": Optional[SearchOrderByV2Dict], + "select": List[SelectedPropertyApiName], + "pageToken": Optional[PageToken], + "pageSize": Optional[PageSize], + "excludeRid": Optional[StrictBool], + }, + ), + response_type=LoadObjectSetResponseV2, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/ontologies/query.py b/foundry/v2/ontologies/query.py new file mode 100644 index 00000000..6d0c74cd --- /dev/null +++ b/foundry/v2/ontologies/query.py @@ -0,0 +1,109 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v2.ontologies.models._artifact_repository_rid import ArtifactRepositoryRid +from foundry.v2.ontologies.models._data_value import DataValue +from foundry.v2.ontologies.models._execute_query_response import ExecuteQueryResponse +from foundry.v2.ontologies.models._ontology_identifier import OntologyIdentifier +from foundry.v2.ontologies.models._parameter_id import ParameterId +from foundry.v2.ontologies.models._query_api_name import QueryApiName +from foundry.v2.ontologies.models._sdk_package_name import SdkPackageName + + +class QueryClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def execute( + self, + ontology: OntologyIdentifier, + query_api_name: QueryApiName, + *, + parameters: Dict[ParameterId, Optional[DataValue]], + artifact_repository: Optional[ArtifactRepositoryRid] = None, + package_name: Optional[SdkPackageName] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ExecuteQueryResponse: + """ + Executes a Query using the given parameters. + + Optional parameters do not need to be supplied. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param query_api_name: queryApiName + :type query_api_name: QueryApiName + :param parameters: + :type parameters: Dict[ParameterId, Optional[DataValue]] + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ExecuteQueryResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/queries/{queryApiName}/execute", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + "queryApiName": query_api_name, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "parameters": parameters, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "parameters": Dict[ParameterId, Optional[DataValue]], + }, + ), + response_type=ExecuteQueryResponse, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/ontologies/query_type.py b/foundry/v2/ontologies/query_type.py new file mode 100644 index 00000000..f3b6f990 --- /dev/null +++ b/foundry/v2/ontologies/query_type.py @@ -0,0 +1,185 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.ontologies.models._list_query_types_response_v2 import ( + ListQueryTypesResponseV2, +) # NOQA +from foundry.v2.ontologies.models._ontology_identifier import OntologyIdentifier +from foundry.v2.ontologies.models._query_api_name import QueryApiName +from foundry.v2.ontologies.models._query_type_v2 import QueryTypeV2 + + +class QueryTypeClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get( + self, + ontology: OntologyIdentifier, + query_api_name: QueryApiName, + *, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> QueryTypeV2: + """ + Gets a specific query type with the given API name. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param query_api_name: queryApiName + :type query_api_name: QueryApiName + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: QueryTypeV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/queryTypes/{queryApiName}", + query_params={}, + path_params={ + "ontology": ontology, + "queryApiName": query_api_name, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=QueryTypeV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + ontology: OntologyIdentifier, + *, + page_size: Optional[PageSize] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[QueryTypeV2]: + """ + Lists the query types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[QueryTypeV2] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/queryTypes", + query_params={ + "pageSize": page_size, + }, + path_params={ + "ontology": ontology, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListQueryTypesResponseV2, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + ontology: OntologyIdentifier, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListQueryTypesResponseV2: + """ + Lists the query types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListQueryTypesResponseV2 + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/queryTypes", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + }, + path_params={ + "ontology": ontology, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListQueryTypesResponseV2, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/ontologies/time_series_property_v2.py b/foundry/v2/ontologies/time_series_property_v2.py new file mode 100644 index 00000000..d1f74f01 --- /dev/null +++ b/foundry/v2/ontologies/time_series_property_v2.py @@ -0,0 +1,240 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v2.ontologies.models._artifact_repository_rid import ArtifactRepositoryRid +from foundry.v2.ontologies.models._object_type_api_name import ObjectTypeApiName +from foundry.v2.ontologies.models._ontology_identifier import OntologyIdentifier +from foundry.v2.ontologies.models._property_api_name import PropertyApiName +from foundry.v2.ontologies.models._property_value_escaped_string import ( + PropertyValueEscapedString, +) # NOQA +from foundry.v2.ontologies.models._sdk_package_name import SdkPackageName +from foundry.v2.ontologies.models._time_range_dict import TimeRangeDict +from foundry.v2.ontologies.models._time_series_point import TimeSeriesPoint + + +class TimeSeriesPropertyV2Client: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get_first_point( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + property: PropertyApiName, + *, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + package_name: Optional[SdkPackageName] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> TimeSeriesPoint: + """ + Get the first point of a time series property. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param property: property + :type property: PropertyApiName + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: TimeSeriesPoint + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + "primaryKey": primary_key, + "property": property, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=TimeSeriesPoint, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get_last_point( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + property: PropertyApiName, + *, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + package_name: Optional[SdkPackageName] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> TimeSeriesPoint: + """ + Get the last point of a time series property. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param property: property + :type property: PropertyApiName + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: TimeSeriesPoint + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + "primaryKey": primary_key, + "property": property, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=TimeSeriesPoint, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def stream_points( + self, + ontology: OntologyIdentifier, + object_type: ObjectTypeApiName, + primary_key: PropertyValueEscapedString, + property: PropertyApiName, + *, + artifact_repository: Optional[ArtifactRepositoryRid] = None, + package_name: Optional[SdkPackageName] = None, + range: Optional[TimeRangeDict] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> bytes: + """ + Stream all of the points of a time series property. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + + :param ontology: ontology + :type ontology: OntologyIdentifier + :param object_type: objectType + :type object_type: ObjectTypeApiName + :param primary_key: primaryKey + :type primary_key: PropertyValueEscapedString + :param property: property + :type property: PropertyApiName + :param artifact_repository: artifactRepository + :type artifact_repository: Optional[ArtifactRepositoryRid] + :param package_name: packageName + :type package_name: Optional[SdkPackageName] + :param range: + :type range: Optional[TimeRangeDict] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: bytes + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints", + query_params={ + "artifactRepository": artifact_repository, + "packageName": package_name, + }, + path_params={ + "ontology": ontology, + "objectType": object_type, + "primaryKey": primary_key, + "property": property, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "*/*", + }, + body={ + "range": range, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "range": Optional[TimeRangeDict], + }, + ), + response_type=bytes, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/orchestration/build.py b/foundry/v2/orchestration/build.py new file mode 100644 index 00000000..55aa00ad --- /dev/null +++ b/foundry/v2/orchestration/build.py @@ -0,0 +1,172 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.orchestration.models._abort_on_failure import AbortOnFailure +from foundry.v2.orchestration.models._build import Build +from foundry.v2.orchestration.models._build_rid import BuildRid +from foundry.v2.orchestration.models._build_target_dict import BuildTargetDict +from foundry.v2.orchestration.models._fallback_branches import FallbackBranches +from foundry.v2.orchestration.models._force_build import ForceBuild +from foundry.v2.orchestration.models._notifications_enabled import NotificationsEnabled +from foundry.v2.orchestration.models._retry_backoff_duration_dict import ( + RetryBackoffDurationDict, +) # NOQA +from foundry.v2.orchestration.models._retry_count import RetryCount + + +class BuildClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def create( + self, + *, + fallback_branches: FallbackBranches, + target: BuildTargetDict, + abort_on_failure: Optional[AbortOnFailure] = None, + branch_name: Optional[BranchName] = None, + force_build: Optional[ForceBuild] = None, + notifications_enabled: Optional[NotificationsEnabled] = None, + preview: Optional[PreviewMode] = None, + retry_backoff_duration: Optional[RetryBackoffDurationDict] = None, + retry_count: Optional[RetryCount] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Build: + """ + + :param fallback_branches: + :type fallback_branches: FallbackBranches + :param target: The targets of the schedule. + :type target: BuildTargetDict + :param abort_on_failure: + :type abort_on_failure: Optional[AbortOnFailure] + :param branch_name: The target branch the build should run on. + :type branch_name: Optional[BranchName] + :param force_build: + :type force_build: Optional[ForceBuild] + :param notifications_enabled: + :type notifications_enabled: Optional[NotificationsEnabled] + :param preview: preview + :type preview: Optional[PreviewMode] + :param retry_backoff_duration: + :type retry_backoff_duration: Optional[RetryBackoffDurationDict] + :param retry_count: The number of retry attempts for failed jobs. + :type retry_count: Optional[RetryCount] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Build + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/orchestration/builds/create", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "target": target, + "branchName": branch_name, + "fallbackBranches": fallback_branches, + "forceBuild": force_build, + "retryCount": retry_count, + "retryBackoffDuration": retry_backoff_duration, + "abortOnFailure": abort_on_failure, + "notificationsEnabled": notifications_enabled, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "target": BuildTargetDict, + "branchName": Optional[BranchName], + "fallbackBranches": FallbackBranches, + "forceBuild": Optional[ForceBuild], + "retryCount": Optional[RetryCount], + "retryBackoffDuration": Optional[RetryBackoffDurationDict], + "abortOnFailure": Optional[AbortOnFailure], + "notificationsEnabled": Optional[NotificationsEnabled], + }, + ), + response_type=Build, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + build_rid: BuildRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Build: + """ + Get the Build with the specified rid. + :param build_rid: buildRid + :type build_rid: BuildRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Build + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/orchestration/builds/{buildRid}", + query_params={ + "preview": preview, + }, + path_params={ + "buildRid": build_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Build, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/orchestration/client.py b/foundry/v2/orchestration/client.py new file mode 100644 index 00000000..d90c9f69 --- /dev/null +++ b/foundry/v2/orchestration/client.py @@ -0,0 +1,26 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry._core import Auth +from foundry.v2.orchestration.build import BuildClient +from foundry.v2.orchestration.schedule import ScheduleClient + + +class OrchestrationClient: + def __init__(self, auth: Auth, hostname: str): + self.Build = BuildClient(auth=auth, hostname=hostname) + self.Schedule = ScheduleClient(auth=auth, hostname=hostname) diff --git a/foundry/v2/orchestration/models/__init__.py b/foundry/v2/orchestration/models/__init__.py new file mode 100644 index 00000000..5e4d4fa4 --- /dev/null +++ b/foundry/v2/orchestration/models/__init__.py @@ -0,0 +1,164 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from foundry.v2.orchestration.models._abort_on_failure import AbortOnFailure +from foundry.v2.orchestration.models._action import Action +from foundry.v2.orchestration.models._action_dict import ActionDict +from foundry.v2.orchestration.models._and_trigger import AndTrigger +from foundry.v2.orchestration.models._and_trigger_dict import AndTriggerDict +from foundry.v2.orchestration.models._build import Build +from foundry.v2.orchestration.models._build_dict import BuildDict +from foundry.v2.orchestration.models._build_rid import BuildRid +from foundry.v2.orchestration.models._build_status import BuildStatus +from foundry.v2.orchestration.models._build_target import BuildTarget +from foundry.v2.orchestration.models._build_target_dict import BuildTargetDict +from foundry.v2.orchestration.models._connecting_target import ConnectingTarget +from foundry.v2.orchestration.models._connecting_target_dict import ConnectingTargetDict +from foundry.v2.orchestration.models._cron_expression import CronExpression +from foundry.v2.orchestration.models._dataset_updated_trigger import DatasetUpdatedTrigger # NOQA +from foundry.v2.orchestration.models._dataset_updated_trigger_dict import ( + DatasetUpdatedTriggerDict, +) # NOQA +from foundry.v2.orchestration.models._fallback_branches import FallbackBranches +from foundry.v2.orchestration.models._force_build import ForceBuild +from foundry.v2.orchestration.models._job_succeeded_trigger import JobSucceededTrigger +from foundry.v2.orchestration.models._job_succeeded_trigger_dict import ( + JobSucceededTriggerDict, +) # NOQA +from foundry.v2.orchestration.models._manual_target import ManualTarget +from foundry.v2.orchestration.models._manual_target_dict import ManualTargetDict +from foundry.v2.orchestration.models._media_set_updated_trigger import ( + MediaSetUpdatedTrigger, +) # NOQA +from foundry.v2.orchestration.models._media_set_updated_trigger_dict import ( + MediaSetUpdatedTriggerDict, +) # NOQA +from foundry.v2.orchestration.models._new_logic_trigger import NewLogicTrigger +from foundry.v2.orchestration.models._new_logic_trigger_dict import NewLogicTriggerDict +from foundry.v2.orchestration.models._notifications_enabled import NotificationsEnabled +from foundry.v2.orchestration.models._or_trigger import OrTrigger +from foundry.v2.orchestration.models._or_trigger_dict import OrTriggerDict +from foundry.v2.orchestration.models._project_scope import ProjectScope +from foundry.v2.orchestration.models._project_scope_dict import ProjectScopeDict +from foundry.v2.orchestration.models._retry_backoff_duration import RetryBackoffDuration +from foundry.v2.orchestration.models._retry_backoff_duration_dict import ( + RetryBackoffDurationDict, +) # NOQA +from foundry.v2.orchestration.models._retry_count import RetryCount +from foundry.v2.orchestration.models._schedule import Schedule +from foundry.v2.orchestration.models._schedule_dict import ScheduleDict +from foundry.v2.orchestration.models._schedule_paused import SchedulePaused +from foundry.v2.orchestration.models._schedule_rid import ScheduleRid +from foundry.v2.orchestration.models._schedule_run import ScheduleRun +from foundry.v2.orchestration.models._schedule_run_dict import ScheduleRunDict +from foundry.v2.orchestration.models._schedule_run_error import ScheduleRunError +from foundry.v2.orchestration.models._schedule_run_error_dict import ScheduleRunErrorDict # NOQA +from foundry.v2.orchestration.models._schedule_run_error_name import ScheduleRunErrorName # NOQA +from foundry.v2.orchestration.models._schedule_run_ignored import ScheduleRunIgnored +from foundry.v2.orchestration.models._schedule_run_ignored_dict import ( + ScheduleRunIgnoredDict, +) # NOQA +from foundry.v2.orchestration.models._schedule_run_result import ScheduleRunResult +from foundry.v2.orchestration.models._schedule_run_result_dict import ScheduleRunResultDict # NOQA +from foundry.v2.orchestration.models._schedule_run_rid import ScheduleRunRid +from foundry.v2.orchestration.models._schedule_run_submitted import ScheduleRunSubmitted +from foundry.v2.orchestration.models._schedule_run_submitted_dict import ( + ScheduleRunSubmittedDict, +) # NOQA +from foundry.v2.orchestration.models._schedule_succeeded_trigger import ( + ScheduleSucceededTrigger, +) # NOQA +from foundry.v2.orchestration.models._schedule_succeeded_trigger_dict import ( + ScheduleSucceededTriggerDict, +) # NOQA +from foundry.v2.orchestration.models._schedule_version_rid import ScheduleVersionRid +from foundry.v2.orchestration.models._scope_mode import ScopeMode +from foundry.v2.orchestration.models._scope_mode_dict import ScopeModeDict +from foundry.v2.orchestration.models._time_trigger import TimeTrigger +from foundry.v2.orchestration.models._time_trigger_dict import TimeTriggerDict +from foundry.v2.orchestration.models._trigger import Trigger +from foundry.v2.orchestration.models._trigger_dict import TriggerDict +from foundry.v2.orchestration.models._upstream_target import UpstreamTarget +from foundry.v2.orchestration.models._upstream_target_dict import UpstreamTargetDict +from foundry.v2.orchestration.models._user_scope import UserScope +from foundry.v2.orchestration.models._user_scope_dict import UserScopeDict +from foundry.v2.orchestration.models._zone_id import ZoneId + +__all__ = [ + "AbortOnFailure", + "Action", + "ActionDict", + "AndTrigger", + "AndTriggerDict", + "Build", + "BuildDict", + "BuildRid", + "BuildStatus", + "BuildTarget", + "BuildTargetDict", + "ConnectingTarget", + "ConnectingTargetDict", + "CronExpression", + "DatasetUpdatedTrigger", + "DatasetUpdatedTriggerDict", + "FallbackBranches", + "ForceBuild", + "JobSucceededTrigger", + "JobSucceededTriggerDict", + "ManualTarget", + "ManualTargetDict", + "MediaSetUpdatedTrigger", + "MediaSetUpdatedTriggerDict", + "NewLogicTrigger", + "NewLogicTriggerDict", + "NotificationsEnabled", + "OrTrigger", + "OrTriggerDict", + "ProjectScope", + "ProjectScopeDict", + "RetryBackoffDuration", + "RetryBackoffDurationDict", + "RetryCount", + "Schedule", + "ScheduleDict", + "SchedulePaused", + "ScheduleRid", + "ScheduleRun", + "ScheduleRunDict", + "ScheduleRunError", + "ScheduleRunErrorDict", + "ScheduleRunErrorName", + "ScheduleRunIgnored", + "ScheduleRunIgnoredDict", + "ScheduleRunResult", + "ScheduleRunResultDict", + "ScheduleRunRid", + "ScheduleRunSubmitted", + "ScheduleRunSubmittedDict", + "ScheduleSucceededTrigger", + "ScheduleSucceededTriggerDict", + "ScheduleVersionRid", + "ScopeMode", + "ScopeModeDict", + "TimeTrigger", + "TimeTriggerDict", + "Trigger", + "TriggerDict", + "UpstreamTarget", + "UpstreamTargetDict", + "UserScope", + "UserScopeDict", + "ZoneId", +] diff --git a/foundry/v2/models/_abort_on_failure.py b/foundry/v2/orchestration/models/_abort_on_failure.py similarity index 100% rename from foundry/v2/models/_abort_on_failure.py rename to foundry/v2/orchestration/models/_abort_on_failure.py diff --git a/foundry/v2/orchestration/models/_action.py b/foundry/v2/orchestration/models/_action.py new file mode 100644 index 00000000..ef630ef7 --- /dev/null +++ b/foundry/v2/orchestration/models/_action.py @@ -0,0 +1,61 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.orchestration.models._abort_on_failure import AbortOnFailure +from foundry.v2.orchestration.models._action_dict import ActionDict +from foundry.v2.orchestration.models._build_target import BuildTarget +from foundry.v2.orchestration.models._fallback_branches import FallbackBranches +from foundry.v2.orchestration.models._force_build import ForceBuild +from foundry.v2.orchestration.models._notifications_enabled import NotificationsEnabled +from foundry.v2.orchestration.models._retry_backoff_duration import RetryBackoffDuration +from foundry.v2.orchestration.models._retry_count import RetryCount + + +class Action(BaseModel): + """Action""" + + target: BuildTarget + + branch_name: BranchName = Field(alias="branchName") + """The target branch the schedule should run on.""" + + fallback_branches: FallbackBranches = Field(alias="fallbackBranches") + + force_build: ForceBuild = Field(alias="forceBuild") + + retry_count: Optional[RetryCount] = Field(alias="retryCount", default=None) + + retry_backoff_duration: Optional[RetryBackoffDuration] = Field( + alias="retryBackoffDuration", default=None + ) + + abort_on_failure: AbortOnFailure = Field(alias="abortOnFailure") + + notifications_enabled: NotificationsEnabled = Field(alias="notificationsEnabled") + + model_config = {"extra": "allow"} + + def to_dict(self) -> ActionDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ActionDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/orchestration/models/_action_dict.py b/foundry/v2/orchestration/models/_action_dict.py new file mode 100644 index 00000000..43fc0fc9 --- /dev/null +++ b/foundry/v2/orchestration/models/_action_dict.py @@ -0,0 +1,53 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.orchestration.models._abort_on_failure import AbortOnFailure +from foundry.v2.orchestration.models._build_target_dict import BuildTargetDict +from foundry.v2.orchestration.models._fallback_branches import FallbackBranches +from foundry.v2.orchestration.models._force_build import ForceBuild +from foundry.v2.orchestration.models._notifications_enabled import NotificationsEnabled +from foundry.v2.orchestration.models._retry_backoff_duration_dict import ( + RetryBackoffDurationDict, +) # NOQA +from foundry.v2.orchestration.models._retry_count import RetryCount + + +class ActionDict(TypedDict): + """Action""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + target: BuildTargetDict + + branchName: BranchName + """The target branch the schedule should run on.""" + + fallbackBranches: FallbackBranches + + forceBuild: ForceBuild + + retryCount: NotRequired[RetryCount] + + retryBackoffDuration: NotRequired[RetryBackoffDurationDict] + + abortOnFailure: AbortOnFailure + + notificationsEnabled: NotificationsEnabled diff --git a/foundry/v2/orchestration/models/_and_trigger.py b/foundry/v2/orchestration/models/_and_trigger.py new file mode 100644 index 00000000..0d86e1ae --- /dev/null +++ b/foundry/v2/orchestration/models/_and_trigger.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.orchestration.models._and_trigger_dict import AndTriggerDict +from foundry.v2.orchestration.models._trigger import Trigger + + +class AndTrigger(BaseModel): + """Trigger after all of the given triggers emit an event.""" + + triggers: List[Trigger] + + type: Literal["and"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> AndTriggerDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(AndTriggerDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/orchestration/models/_and_trigger_dict.py b/foundry/v2/orchestration/models/_and_trigger_dict.py new file mode 100644 index 00000000..c846dd33 --- /dev/null +++ b/foundry/v2/orchestration/models/_and_trigger_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.orchestration.models._trigger_dict import TriggerDict + + +class AndTriggerDict(TypedDict): + """Trigger after all of the given triggers emit an event.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + triggers: List[TriggerDict] + + type: Literal["and"] diff --git a/foundry/v2/orchestration/models/_build.py b/foundry/v2/orchestration/models/_build.py new file mode 100644 index 00000000..e317f5c5 --- /dev/null +++ b/foundry/v2/orchestration/models/_build.py @@ -0,0 +1,64 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import cast + +from pydantic import BaseModel +from pydantic import Field + +from foundry.v2.core.models._created_by import CreatedBy +from foundry.v2.core.models._created_time import CreatedTime +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.orchestration.models._abort_on_failure import AbortOnFailure +from foundry.v2.orchestration.models._build_dict import BuildDict +from foundry.v2.orchestration.models._build_rid import BuildRid +from foundry.v2.orchestration.models._build_status import BuildStatus +from foundry.v2.orchestration.models._fallback_branches import FallbackBranches +from foundry.v2.orchestration.models._retry_backoff_duration import RetryBackoffDuration +from foundry.v2.orchestration.models._retry_count import RetryCount + + +class Build(BaseModel): + """Build""" + + rid: BuildRid + """The RID of a build""" + + branch_name: BranchName = Field(alias="branchName") + """The branch that the build is running on.""" + + created_time: CreatedTime = Field(alias="createdTime") + """The timestamp that the build was created.""" + + created_by: CreatedBy = Field(alias="createdBy") + """The user who created the build.""" + + fallback_branches: FallbackBranches = Field(alias="fallbackBranches") + + retry_count: RetryCount = Field(alias="retryCount") + + retry_backoff_duration: RetryBackoffDuration = Field(alias="retryBackoffDuration") + + abort_on_failure: AbortOnFailure = Field(alias="abortOnFailure") + + status: BuildStatus + + model_config = {"extra": "allow"} + + def to_dict(self) -> BuildDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(BuildDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/orchestration/models/_build_dict.py b/foundry/v2/orchestration/models/_build_dict.py new file mode 100644 index 00000000..5ebe1561 --- /dev/null +++ b/foundry/v2/orchestration/models/_build_dict.py @@ -0,0 +1,58 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import TypedDict + +from foundry.v2.core.models._created_by import CreatedBy +from foundry.v2.core.models._created_time import CreatedTime +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.orchestration.models._abort_on_failure import AbortOnFailure +from foundry.v2.orchestration.models._build_rid import BuildRid +from foundry.v2.orchestration.models._build_status import BuildStatus +from foundry.v2.orchestration.models._fallback_branches import FallbackBranches +from foundry.v2.orchestration.models._retry_backoff_duration_dict import ( + RetryBackoffDurationDict, +) # NOQA +from foundry.v2.orchestration.models._retry_count import RetryCount + + +class BuildDict(TypedDict): + """Build""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + rid: BuildRid + """The RID of a build""" + + branchName: BranchName + """The branch that the build is running on.""" + + createdTime: CreatedTime + """The timestamp that the build was created.""" + + createdBy: CreatedBy + """The user who created the build.""" + + fallbackBranches: FallbackBranches + + retryCount: RetryCount + + retryBackoffDuration: RetryBackoffDurationDict + + abortOnFailure: AbortOnFailure + + status: BuildStatus diff --git a/foundry/v2/models/_build_rid.py b/foundry/v2/orchestration/models/_build_rid.py similarity index 100% rename from foundry/v2/models/_build_rid.py rename to foundry/v2/orchestration/models/_build_rid.py diff --git a/foundry/v2/models/_build_status.py b/foundry/v2/orchestration/models/_build_status.py similarity index 100% rename from foundry/v2/models/_build_status.py rename to foundry/v2/orchestration/models/_build_status.py diff --git a/foundry/v2/orchestration/models/_build_target.py b/foundry/v2/orchestration/models/_build_target.py new file mode 100644 index 00000000..cb08cf51 --- /dev/null +++ b/foundry/v2/orchestration/models/_build_target.py @@ -0,0 +1,30 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.orchestration.models._connecting_target import ConnectingTarget +from foundry.v2.orchestration.models._manual_target import ManualTarget +from foundry.v2.orchestration.models._upstream_target import UpstreamTarget + +BuildTarget = Annotated[ + Union[UpstreamTarget, ManualTarget, ConnectingTarget], Field(discriminator="type") +] +"""The targets of the build.""" diff --git a/foundry/v2/orchestration/models/_build_target_dict.py b/foundry/v2/orchestration/models/_build_target_dict.py new file mode 100644 index 00000000..5738722b --- /dev/null +++ b/foundry/v2/orchestration/models/_build_target_dict.py @@ -0,0 +1,30 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.orchestration.models._connecting_target_dict import ConnectingTargetDict +from foundry.v2.orchestration.models._manual_target_dict import ManualTargetDict +from foundry.v2.orchestration.models._upstream_target_dict import UpstreamTargetDict + +BuildTargetDict = Annotated[ + Union[UpstreamTargetDict, ManualTargetDict, ConnectingTargetDict], Field(discriminator="type") +] +"""The targets of the build.""" diff --git a/foundry/v2/models/_connecting_target.py b/foundry/v2/orchestration/models/_connecting_target.py similarity index 91% rename from foundry/v2/models/_connecting_target.py rename to foundry/v2/orchestration/models/_connecting_target.py index 9876406e..d9df857e 100644 --- a/foundry/v2/models/_connecting_target.py +++ b/foundry/v2/orchestration/models/_connecting_target.py @@ -22,8 +22,8 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._connecting_target_dict import ConnectingTargetDict -from foundry.v2.models._dataset_rid import DatasetRid +from foundry.v2.datasets.models._dataset_rid import DatasetRid +from foundry.v2.orchestration.models._connecting_target_dict import ConnectingTargetDict class ConnectingTarget(BaseModel): diff --git a/foundry/v2/models/_connecting_target_dict.py b/foundry/v2/orchestration/models/_connecting_target_dict.py similarity index 95% rename from foundry/v2/models/_connecting_target_dict.py rename to foundry/v2/orchestration/models/_connecting_target_dict.py index fa494c63..1250aba2 100644 --- a/foundry/v2/models/_connecting_target_dict.py +++ b/foundry/v2/orchestration/models/_connecting_target_dict.py @@ -20,7 +20,7 @@ from typing_extensions import TypedDict -from foundry.v2.models._dataset_rid import DatasetRid +from foundry.v2.datasets.models._dataset_rid import DatasetRid class ConnectingTargetDict(TypedDict): diff --git a/foundry/v2/models/_cron_expression.py b/foundry/v2/orchestration/models/_cron_expression.py similarity index 100% rename from foundry/v2/models/_cron_expression.py rename to foundry/v2/orchestration/models/_cron_expression.py diff --git a/foundry/v2/models/_dataset_updated_trigger.py b/foundry/v2/orchestration/models/_dataset_updated_trigger.py similarity index 84% rename from foundry/v2/models/_dataset_updated_trigger.py rename to foundry/v2/orchestration/models/_dataset_updated_trigger.py index 35d7c91d..c8edde04 100644 --- a/foundry/v2/models/_dataset_updated_trigger.py +++ b/foundry/v2/orchestration/models/_dataset_updated_trigger.py @@ -21,9 +21,11 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._dataset_rid import DatasetRid -from foundry.v2.models._dataset_updated_trigger_dict import DatasetUpdatedTriggerDict +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._dataset_rid import DatasetRid +from foundry.v2.orchestration.models._dataset_updated_trigger_dict import ( + DatasetUpdatedTriggerDict, +) # NOQA class DatasetUpdatedTrigger(BaseModel): diff --git a/foundry/v2/models/_dataset_updated_trigger_dict.py b/foundry/v2/orchestration/models/_dataset_updated_trigger_dict.py similarity index 88% rename from foundry/v2/models/_dataset_updated_trigger_dict.py rename to foundry/v2/orchestration/models/_dataset_updated_trigger_dict.py index 70973b9e..7745f782 100644 --- a/foundry/v2/models/_dataset_updated_trigger_dict.py +++ b/foundry/v2/orchestration/models/_dataset_updated_trigger_dict.py @@ -19,8 +19,8 @@ from typing_extensions import TypedDict -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._dataset_rid import DatasetRid +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._dataset_rid import DatasetRid class DatasetUpdatedTriggerDict(TypedDict): diff --git a/foundry/v2/models/_fallback_branches.py b/foundry/v2/orchestration/models/_fallback_branches.py similarity index 92% rename from foundry/v2/models/_fallback_branches.py rename to foundry/v2/orchestration/models/_fallback_branches.py index 28717bfa..79c8464e 100644 --- a/foundry/v2/models/_fallback_branches.py +++ b/foundry/v2/orchestration/models/_fallback_branches.py @@ -17,7 +17,7 @@ from typing import List -from foundry.v2.models._branch_name import BranchName +from foundry.v2.datasets.models._branch_name import BranchName FallbackBranches = List[BranchName] """ diff --git a/foundry/v2/models/_force_build.py b/foundry/v2/orchestration/models/_force_build.py similarity index 100% rename from foundry/v2/models/_force_build.py rename to foundry/v2/orchestration/models/_force_build.py diff --git a/foundry/v2/models/_job_succeeded_trigger.py b/foundry/v2/orchestration/models/_job_succeeded_trigger.py similarity index 84% rename from foundry/v2/models/_job_succeeded_trigger.py rename to foundry/v2/orchestration/models/_job_succeeded_trigger.py index 36f208d6..d4a6b080 100644 --- a/foundry/v2/models/_job_succeeded_trigger.py +++ b/foundry/v2/orchestration/models/_job_succeeded_trigger.py @@ -21,9 +21,11 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._dataset_rid import DatasetRid -from foundry.v2.models._job_succeeded_trigger_dict import JobSucceededTriggerDict +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._dataset_rid import DatasetRid +from foundry.v2.orchestration.models._job_succeeded_trigger_dict import ( + JobSucceededTriggerDict, +) # NOQA class JobSucceededTrigger(BaseModel): diff --git a/foundry/v2/models/_job_succeeded_trigger_dict.py b/foundry/v2/orchestration/models/_job_succeeded_trigger_dict.py similarity index 88% rename from foundry/v2/models/_job_succeeded_trigger_dict.py rename to foundry/v2/orchestration/models/_job_succeeded_trigger_dict.py index 6e3c98f1..22788eae 100644 --- a/foundry/v2/models/_job_succeeded_trigger_dict.py +++ b/foundry/v2/orchestration/models/_job_succeeded_trigger_dict.py @@ -19,8 +19,8 @@ from typing_extensions import TypedDict -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._dataset_rid import DatasetRid +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._dataset_rid import DatasetRid class JobSucceededTriggerDict(TypedDict): diff --git a/foundry/v2/models/_manual_target.py b/foundry/v2/orchestration/models/_manual_target.py similarity index 89% rename from foundry/v2/models/_manual_target.py rename to foundry/v2/orchestration/models/_manual_target.py index c0e05bbb..3e0cd51f 100644 --- a/foundry/v2/models/_manual_target.py +++ b/foundry/v2/orchestration/models/_manual_target.py @@ -22,8 +22,8 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._dataset_rid import DatasetRid -from foundry.v2.models._manual_target_dict import ManualTargetDict +from foundry.v2.datasets.models._dataset_rid import DatasetRid +from foundry.v2.orchestration.models._manual_target_dict import ManualTargetDict class ManualTarget(BaseModel): diff --git a/foundry/v2/models/_manual_target_dict.py b/foundry/v2/orchestration/models/_manual_target_dict.py similarity index 93% rename from foundry/v2/models/_manual_target_dict.py rename to foundry/v2/orchestration/models/_manual_target_dict.py index ebf53307..55f49842 100644 --- a/foundry/v2/models/_manual_target_dict.py +++ b/foundry/v2/orchestration/models/_manual_target_dict.py @@ -20,7 +20,7 @@ from typing_extensions import TypedDict -from foundry.v2.models._dataset_rid import DatasetRid +from foundry.v2.datasets.models._dataset_rid import DatasetRid class ManualTargetDict(TypedDict): diff --git a/foundry/v2/models/_media_set_updated_trigger.py b/foundry/v2/orchestration/models/_media_set_updated_trigger.py similarity index 86% rename from foundry/v2/models/_media_set_updated_trigger.py rename to foundry/v2/orchestration/models/_media_set_updated_trigger.py index 9208beb8..76dce08f 100644 --- a/foundry/v2/models/_media_set_updated_trigger.py +++ b/foundry/v2/orchestration/models/_media_set_updated_trigger.py @@ -21,9 +21,11 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._media_set_rid import MediaSetRid -from foundry.v2.models._media_set_updated_trigger_dict import MediaSetUpdatedTriggerDict +from foundry.v2.core.models._media_set_rid import MediaSetRid +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.orchestration.models._media_set_updated_trigger_dict import ( + MediaSetUpdatedTriggerDict, +) # NOQA class MediaSetUpdatedTrigger(BaseModel): diff --git a/foundry/v2/models/_media_set_updated_trigger_dict.py b/foundry/v2/orchestration/models/_media_set_updated_trigger_dict.py similarity index 90% rename from foundry/v2/models/_media_set_updated_trigger_dict.py rename to foundry/v2/orchestration/models/_media_set_updated_trigger_dict.py index ee950bdd..d0f8c173 100644 --- a/foundry/v2/models/_media_set_updated_trigger_dict.py +++ b/foundry/v2/orchestration/models/_media_set_updated_trigger_dict.py @@ -19,8 +19,8 @@ from typing_extensions import TypedDict -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._media_set_rid import MediaSetRid +from foundry.v2.core.models._media_set_rid import MediaSetRid +from foundry.v2.datasets.models._branch_name import BranchName class MediaSetUpdatedTriggerDict(TypedDict): diff --git a/foundry/v2/models/_new_logic_trigger.py b/foundry/v2/orchestration/models/_new_logic_trigger.py similarity index 85% rename from foundry/v2/models/_new_logic_trigger.py rename to foundry/v2/orchestration/models/_new_logic_trigger.py index e10832d4..e8f9ee16 100644 --- a/foundry/v2/models/_new_logic_trigger.py +++ b/foundry/v2/orchestration/models/_new_logic_trigger.py @@ -21,9 +21,9 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._dataset_rid import DatasetRid -from foundry.v2.models._new_logic_trigger_dict import NewLogicTriggerDict +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._dataset_rid import DatasetRid +from foundry.v2.orchestration.models._new_logic_trigger_dict import NewLogicTriggerDict class NewLogicTrigger(BaseModel): diff --git a/foundry/v2/models/_new_logic_trigger_dict.py b/foundry/v2/orchestration/models/_new_logic_trigger_dict.py similarity index 88% rename from foundry/v2/models/_new_logic_trigger_dict.py rename to foundry/v2/orchestration/models/_new_logic_trigger_dict.py index 6efd3a7a..97236c3d 100644 --- a/foundry/v2/models/_new_logic_trigger_dict.py +++ b/foundry/v2/orchestration/models/_new_logic_trigger_dict.py @@ -19,8 +19,8 @@ from typing_extensions import TypedDict -from foundry.v2.models._branch_name import BranchName -from foundry.v2.models._dataset_rid import DatasetRid +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._dataset_rid import DatasetRid class NewLogicTriggerDict(TypedDict): diff --git a/foundry/v2/models/_notifications_enabled.py b/foundry/v2/orchestration/models/_notifications_enabled.py similarity index 100% rename from foundry/v2/models/_notifications_enabled.py rename to foundry/v2/orchestration/models/_notifications_enabled.py diff --git a/foundry/v2/orchestration/models/_or_trigger.py b/foundry/v2/orchestration/models/_or_trigger.py new file mode 100644 index 00000000..00ed792f --- /dev/null +++ b/foundry/v2/orchestration/models/_or_trigger.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import cast + +from pydantic import BaseModel + +from foundry.v2.orchestration.models._or_trigger_dict import OrTriggerDict +from foundry.v2.orchestration.models._trigger import Trigger + + +class OrTrigger(BaseModel): + """Trigger whenever any of the given triggers emit an event.""" + + triggers: List[Trigger] + + type: Literal["or"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OrTriggerDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OrTriggerDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/orchestration/models/_or_trigger_dict.py b/foundry/v2/orchestration/models/_or_trigger_dict.py new file mode 100644 index 00000000..0ea02f86 --- /dev/null +++ b/foundry/v2/orchestration/models/_or_trigger_dict.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.orchestration.models._trigger_dict import TriggerDict + + +class OrTriggerDict(TypedDict): + """Trigger whenever any of the given triggers emit an event.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + triggers: List[TriggerDict] + + type: Literal["or"] diff --git a/foundry/v2/models/_project_scope.py b/foundry/v2/orchestration/models/_project_scope.py similarity index 89% rename from foundry/v2/models/_project_scope.py rename to foundry/v2/orchestration/models/_project_scope.py index 895831e4..d0fd3225 100644 --- a/foundry/v2/models/_project_scope.py +++ b/foundry/v2/orchestration/models/_project_scope.py @@ -22,8 +22,8 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._project_rid import ProjectRid -from foundry.v2.models._project_scope_dict import ProjectScopeDict +from foundry.v2.filesystem.models._project_rid import ProjectRid +from foundry.v2.orchestration.models._project_scope_dict import ProjectScopeDict class ProjectScope(BaseModel): diff --git a/foundry/v2/models/_project_scope_dict.py b/foundry/v2/orchestration/models/_project_scope_dict.py similarity index 93% rename from foundry/v2/models/_project_scope_dict.py rename to foundry/v2/orchestration/models/_project_scope_dict.py index 8a592e44..131934d9 100644 --- a/foundry/v2/models/_project_scope_dict.py +++ b/foundry/v2/orchestration/models/_project_scope_dict.py @@ -20,7 +20,7 @@ from typing_extensions import TypedDict -from foundry.v2.models._project_rid import ProjectRid +from foundry.v2.filesystem.models._project_rid import ProjectRid class ProjectScopeDict(TypedDict): diff --git a/foundry/v2/models/_retry_backoff_duration.py b/foundry/v2/orchestration/models/_retry_backoff_duration.py similarity index 93% rename from foundry/v2/models/_retry_backoff_duration.py rename to foundry/v2/orchestration/models/_retry_backoff_duration.py index 05a607a0..b9a238de 100644 --- a/foundry/v2/models/_retry_backoff_duration.py +++ b/foundry/v2/orchestration/models/_retry_backoff_duration.py @@ -15,7 +15,7 @@ from __future__ import annotations -from foundry.v2.models._duration import Duration +from foundry.v2.core.models._duration import Duration RetryBackoffDuration = Duration """The duration to wait before retrying after a Job fails.""" diff --git a/foundry/v2/models/_retry_backoff_duration_dict.py b/foundry/v2/orchestration/models/_retry_backoff_duration_dict.py similarity index 92% rename from foundry/v2/models/_retry_backoff_duration_dict.py rename to foundry/v2/orchestration/models/_retry_backoff_duration_dict.py index 73d5317d..5923b03b 100644 --- a/foundry/v2/models/_retry_backoff_duration_dict.py +++ b/foundry/v2/orchestration/models/_retry_backoff_duration_dict.py @@ -15,7 +15,7 @@ from __future__ import annotations -from foundry.v2.models._duration_dict import DurationDict +from foundry.v2.core.models._duration_dict import DurationDict RetryBackoffDurationDict = DurationDict """The duration to wait before retrying after a Job fails.""" diff --git a/foundry/v2/models/_retry_count.py b/foundry/v2/orchestration/models/_retry_count.py similarity index 100% rename from foundry/v2/models/_retry_count.py rename to foundry/v2/orchestration/models/_retry_count.py diff --git a/foundry/v2/orchestration/models/_schedule.py b/foundry/v2/orchestration/models/_schedule.py new file mode 100644 index 00000000..6fdc1939 --- /dev/null +++ b/foundry/v2/orchestration/models/_schedule.py @@ -0,0 +1,74 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from pydantic import StrictStr + +from foundry.v2.core.models._created_by import CreatedBy +from foundry.v2.core.models._created_time import CreatedTime +from foundry.v2.core.models._updated_by import UpdatedBy +from foundry.v2.core.models._updated_time import UpdatedTime +from foundry.v2.orchestration.models._action import Action +from foundry.v2.orchestration.models._schedule_dict import ScheduleDict +from foundry.v2.orchestration.models._schedule_paused import SchedulePaused +from foundry.v2.orchestration.models._schedule_rid import ScheduleRid +from foundry.v2.orchestration.models._schedule_version_rid import ScheduleVersionRid +from foundry.v2.orchestration.models._scope_mode import ScopeMode +from foundry.v2.orchestration.models._trigger import Trigger + + +class Schedule(BaseModel): + """Schedule""" + + rid: ScheduleRid + + display_name: Optional[StrictStr] = Field(alias="displayName", default=None) + + description: Optional[StrictStr] = None + + current_version_rid: ScheduleVersionRid = Field(alias="currentVersionRid") + """The RID of the current schedule version""" + + created_time: CreatedTime = Field(alias="createdTime") + + created_by: CreatedBy = Field(alias="createdBy") + + updated_time: UpdatedTime = Field(alias="updatedTime") + + updated_by: UpdatedBy = Field(alias="updatedBy") + + paused: SchedulePaused + + trigger: Optional[Trigger] = None + """ + The schedule trigger. If the requesting user does not have + permission to see the trigger, this will be empty. + """ + + action: Action + + scope_mode: ScopeMode = Field(alias="scopeMode") + + model_config = {"extra": "allow"} + + def to_dict(self) -> ScheduleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(ScheduleDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/orchestration/models/_schedule_dict.py b/foundry/v2/orchestration/models/_schedule_dict.py new file mode 100644 index 00000000..0e130d68 --- /dev/null +++ b/foundry/v2/orchestration/models/_schedule_dict.py @@ -0,0 +1,66 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from pydantic import StrictStr +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.core.models._created_by import CreatedBy +from foundry.v2.core.models._created_time import CreatedTime +from foundry.v2.core.models._updated_by import UpdatedBy +from foundry.v2.core.models._updated_time import UpdatedTime +from foundry.v2.orchestration.models._action_dict import ActionDict +from foundry.v2.orchestration.models._schedule_paused import SchedulePaused +from foundry.v2.orchestration.models._schedule_rid import ScheduleRid +from foundry.v2.orchestration.models._schedule_version_rid import ScheduleVersionRid +from foundry.v2.orchestration.models._scope_mode_dict import ScopeModeDict +from foundry.v2.orchestration.models._trigger_dict import TriggerDict + + +class ScheduleDict(TypedDict): + """Schedule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + rid: ScheduleRid + + displayName: NotRequired[StrictStr] + + description: NotRequired[StrictStr] + + currentVersionRid: ScheduleVersionRid + """The RID of the current schedule version""" + + createdTime: CreatedTime + + createdBy: CreatedBy + + updatedTime: UpdatedTime + + updatedBy: UpdatedBy + + paused: SchedulePaused + + trigger: NotRequired[TriggerDict] + """ + The schedule trigger. If the requesting user does not have + permission to see the trigger, this will be empty. + """ + + action: ActionDict + + scopeMode: ScopeModeDict diff --git a/foundry/v2/models/_schedule_paused.py b/foundry/v2/orchestration/models/_schedule_paused.py similarity index 100% rename from foundry/v2/models/_schedule_paused.py rename to foundry/v2/orchestration/models/_schedule_paused.py diff --git a/foundry/v2/models/_schedule_rid.py b/foundry/v2/orchestration/models/_schedule_rid.py similarity index 100% rename from foundry/v2/models/_schedule_rid.py rename to foundry/v2/orchestration/models/_schedule_rid.py diff --git a/foundry/v2/models/_schedule_run.py b/foundry/v2/orchestration/models/_schedule_run.py similarity index 77% rename from foundry/v2/models/_schedule_run.py rename to foundry/v2/orchestration/models/_schedule_run.py index af76f131..ad625018 100644 --- a/foundry/v2/models/_schedule_run.py +++ b/foundry/v2/orchestration/models/_schedule_run.py @@ -21,13 +21,13 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._created_by import CreatedBy -from foundry.v2.models._created_time import CreatedTime -from foundry.v2.models._schedule_rid import ScheduleRid -from foundry.v2.models._schedule_run_dict import ScheduleRunDict -from foundry.v2.models._schedule_run_result import ScheduleRunResult -from foundry.v2.models._schedule_run_rid import ScheduleRunRid -from foundry.v2.models._schedule_version_rid import ScheduleVersionRid +from foundry.v2.core.models._created_by import CreatedBy +from foundry.v2.core.models._created_time import CreatedTime +from foundry.v2.orchestration.models._schedule_rid import ScheduleRid +from foundry.v2.orchestration.models._schedule_run_dict import ScheduleRunDict +from foundry.v2.orchestration.models._schedule_run_result import ScheduleRunResult +from foundry.v2.orchestration.models._schedule_run_rid import ScheduleRunRid +from foundry.v2.orchestration.models._schedule_version_rid import ScheduleVersionRid class ScheduleRun(BaseModel): diff --git a/foundry/v2/models/_schedule_run_dict.py b/foundry/v2/orchestration/models/_schedule_run_dict.py similarity index 76% rename from foundry/v2/models/_schedule_run_dict.py rename to foundry/v2/orchestration/models/_schedule_run_dict.py index a8b36826..adea7eeb 100644 --- a/foundry/v2/models/_schedule_run_dict.py +++ b/foundry/v2/orchestration/models/_schedule_run_dict.py @@ -18,12 +18,12 @@ from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v2.models._created_by import CreatedBy -from foundry.v2.models._created_time import CreatedTime -from foundry.v2.models._schedule_rid import ScheduleRid -from foundry.v2.models._schedule_run_result_dict import ScheduleRunResultDict -from foundry.v2.models._schedule_run_rid import ScheduleRunRid -from foundry.v2.models._schedule_version_rid import ScheduleVersionRid +from foundry.v2.core.models._created_by import CreatedBy +from foundry.v2.core.models._created_time import CreatedTime +from foundry.v2.orchestration.models._schedule_rid import ScheduleRid +from foundry.v2.orchestration.models._schedule_run_result_dict import ScheduleRunResultDict # NOQA +from foundry.v2.orchestration.models._schedule_run_rid import ScheduleRunRid +from foundry.v2.orchestration.models._schedule_version_rid import ScheduleVersionRid class ScheduleRunDict(TypedDict): diff --git a/foundry/v2/models/_schedule_run_error.py b/foundry/v2/orchestration/models/_schedule_run_error.py similarity index 86% rename from foundry/v2/models/_schedule_run_error.py rename to foundry/v2/orchestration/models/_schedule_run_error.py index 99f3cc87..6b4192b0 100644 --- a/foundry/v2/models/_schedule_run_error.py +++ b/foundry/v2/orchestration/models/_schedule_run_error.py @@ -22,8 +22,8 @@ from pydantic import Field from pydantic import StrictStr -from foundry.v2.models._schedule_run_error_dict import ScheduleRunErrorDict -from foundry.v2.models._schedule_run_error_name import ScheduleRunErrorName +from foundry.v2.orchestration.models._schedule_run_error_dict import ScheduleRunErrorDict # NOQA +from foundry.v2.orchestration.models._schedule_run_error_name import ScheduleRunErrorName # NOQA class ScheduleRunError(BaseModel): diff --git a/foundry/v2/models/_schedule_run_error_dict.py b/foundry/v2/orchestration/models/_schedule_run_error_dict.py similarity index 91% rename from foundry/v2/models/_schedule_run_error_dict.py rename to foundry/v2/orchestration/models/_schedule_run_error_dict.py index 1ef3b12b..5fcad5b4 100644 --- a/foundry/v2/models/_schedule_run_error_dict.py +++ b/foundry/v2/orchestration/models/_schedule_run_error_dict.py @@ -20,7 +20,7 @@ from pydantic import StrictStr from typing_extensions import TypedDict -from foundry.v2.models._schedule_run_error_name import ScheduleRunErrorName +from foundry.v2.orchestration.models._schedule_run_error_name import ScheduleRunErrorName # NOQA class ScheduleRunErrorDict(TypedDict): diff --git a/foundry/v2/models/_schedule_run_error_name.py b/foundry/v2/orchestration/models/_schedule_run_error_name.py similarity index 100% rename from foundry/v2/models/_schedule_run_error_name.py rename to foundry/v2/orchestration/models/_schedule_run_error_name.py diff --git a/foundry/v2/models/_schedule_run_ignored.py b/foundry/v2/orchestration/models/_schedule_run_ignored.py similarity index 91% rename from foundry/v2/models/_schedule_run_ignored.py rename to foundry/v2/orchestration/models/_schedule_run_ignored.py index 83329b34..0fb78b2c 100644 --- a/foundry/v2/models/_schedule_run_ignored.py +++ b/foundry/v2/orchestration/models/_schedule_run_ignored.py @@ -20,7 +20,9 @@ from pydantic import BaseModel -from foundry.v2.models._schedule_run_ignored_dict import ScheduleRunIgnoredDict +from foundry.v2.orchestration.models._schedule_run_ignored_dict import ( + ScheduleRunIgnoredDict, +) # NOQA class ScheduleRunIgnored(BaseModel): diff --git a/foundry/v2/models/_schedule_run_ignored_dict.py b/foundry/v2/orchestration/models/_schedule_run_ignored_dict.py similarity index 100% rename from foundry/v2/models/_schedule_run_ignored_dict.py rename to foundry/v2/orchestration/models/_schedule_run_ignored_dict.py diff --git a/foundry/v2/orchestration/models/_schedule_run_result.py b/foundry/v2/orchestration/models/_schedule_run_result.py new file mode 100644 index 00000000..197810be --- /dev/null +++ b/foundry/v2/orchestration/models/_schedule_run_result.py @@ -0,0 +1,33 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.orchestration.models._schedule_run_error import ScheduleRunError +from foundry.v2.orchestration.models._schedule_run_ignored import ScheduleRunIgnored +from foundry.v2.orchestration.models._schedule_run_submitted import ScheduleRunSubmitted + +ScheduleRunResult = Annotated[ + Union[ScheduleRunIgnored, ScheduleRunSubmitted, ScheduleRunError], Field(discriminator="type") +] +""" +The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, +ignored if all targets are up-to-date or error. +""" diff --git a/foundry/v2/orchestration/models/_schedule_run_result_dict.py b/foundry/v2/orchestration/models/_schedule_run_result_dict.py new file mode 100644 index 00000000..28bbecd2 --- /dev/null +++ b/foundry/v2/orchestration/models/_schedule_run_result_dict.py @@ -0,0 +1,38 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.orchestration.models._schedule_run_error_dict import ScheduleRunErrorDict # NOQA +from foundry.v2.orchestration.models._schedule_run_ignored_dict import ( + ScheduleRunIgnoredDict, +) # NOQA +from foundry.v2.orchestration.models._schedule_run_submitted_dict import ( + ScheduleRunSubmittedDict, +) # NOQA + +ScheduleRunResultDict = Annotated[ + Union[ScheduleRunIgnoredDict, ScheduleRunSubmittedDict, ScheduleRunErrorDict], + Field(discriminator="type"), +] +""" +The result of attempting to trigger the schedule. The schedule run will either be submitted as a build, +ignored if all targets are up-to-date or error. +""" diff --git a/foundry/v2/models/_schedule_run_rid.py b/foundry/v2/orchestration/models/_schedule_run_rid.py similarity index 100% rename from foundry/v2/models/_schedule_run_rid.py rename to foundry/v2/orchestration/models/_schedule_run_rid.py diff --git a/foundry/v2/models/_schedule_run_submitted.py b/foundry/v2/orchestration/models/_schedule_run_submitted.py similarity index 87% rename from foundry/v2/models/_schedule_run_submitted.py rename to foundry/v2/orchestration/models/_schedule_run_submitted.py index 15dee87c..d9aafbbe 100644 --- a/foundry/v2/models/_schedule_run_submitted.py +++ b/foundry/v2/orchestration/models/_schedule_run_submitted.py @@ -21,8 +21,10 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._build_rid import BuildRid -from foundry.v2.models._schedule_run_submitted_dict import ScheduleRunSubmittedDict +from foundry.v2.orchestration.models._build_rid import BuildRid +from foundry.v2.orchestration.models._schedule_run_submitted_dict import ( + ScheduleRunSubmittedDict, +) # NOQA class ScheduleRunSubmitted(BaseModel): diff --git a/foundry/v2/models/_schedule_run_submitted_dict.py b/foundry/v2/orchestration/models/_schedule_run_submitted_dict.py similarity index 93% rename from foundry/v2/models/_schedule_run_submitted_dict.py rename to foundry/v2/orchestration/models/_schedule_run_submitted_dict.py index 64ca2fad..48014d36 100644 --- a/foundry/v2/models/_schedule_run_submitted_dict.py +++ b/foundry/v2/orchestration/models/_schedule_run_submitted_dict.py @@ -19,7 +19,7 @@ from typing_extensions import TypedDict -from foundry.v2.models._build_rid import BuildRid +from foundry.v2.orchestration.models._build_rid import BuildRid class ScheduleRunSubmittedDict(TypedDict): diff --git a/foundry/v2/models/_schedule_succeeded_trigger.py b/foundry/v2/orchestration/models/_schedule_succeeded_trigger.py similarity index 87% rename from foundry/v2/models/_schedule_succeeded_trigger.py rename to foundry/v2/orchestration/models/_schedule_succeeded_trigger.py index 3663cb88..b4a354a6 100644 --- a/foundry/v2/models/_schedule_succeeded_trigger.py +++ b/foundry/v2/orchestration/models/_schedule_succeeded_trigger.py @@ -21,8 +21,10 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._schedule_rid import ScheduleRid -from foundry.v2.models._schedule_succeeded_trigger_dict import ScheduleSucceededTriggerDict # NOQA +from foundry.v2.orchestration.models._schedule_rid import ScheduleRid +from foundry.v2.orchestration.models._schedule_succeeded_trigger_dict import ( + ScheduleSucceededTriggerDict, +) # NOQA class ScheduleSucceededTrigger(BaseModel): diff --git a/foundry/v2/models/_schedule_succeeded_trigger_dict.py b/foundry/v2/orchestration/models/_schedule_succeeded_trigger_dict.py similarity index 93% rename from foundry/v2/models/_schedule_succeeded_trigger_dict.py rename to foundry/v2/orchestration/models/_schedule_succeeded_trigger_dict.py index 4be5269c..378049bc 100644 --- a/foundry/v2/models/_schedule_succeeded_trigger_dict.py +++ b/foundry/v2/orchestration/models/_schedule_succeeded_trigger_dict.py @@ -19,7 +19,7 @@ from typing_extensions import TypedDict -from foundry.v2.models._schedule_rid import ScheduleRid +from foundry.v2.orchestration.models._schedule_rid import ScheduleRid class ScheduleSucceededTriggerDict(TypedDict): diff --git a/foundry/v2/models/_schedule_version_rid.py b/foundry/v2/orchestration/models/_schedule_version_rid.py similarity index 100% rename from foundry/v2/models/_schedule_version_rid.py rename to foundry/v2/orchestration/models/_schedule_version_rid.py diff --git a/foundry/v2/models/_scope_mode.py b/foundry/v2/orchestration/models/_scope_mode.py similarity index 75% rename from foundry/v2/models/_scope_mode.py rename to foundry/v2/orchestration/models/_scope_mode.py index a9d4475d..f8e52e08 100644 --- a/foundry/v2/models/_scope_mode.py +++ b/foundry/v2/orchestration/models/_scope_mode.py @@ -15,13 +15,13 @@ from __future__ import annotations -from typing import Annotated from typing import Union from pydantic import Field +from typing_extensions import Annotated -from foundry.v2.models._project_scope import ProjectScope -from foundry.v2.models._user_scope import UserScope +from foundry.v2.orchestration.models._project_scope import ProjectScope +from foundry.v2.orchestration.models._user_scope import UserScope -ScopeMode = Annotated[Union[UserScope, ProjectScope], Field(discriminator="type")] +ScopeMode = Annotated[Union[ProjectScope, UserScope], Field(discriminator="type")] """The boundaries for the schedule build.""" diff --git a/foundry/v2/orchestration/models/_scope_mode_dict.py b/foundry/v2/orchestration/models/_scope_mode_dict.py new file mode 100644 index 00000000..15dabde5 --- /dev/null +++ b/foundry/v2/orchestration/models/_scope_mode_dict.py @@ -0,0 +1,27 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.orchestration.models._project_scope_dict import ProjectScopeDict +from foundry.v2.orchestration.models._user_scope_dict import UserScopeDict + +ScopeModeDict = Annotated[Union[ProjectScopeDict, UserScopeDict], Field(discriminator="type")] +"""The boundaries for the schedule build.""" diff --git a/foundry/v2/models/_time_trigger.py b/foundry/v2/orchestration/models/_time_trigger.py similarity index 85% rename from foundry/v2/models/_time_trigger.py rename to foundry/v2/orchestration/models/_time_trigger.py index 9e40bc13..1f8d5e10 100644 --- a/foundry/v2/models/_time_trigger.py +++ b/foundry/v2/orchestration/models/_time_trigger.py @@ -21,9 +21,9 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._cron_expression import CronExpression -from foundry.v2.models._time_trigger_dict import TimeTriggerDict -from foundry.v2.models._zone_id import ZoneId +from foundry.v2.orchestration.models._cron_expression import CronExpression +from foundry.v2.orchestration.models._time_trigger_dict import TimeTriggerDict +from foundry.v2.orchestration.models._zone_id import ZoneId class TimeTrigger(BaseModel): diff --git a/foundry/v2/models/_time_trigger_dict.py b/foundry/v2/orchestration/models/_time_trigger_dict.py similarity index 87% rename from foundry/v2/models/_time_trigger_dict.py rename to foundry/v2/orchestration/models/_time_trigger_dict.py index 1d0a0587..745500bb 100644 --- a/foundry/v2/models/_time_trigger_dict.py +++ b/foundry/v2/orchestration/models/_time_trigger_dict.py @@ -19,8 +19,8 @@ from typing_extensions import TypedDict -from foundry.v2.models._cron_expression import CronExpression -from foundry.v2.models._zone_id import ZoneId +from foundry.v2.orchestration.models._cron_expression import CronExpression +from foundry.v2.orchestration.models._zone_id import ZoneId class TimeTriggerDict(TypedDict): diff --git a/foundry/v2/orchestration/models/_trigger.py b/foundry/v2/orchestration/models/_trigger.py new file mode 100644 index 00000000..1d5dfb22 --- /dev/null +++ b/foundry/v2/orchestration/models/_trigger.py @@ -0,0 +1,82 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import Union +from typing import cast + +from pydantic import BaseModel +from pydantic import Field +from typing_extensions import Annotated + +from foundry.v2.orchestration.models._and_trigger_dict import AndTriggerDict +from foundry.v2.orchestration.models._dataset_updated_trigger import DatasetUpdatedTrigger # NOQA +from foundry.v2.orchestration.models._job_succeeded_trigger import JobSucceededTrigger +from foundry.v2.orchestration.models._media_set_updated_trigger import ( + MediaSetUpdatedTrigger, +) # NOQA +from foundry.v2.orchestration.models._new_logic_trigger import NewLogicTrigger +from foundry.v2.orchestration.models._or_trigger_dict import OrTriggerDict +from foundry.v2.orchestration.models._schedule_succeeded_trigger import ( + ScheduleSucceededTrigger, +) # NOQA +from foundry.v2.orchestration.models._time_trigger import TimeTrigger + + +class OrTrigger(BaseModel): + """Trigger whenever any of the given triggers emit an event.""" + + triggers: List[Trigger] + + type: Literal["or"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> OrTriggerDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OrTriggerDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +class AndTrigger(BaseModel): + """Trigger after all of the given triggers emit an event.""" + + triggers: List[Trigger] + + type: Literal["and"] + + model_config = {"extra": "allow"} + + def to_dict(self) -> AndTriggerDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(AndTriggerDict, self.model_dump(by_alias=True, exclude_unset=True)) + + +Trigger = Annotated[ + Union[ + JobSucceededTrigger, + OrTrigger, + NewLogicTrigger, + AndTrigger, + DatasetUpdatedTrigger, + ScheduleSucceededTrigger, + MediaSetUpdatedTrigger, + TimeTrigger, + ], + Field(discriminator="type"), +] +"""Trigger""" diff --git a/foundry/v2/orchestration/models/_trigger_dict.py b/foundry/v2/orchestration/models/_trigger_dict.py new file mode 100644 index 00000000..c37c1082 --- /dev/null +++ b/foundry/v2/orchestration/models/_trigger_dict.py @@ -0,0 +1,75 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import List +from typing import Literal +from typing import Union + +from pydantic import Field +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry.v2.orchestration.models._dataset_updated_trigger_dict import ( + DatasetUpdatedTriggerDict, +) # NOQA +from foundry.v2.orchestration.models._job_succeeded_trigger_dict import ( + JobSucceededTriggerDict, +) # NOQA +from foundry.v2.orchestration.models._media_set_updated_trigger_dict import ( + MediaSetUpdatedTriggerDict, +) # NOQA +from foundry.v2.orchestration.models._new_logic_trigger_dict import NewLogicTriggerDict +from foundry.v2.orchestration.models._schedule_succeeded_trigger_dict import ( + ScheduleSucceededTriggerDict, +) # NOQA +from foundry.v2.orchestration.models._time_trigger_dict import TimeTriggerDict + + +class OrTriggerDict(TypedDict): + """Trigger whenever any of the given triggers emit an event.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + triggers: List[TriggerDict] + + type: Literal["or"] + + +class AndTriggerDict(TypedDict): + """Trigger after all of the given triggers emit an event.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + triggers: List[TriggerDict] + + type: Literal["and"] + + +TriggerDict = Annotated[ + Union[ + JobSucceededTriggerDict, + OrTriggerDict, + NewLogicTriggerDict, + AndTriggerDict, + DatasetUpdatedTriggerDict, + ScheduleSucceededTriggerDict, + MediaSetUpdatedTriggerDict, + TimeTriggerDict, + ], + Field(discriminator="type"), +] +"""Trigger""" diff --git a/foundry/v2/models/_upstream_target.py b/foundry/v2/orchestration/models/_upstream_target.py similarity index 90% rename from foundry/v2/models/_upstream_target.py rename to foundry/v2/orchestration/models/_upstream_target.py index da3ad251..916b739e 100644 --- a/foundry/v2/models/_upstream_target.py +++ b/foundry/v2/orchestration/models/_upstream_target.py @@ -22,8 +22,8 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._dataset_rid import DatasetRid -from foundry.v2.models._upstream_target_dict import UpstreamTargetDict +from foundry.v2.datasets.models._dataset_rid import DatasetRid +from foundry.v2.orchestration.models._upstream_target_dict import UpstreamTargetDict class UpstreamTarget(BaseModel): diff --git a/foundry/v2/models/_upstream_target_dict.py b/foundry/v2/orchestration/models/_upstream_target_dict.py similarity index 94% rename from foundry/v2/models/_upstream_target_dict.py rename to foundry/v2/orchestration/models/_upstream_target_dict.py index 8241e7c5..685e3048 100644 --- a/foundry/v2/models/_upstream_target_dict.py +++ b/foundry/v2/orchestration/models/_upstream_target_dict.py @@ -20,7 +20,7 @@ from typing_extensions import TypedDict -from foundry.v2.models._dataset_rid import DatasetRid +from foundry.v2.datasets.models._dataset_rid import DatasetRid class UpstreamTargetDict(TypedDict): diff --git a/foundry/v2/models/_user_scope.py b/foundry/v2/orchestration/models/_user_scope.py similarity index 93% rename from foundry/v2/models/_user_scope.py rename to foundry/v2/orchestration/models/_user_scope.py index 28f66dc2..6c5dbb55 100644 --- a/foundry/v2/models/_user_scope.py +++ b/foundry/v2/orchestration/models/_user_scope.py @@ -20,7 +20,7 @@ from pydantic import BaseModel -from foundry.v2.models._user_scope_dict import UserScopeDict +from foundry.v2.orchestration.models._user_scope_dict import UserScopeDict class UserScope(BaseModel): diff --git a/foundry/v2/models/_user_scope_dict.py b/foundry/v2/orchestration/models/_user_scope_dict.py similarity index 100% rename from foundry/v2/models/_user_scope_dict.py rename to foundry/v2/orchestration/models/_user_scope_dict.py diff --git a/foundry/v2/models/_zone_id.py b/foundry/v2/orchestration/models/_zone_id.py similarity index 100% rename from foundry/v2/models/_zone_id.py rename to foundry/v2/orchestration/models/_zone_id.py diff --git a/foundry/v2/orchestration/schedule.py b/foundry/v2/orchestration/schedule.py new file mode 100644 index 00000000..e33d4be8 --- /dev/null +++ b/foundry/v2/orchestration/schedule.py @@ -0,0 +1,199 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.orchestration.models._schedule import Schedule +from foundry.v2.orchestration.models._schedule_rid import ScheduleRid +from foundry.v2.orchestration.models._schedule_run import ScheduleRun + + +class ScheduleClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get( + self, + schedule_rid: ScheduleRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Schedule: + """ + Get the Schedule with the specified rid. + :param schedule_rid: scheduleRid + :type schedule_rid: ScheduleRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Schedule + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/orchestration/schedules/{scheduleRid}", + query_params={ + "preview": preview, + }, + path_params={ + "scheduleRid": schedule_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Schedule, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def pause( + self, + schedule_rid: ScheduleRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + + :param schedule_rid: scheduleRid + :type schedule_rid: ScheduleRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/orchestration/schedules/{scheduleRid}/pause", + query_params={ + "preview": preview, + }, + path_params={ + "scheduleRid": schedule_rid, + }, + header_params={}, + body=None, + body_type=None, + response_type=None, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def run( + self, + schedule_rid: ScheduleRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ScheduleRun: + """ + + :param schedule_rid: scheduleRid + :type schedule_rid: ScheduleRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ScheduleRun + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/orchestration/schedules/{scheduleRid}/run", + query_params={ + "preview": preview, + }, + path_params={ + "scheduleRid": schedule_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ScheduleRun, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def unpause( + self, + schedule_rid: ScheduleRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + + :param schedule_rid: scheduleRid + :type schedule_rid: ScheduleRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/orchestration/schedules/{scheduleRid}/unpause", + query_params={ + "preview": preview, + }, + path_params={ + "scheduleRid": schedule_rid, + }, + header_params={}, + body=None, + body_type=None, + response_type=None, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/third_party_applications/client.py b/foundry/v2/third_party_applications/client.py new file mode 100644 index 00000000..b87ba3ac --- /dev/null +++ b/foundry/v2/third_party_applications/client.py @@ -0,0 +1,26 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry._core import Auth +from foundry.v2.third_party_applications.third_party_application import ( + ThirdPartyApplicationClient, +) # NOQA + + +class ThirdPartyApplicationsClient: + def __init__(self, auth: Auth, hostname: str): + self.ThirdPartyApplication = ThirdPartyApplicationClient(auth=auth, hostname=hostname) diff --git a/foundry/v2/third_party_applications/models/__init__.py b/foundry/v2/third_party_applications/models/__init__.py new file mode 100644 index 00000000..52e57648 --- /dev/null +++ b/foundry/v2/third_party_applications/models/__init__.py @@ -0,0 +1,50 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from foundry.v2.third_party_applications.models._list_versions_response import ( + ListVersionsResponse, +) # NOQA +from foundry.v2.third_party_applications.models._list_versions_response_dict import ( + ListVersionsResponseDict, +) # NOQA +from foundry.v2.third_party_applications.models._subdomain import Subdomain +from foundry.v2.third_party_applications.models._third_party_application import ( + ThirdPartyApplication, +) # NOQA +from foundry.v2.third_party_applications.models._third_party_application_dict import ( + ThirdPartyApplicationDict, +) # NOQA +from foundry.v2.third_party_applications.models._third_party_application_rid import ( + ThirdPartyApplicationRid, +) # NOQA +from foundry.v2.third_party_applications.models._version import Version +from foundry.v2.third_party_applications.models._version_dict import VersionDict +from foundry.v2.third_party_applications.models._version_version import VersionVersion +from foundry.v2.third_party_applications.models._website import Website +from foundry.v2.third_party_applications.models._website_dict import WebsiteDict + +__all__ = [ + "ListVersionsResponse", + "ListVersionsResponseDict", + "Subdomain", + "ThirdPartyApplication", + "ThirdPartyApplicationDict", + "ThirdPartyApplicationRid", + "Version", + "VersionDict", + "VersionVersion", + "Website", + "WebsiteDict", +] diff --git a/foundry/v2/models/_list_versions_response.py b/foundry/v2/third_party_applications/models/_list_versions_response.py similarity index 82% rename from foundry/v2/models/_list_versions_response.py rename to foundry/v2/third_party_applications/models/_list_versions_response.py index 7877a011..9943e3e4 100644 --- a/foundry/v2/models/_list_versions_response.py +++ b/foundry/v2/third_party_applications/models/_list_versions_response.py @@ -22,9 +22,11 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._list_versions_response_dict import ListVersionsResponseDict -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._version import Version +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.third_party_applications.models._list_versions_response_dict import ( + ListVersionsResponseDict, +) # NOQA +from foundry.v2.third_party_applications.models._version import Version class ListVersionsResponse(BaseModel): diff --git a/foundry/v2/models/_list_versions_response_dict.py b/foundry/v2/third_party_applications/models/_list_versions_response_dict.py similarity index 87% rename from foundry/v2/models/_list_versions_response_dict.py rename to foundry/v2/third_party_applications/models/_list_versions_response_dict.py index 998c1a15..d7db93d5 100644 --- a/foundry/v2/models/_list_versions_response_dict.py +++ b/foundry/v2/third_party_applications/models/_list_versions_response_dict.py @@ -20,8 +20,8 @@ from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v2.models._page_token import PageToken -from foundry.v2.models._version_dict import VersionDict +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.third_party_applications.models._version_dict import VersionDict class ListVersionsResponseDict(TypedDict): diff --git a/foundry/v2/models/_subdomain.py b/foundry/v2/third_party_applications/models/_subdomain.py similarity index 100% rename from foundry/v2/models/_subdomain.py rename to foundry/v2/third_party_applications/models/_subdomain.py diff --git a/foundry/v2/models/_third_party_application.py b/foundry/v2/third_party_applications/models/_third_party_application.py similarity index 82% rename from foundry/v2/models/_third_party_application.py rename to foundry/v2/third_party_applications/models/_third_party_application.py index b7607aa4..d0d97ed4 100644 --- a/foundry/v2/models/_third_party_application.py +++ b/foundry/v2/third_party_applications/models/_third_party_application.py @@ -19,8 +19,12 @@ from pydantic import BaseModel -from foundry.v2.models._third_party_application_dict import ThirdPartyApplicationDict -from foundry.v2.models._third_party_application_rid import ThirdPartyApplicationRid +from foundry.v2.third_party_applications.models._third_party_application_dict import ( + ThirdPartyApplicationDict, +) # NOQA +from foundry.v2.third_party_applications.models._third_party_application_rid import ( + ThirdPartyApplicationRid, +) # NOQA class ThirdPartyApplication(BaseModel): diff --git a/foundry/v2/models/_third_party_application_dict.py b/foundry/v2/third_party_applications/models/_third_party_application_dict.py similarity index 88% rename from foundry/v2/models/_third_party_application_dict.py rename to foundry/v2/third_party_applications/models/_third_party_application_dict.py index 27db6df4..598357bc 100644 --- a/foundry/v2/models/_third_party_application_dict.py +++ b/foundry/v2/third_party_applications/models/_third_party_application_dict.py @@ -17,7 +17,9 @@ from typing_extensions import TypedDict -from foundry.v2.models._third_party_application_rid import ThirdPartyApplicationRid +from foundry.v2.third_party_applications.models._third_party_application_rid import ( + ThirdPartyApplicationRid, +) # NOQA class ThirdPartyApplicationDict(TypedDict): diff --git a/foundry/v2/models/_third_party_application_rid.py b/foundry/v2/third_party_applications/models/_third_party_application_rid.py similarity index 100% rename from foundry/v2/models/_third_party_application_rid.py rename to foundry/v2/third_party_applications/models/_third_party_application_rid.py diff --git a/foundry/v2/models/_version.py b/foundry/v2/third_party_applications/models/_version.py similarity index 86% rename from foundry/v2/models/_version.py rename to foundry/v2/third_party_applications/models/_version.py index dccca490..359730d3 100644 --- a/foundry/v2/models/_version.py +++ b/foundry/v2/third_party_applications/models/_version.py @@ -19,8 +19,8 @@ from pydantic import BaseModel -from foundry.v2.models._version_dict import VersionDict -from foundry.v2.models._version_version import VersionVersion +from foundry.v2.third_party_applications.models._version_dict import VersionDict +from foundry.v2.third_party_applications.models._version_version import VersionVersion class Version(BaseModel): diff --git a/foundry/v2/models/_version_dict.py b/foundry/v2/third_party_applications/models/_version_dict.py similarity index 90% rename from foundry/v2/models/_version_dict.py rename to foundry/v2/third_party_applications/models/_version_dict.py index ee03fcc6..4e179b5c 100644 --- a/foundry/v2/models/_version_dict.py +++ b/foundry/v2/third_party_applications/models/_version_dict.py @@ -17,7 +17,7 @@ from typing_extensions import TypedDict -from foundry.v2.models._version_version import VersionVersion +from foundry.v2.third_party_applications.models._version_version import VersionVersion class VersionDict(TypedDict): diff --git a/foundry/v2/models/_version_version.py b/foundry/v2/third_party_applications/models/_version_version.py similarity index 100% rename from foundry/v2/models/_version_version.py rename to foundry/v2/third_party_applications/models/_version_version.py diff --git a/foundry/v2/models/_website.py b/foundry/v2/third_party_applications/models/_website.py similarity index 84% rename from foundry/v2/models/_website.py rename to foundry/v2/third_party_applications/models/_website.py index 357a5d04..0721fc66 100644 --- a/foundry/v2/models/_website.py +++ b/foundry/v2/third_party_applications/models/_website.py @@ -22,9 +22,9 @@ from pydantic import BaseModel from pydantic import Field -from foundry.v2.models._subdomain import Subdomain -from foundry.v2.models._version_version import VersionVersion -from foundry.v2.models._website_dict import WebsiteDict +from foundry.v2.third_party_applications.models._subdomain import Subdomain +from foundry.v2.third_party_applications.models._version_version import VersionVersion +from foundry.v2.third_party_applications.models._website_dict import WebsiteDict class Website(BaseModel): diff --git a/foundry/v2/models/_website_dict.py b/foundry/v2/third_party_applications/models/_website_dict.py similarity index 86% rename from foundry/v2/models/_website_dict.py rename to foundry/v2/third_party_applications/models/_website_dict.py index bfad9266..dee7751f 100644 --- a/foundry/v2/models/_website_dict.py +++ b/foundry/v2/third_party_applications/models/_website_dict.py @@ -20,8 +20,8 @@ from typing_extensions import NotRequired from typing_extensions import TypedDict -from foundry.v2.models._subdomain import Subdomain -from foundry.v2.models._version_version import VersionVersion +from foundry.v2.third_party_applications.models._subdomain import Subdomain +from foundry.v2.third_party_applications.models._version_version import VersionVersion class WebsiteDict(TypedDict): diff --git a/foundry/v2/third_party_applications/third_party_application.py b/foundry/v2/third_party_applications/third_party_application.py new file mode 100644 index 00000000..ed439e59 --- /dev/null +++ b/foundry/v2/third_party_applications/third_party_application.py @@ -0,0 +1,86 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.third_party_applications.models._third_party_application import ( + ThirdPartyApplication, +) # NOQA +from foundry.v2.third_party_applications.models._third_party_application_rid import ( + ThirdPartyApplicationRid, +) # NOQA +from foundry.v2.third_party_applications.website import WebsiteClient + + +class ThirdPartyApplicationClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + self.Website = WebsiteClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def get( + self, + third_party_application_rid: ThirdPartyApplicationRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ThirdPartyApplication: + """ + Get the ThirdPartyApplication with the specified rid. + :param third_party_application_rid: thirdPartyApplicationRid + :type third_party_application_rid: ThirdPartyApplicationRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ThirdPartyApplication + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}", + query_params={ + "preview": preview, + }, + path_params={ + "thirdPartyApplicationRid": third_party_application_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ThirdPartyApplication, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/third_party_applications/version.py b/foundry/v2/third_party_applications/version.py new file mode 100644 index 00000000..8c3158e7 --- /dev/null +++ b/foundry/v2/third_party_applications/version.py @@ -0,0 +1,282 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._core import ResourceIterator +from foundry._errors import handle_unexpected +from foundry.v2.core.models._page_size import PageSize +from foundry.v2.core.models._page_token import PageToken +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.third_party_applications.models._list_versions_response import ( + ListVersionsResponse, +) # NOQA +from foundry.v2.third_party_applications.models._third_party_application_rid import ( + ThirdPartyApplicationRid, +) # NOQA +from foundry.v2.third_party_applications.models._version import Version +from foundry.v2.third_party_applications.models._version_version import VersionVersion + + +class VersionClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def delete( + self, + third_party_application_rid: ThirdPartyApplicationRid, + version_version: VersionVersion, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> None: + """ + Delete the Version with the specified version. + :param third_party_application_rid: thirdPartyApplicationRid + :type third_party_application_rid: ThirdPartyApplicationRid + :param version_version: versionVersion + :type version_version: VersionVersion + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="DELETE", + resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion}", + query_params={ + "preview": preview, + }, + path_params={ + "thirdPartyApplicationRid": third_party_application_rid, + "versionVersion": version_version, + }, + header_params={}, + body=None, + body_type=None, + response_type=None, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + third_party_application_rid: ThirdPartyApplicationRid, + version_version: VersionVersion, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Version: + """ + Get the Version with the specified version. + :param third_party_application_rid: thirdPartyApplicationRid + :type third_party_application_rid: ThirdPartyApplicationRid + :param version_version: versionVersion + :type version_version: VersionVersion + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Version + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion}", + query_params={ + "preview": preview, + }, + path_params={ + "thirdPartyApplicationRid": third_party_application_rid, + "versionVersion": version_version, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Version, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def list( + self, + third_party_application_rid: ThirdPartyApplicationRid, + *, + page_size: Optional[PageSize] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ResourceIterator[Version]: + """ + Lists all Versions. + + This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + :param third_party_application_rid: thirdPartyApplicationRid + :type third_party_application_rid: ThirdPartyApplicationRid + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ResourceIterator[Version] + """ + + return self._api_client.iterate_api( + RequestInfo( + method="GET", + resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions", + query_params={ + "pageSize": page_size, + "preview": preview, + }, + path_params={ + "thirdPartyApplicationRid": third_party_application_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListVersionsResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def page( + self, + third_party_application_rid: ThirdPartyApplicationRid, + *, + page_size: Optional[PageSize] = None, + page_token: Optional[PageToken] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> ListVersionsResponse: + """ + Lists all Versions. + + This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the `nextPageToken` field will be populated. To get the next page, make the same request again, but set the value of the `pageToken` query parameter to be value of the `nextPageToken` value of the previous response. If there is no `nextPageToken` field in the response, you are on the last page. + :param third_party_application_rid: thirdPartyApplicationRid + :type third_party_application_rid: ThirdPartyApplicationRid + :param page_size: pageSize + :type page_size: Optional[PageSize] + :param page_token: pageToken + :type page_token: Optional[PageToken] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ListVersionsResponse + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions", + query_params={ + "pageSize": page_size, + "pageToken": page_token, + "preview": preview, + }, + path_params={ + "thirdPartyApplicationRid": third_party_application_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=ListVersionsResponse, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def upload( + self, + third_party_application_rid: ThirdPartyApplicationRid, + body: bytes, + *, + version: VersionVersion, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Version: + """ + Upload a new version of the Website. + :param third_party_application_rid: thirdPartyApplicationRid + :type third_party_application_rid: ThirdPartyApplicationRid + :param body: The zip file that contains the contents of your application. For more information, refer to the [documentation](/docs/foundry/ontology-sdk/deploy-osdk-application-on-foundry/) user documentation. + :type body: bytes + :param version: version + :type version: VersionVersion + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Version + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/upload", + query_params={ + "version": version, + "preview": preview, + }, + path_params={ + "thirdPartyApplicationRid": third_party_application_rid, + }, + header_params={ + "Content-Type": "application/octet-stream", + "Accept": "application/json", + }, + body=body, + body_type=bytes, + response_type=Version, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/third_party_applications/website.py b/foundry/v2/third_party_applications/website.py new file mode 100644 index 00000000..c1d6cfa6 --- /dev/null +++ b/foundry/v2/third_party_applications/website.py @@ -0,0 +1,179 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +from pydantic import Field +from pydantic import StrictInt +from pydantic import validate_call +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.third_party_applications.models._third_party_application_rid import ( + ThirdPartyApplicationRid, +) # NOQA +from foundry.v2.third_party_applications.models._version_version import VersionVersion +from foundry.v2.third_party_applications.models._website import Website +from foundry.v2.third_party_applications.version import VersionClient + + +class WebsiteClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + self.Version = VersionClient(auth=auth, hostname=hostname) + + @validate_call + @handle_unexpected + def deploy( + self, + third_party_application_rid: ThirdPartyApplicationRid, + *, + version: VersionVersion, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Website: + """ + Deploy a version of the Website. + :param third_party_application_rid: thirdPartyApplicationRid + :type third_party_application_rid: ThirdPartyApplicationRid + :param version: + :type version: VersionVersion + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Website + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/deploy", + query_params={ + "preview": preview, + }, + path_params={ + "thirdPartyApplicationRid": third_party_application_rid, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "version": version, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "version": VersionVersion, + }, + ), + response_type=Website, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def get( + self, + third_party_application_rid: ThirdPartyApplicationRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Website: + """ + Get the Website. + :param third_party_application_rid: thirdPartyApplicationRid + :type third_party_application_rid: ThirdPartyApplicationRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Website + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website", + query_params={ + "preview": preview, + }, + path_params={ + "thirdPartyApplicationRid": third_party_application_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Website, + request_timeout=request_timeout, + ), + ) + + @validate_call + @handle_unexpected + def undeploy( + self, + third_party_application_rid: ThirdPartyApplicationRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[StrictInt, Field(gt=0)]] = None, + ) -> Website: + """ + Remove the currently deployed version of the Website. + :param third_party_application_rid: thirdPartyApplicationRid + :type third_party_application_rid: ThirdPartyApplicationRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: Website + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/undeploy", + query_params={ + "preview": preview, + }, + path_params={ + "thirdPartyApplicationRid": third_party_application_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=Website, + request_timeout=request_timeout, + ), + ) diff --git a/openapi.yml b/openapi.yml index 148c47f2..c570fd4d 100644 --- a/openapi.yml +++ b/openapi.yml @@ -26,734 +26,699 @@ components: api:ontologies-read: Allows applications to read ontology data using Palantir APIs. api:ontologies-write: Allows applications to write ontology data using Palantir APIs. schemas: - ActionEditedPropertiesNotFound: - description: | - Actions attempted to edit properties that could not be found on the object type. - Please contact the Ontology administrator to resolve this issue. - properties: - parameters: - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + SearchJsonQueryV2: + type: object x-namespace: Ontologies - ObjectAlreadyExists: - description: | - The object the user is attempting to create already exists. - properties: - parameters: - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + discriminator: + propertyName: type + mapping: + lt: "#/components/schemas/LtQueryV2" + gt: "#/components/schemas/GtQueryV2" + lte: "#/components/schemas/LteQueryV2" + gte: "#/components/schemas/GteQueryV2" + eq: "#/components/schemas/EqualsQueryV2" + isNull: "#/components/schemas/IsNullQueryV2" + contains: "#/components/schemas/ContainsQueryV2" + and: "#/components/schemas/AndQueryV2" + or: "#/components/schemas/OrQueryV2" + not: "#/components/schemas/NotQueryV2" + startsWith: "#/components/schemas/StartsWithQuery" + containsAllTermsInOrder: "#/components/schemas/ContainsAllTermsInOrderQuery" + containsAllTermsInOrderPrefixLastTerm: "#/components/schemas/ContainsAllTermsInOrderPrefixLastTerm" + containsAnyTerm: "#/components/schemas/ContainsAnyTermQuery" + containsAllTerms: "#/components/schemas/ContainsAllTermsQuery" + withinDistanceOf: "#/components/schemas/WithinDistanceOfQuery" + withinBoundingBox: "#/components/schemas/WithinBoundingBoxQuery" + intersectsBoundingBox: "#/components/schemas/IntersectsBoundingBoxQuery" + doesNotIntersectBoundingBox: "#/components/schemas/DoesNotIntersectBoundingBoxQuery" + withinPolygon: "#/components/schemas/WithinPolygonQuery" + intersectsPolygon: "#/components/schemas/IntersectsPolygonQuery" + doesNotIntersectPolygon: "#/components/schemas/DoesNotIntersectPolygonQuery" + oneOf: + - $ref: "#/components/schemas/LtQueryV2" + - $ref: "#/components/schemas/GtQueryV2" + - $ref: "#/components/schemas/LteQueryV2" + - $ref: "#/components/schemas/GteQueryV2" + - $ref: "#/components/schemas/EqualsQueryV2" + - $ref: "#/components/schemas/IsNullQueryV2" + - $ref: "#/components/schemas/ContainsQueryV2" + - $ref: "#/components/schemas/AndQueryV2" + - $ref: "#/components/schemas/OrQueryV2" + - $ref: "#/components/schemas/NotQueryV2" + - $ref: "#/components/schemas/StartsWithQuery" + - $ref: "#/components/schemas/ContainsAllTermsInOrderQuery" + - $ref: "#/components/schemas/ContainsAllTermsInOrderPrefixLastTerm" + - $ref: "#/components/schemas/ContainsAnyTermQuery" + - $ref: "#/components/schemas/ContainsAllTermsQuery" + - $ref: "#/components/schemas/WithinDistanceOfQuery" + - $ref: "#/components/schemas/WithinBoundingBoxQuery" + - $ref: "#/components/schemas/IntersectsBoundingBoxQuery" + - $ref: "#/components/schemas/DoesNotIntersectBoundingBoxQuery" + - $ref: "#/components/schemas/WithinPolygonQuery" + - $ref: "#/components/schemas/IntersectsPolygonQuery" + - $ref: "#/components/schemas/DoesNotIntersectPolygonQuery" + LtQueryV2: + type: object x-namespace: Ontologies - LinkAlreadyExists: - description: | - The link the user is attempting to create already exists. + description: Returns objects where the specified field is less than a value. properties: - parameters: - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + GtQueryV2: + type: object x-namespace: Ontologies - FunctionExecutionFailed: - x-type: error + description: Returns objects where the specified field is greater than a value. + properties: + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + LteQueryV2: + type: object x-namespace: Ontologies + description: Returns objects where the specified field is less than or equal to a value. properties: - parameters: - properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" - required: - - functionRid - - functionVersion - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - ParentAttachmentPermissionDenied: - description: | - The user does not have permission to parent attachments. + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + GteQueryV2: + type: object + x-namespace: Ontologies + description: Returns objects where the specified field is greater than or equal to a value. properties: - parameters: - type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + EqualsQueryV2: + type: object x-namespace: Ontologies - EditObjectPermissionDenied: - description: | - The user does not have permission to edit this `ObjectType`. + description: Returns objects where the specified field is equal to a value. properties: - parameters: - type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + IsNullQueryV2: + type: object x-namespace: Ontologies - ViewObjectPermissionDenied: - description: | - The provided token does not have permission to view any data sources backing this object type. Ensure the object - type has backing data sources configured and visible. + description: Returns objects based on the existence of the specified field. properties: - parameters: - type: object - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - required: - - objectType - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + type: boolean + x-safety: unsafe + required: + - field + - value + ContainsQueryV2: + type: object x-namespace: Ontologies - ObjectChanged: - description: | - An object used by this `Action` was changed by someone else while the `Action` was running. + description: Returns objects where the specified array contains a value. properties: - parameters: - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + AndQueryV2: + type: object x-namespace: Ontologies - ActionParameterObjectTypeNotFound: - description: | - The parameter references an object type that could not be found, or the client token does not have access to it. + description: Returns objects where every query is satisfied. properties: - parameters: - type: object - properties: - parameterId: - $ref: "#/components/schemas/ParameterId" - required: - - parameterId - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + value: + items: + $ref: "#/components/schemas/SearchJsonQueryV2" + type: array + OrQueryV2: + type: object x-namespace: Ontologies - ActionParameterObjectNotFound: - description: | - The parameter object reference or parameter default value is not found, or the client token does not have access to it. + description: Returns objects where at least 1 query is satisfied. properties: - parameters: - type: object - properties: - parameterId: - $ref: "#/components/schemas/ParameterId" - required: - - parameterId - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + value: + items: + $ref: "#/components/schemas/SearchJsonQueryV2" + type: array + NotQueryV2: + type: object x-namespace: Ontologies - ActionNotFound: - description: "The action is not found, or the user does not have access to it." + description: Returns objects where the query is not satisfied. properties: - parameters: - properties: - actionRid: - $ref: "#/components/schemas/ActionRid" - required: - - actionRid - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + value: + $ref: "#/components/schemas/SearchJsonQueryV2" + required: + - value + StartsWithQuery: + type: object x-namespace: Ontologies - ActionTypeNotFound: - description: "The action type is not found, or the user does not have access to it." + description: Returns objects where the specified field starts with the provided value. properties: - parameters: - properties: - actionType: - $ref: "#/components/schemas/ActionTypeApiName" - rid: - $ref: "#/components/schemas/ActionTypeRid" - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: + field: + $ref: "#/components/schemas/PropertyApiName" + value: type: string - x-type: error + x-safety: unsafe + required: + - field + - value + ContainsAllTermsInOrderQuery: + type: object x-namespace: Ontologies - ActionValidationFailed: description: | - The validation failed for the given action parameters. Please use the `validateAction` endpoint for more - details. + Returns objects where the specified field contains all of the terms in the order provided, + but they do have to be adjacent to each other. properties: - parameters: - properties: - actionType: - $ref: "#/components/schemas/ActionTypeApiName" - required: - - actionType - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: + field: + $ref: "#/components/schemas/PropertyApiName" + value: type: string - x-type: error + x-safety: unsafe + required: + - field + - value + ContainsAllTermsInOrderPrefixLastTerm: + type: object x-namespace: Ontologies - ApplyActionFailed: + description: "Returns objects where the specified field contains all of the terms in the order provided, \nbut they do have to be adjacent to each other.\nThe last term can be a partial prefix match.\n" properties: - parameters: - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: + field: + $ref: "#/components/schemas/PropertyApiName" + value: type: string - x-type: error + x-safety: unsafe + required: + - field + - value + ContainsAnyTermQuery: + type: object x-namespace: Ontologies - AttachmentNotFound: - description: "The requested attachment is not found, or the client token does not have access to it. \nAttachments that are not attached to any objects are deleted after two weeks.\nAttachments that have not been attached to an object can only be viewed by the user who uploaded them.\nAttachments that have been attached to an object can be viewed by users who can view the object.\n" + description: "Returns objects where the specified field contains any of the whitespace separated words in any \norder in the provided value. This query supports fuzzy matching.\n" properties: - parameters: - type: object - properties: - attachmentRid: - $ref: "#/components/schemas/AttachmentRid" - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: + field: + $ref: "#/components/schemas/PropertyApiName" + value: type: string - x-type: error + x-safety: unsafe + fuzzy: + $ref: "#/components/schemas/FuzzyV2" + required: + - field + - value + CenterPointTypes: + type: object x-namespace: Ontologies - AttachmentSizeExceededLimit: - description: | - The file is too large to be uploaded as an attachment. - The maximum attachment size is 200MB. - properties: - parameters: - type: object - properties: - fileSizeBytes: - type: string - x-safety: unsafe - fileLimitBytes: - type: string - x-safety: safe - required: - - fileSizeBytes - - fileLimitBytes - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + discriminator: + propertyName: type + mapping: + Point: "#/components/schemas/GeoPoint" + oneOf: + - $ref: "#/components/schemas/GeoPoint" + WithinBoundingBoxPoint: + type: object x-namespace: Ontologies - DuplicateOrderBy: - description: The requested sort order includes duplicate properties. - properties: - parameters: - properties: - properties: - type: array - items: - $ref: "#/components/schemas/PropertyApiName" - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + discriminator: + propertyName: type + mapping: + Point: "#/components/schemas/GeoPoint" + oneOf: + - $ref: "#/components/schemas/GeoPoint" + CenterPoint: + type: object x-namespace: Ontologies - FunctionInvalidInput: - x-type: error + description: | + The coordinate point to use as the center of the distance query. + properties: + center: + $ref: "#/components/schemas/CenterPointTypes" + distance: + $ref: "#/components/schemas/Distance" + required: + - center + - distance + WithinDistanceOfQuery: + type: object x-namespace: Ontologies + description: | + Returns objects where the specified field contains a point within the distance provided of the center point. properties: - parameters: - properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" - required: - - functionRid - - functionVersion - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - FunctionExecutionTimedOut: - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/CenterPoint" + required: + - field + - value + BoundingBoxValue: + type: object x-namespace: Ontologies - properties: - parameters: - properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" - required: - - functionRid - - functionVersion - type: object - errorCode: - enum: - - TIMEOUT - type: string - errorName: - type: string - errorInstanceId: - type: string - CompositePrimaryKeyNotSupported: description: | - Primary keys consisting of multiple properties are not supported by this API. If you need support for this, - please reach out to Palantir Support. + The top left and bottom right coordinate points that make up the bounding box. properties: - parameters: - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - primaryKey: - items: - $ref: "#/components/schemas/PropertyApiName" - type: array - required: - - objectType - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + topLeft: + $ref: "#/components/schemas/WithinBoundingBoxPoint" + bottomRight: + $ref: "#/components/schemas/WithinBoundingBoxPoint" + required: + - topLeft + - bottomRight + WithinBoundingBoxQuery: + type: object x-namespace: Ontologies - InvalidContentLength: - description: "A `Content-Length` header is required for all uploads, but was missing or invalid." + description: | + Returns objects where the specified field contains a point within the bounding box provided. properties: - parameters: - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/BoundingBoxValue" + required: + - field + - value + IntersectsBoundingBoxQuery: + type: object x-namespace: Ontologies - InvalidContentType: description: | - The `Content-Type` cannot be inferred from the request content and filename. - Please check your request content and filename to ensure they are compatible. + Returns objects where the specified field intersects the bounding box provided. properties: - parameters: - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/BoundingBoxValue" + required: + - field + - value + DoesNotIntersectBoundingBoxQuery: + type: object x-namespace: Ontologies - FunctionEncounteredUserFacingError: description: | - The authored function failed to execute because of a user induced error. The message argument - is meant to be displayed to the user. + Returns objects where the specified field does not intersect the bounding box provided. properties: - parameters: - properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" - message: - type: string - x-safety: unsafe - required: - - functionRid - - functionVersion - - message - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/BoundingBoxValue" + required: + - field + - value + PolygonValue: + type: object x-namespace: Ontologies - InvalidGroupId: - description: The provided value for a group id must be a UUID. - properties: - parameters: - properties: - groupId: - type: string - x-safety: unsafe - required: - - groupId - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + discriminator: + propertyName: type + mapping: + Polygon: "#/components/schemas/Polygon" + oneOf: + - $ref: "#/components/schemas/Polygon" + WithinPolygonQuery: + type: object x-namespace: Ontologies - InvalidUserId: - description: The provided value for a user id must be a UUID. + description: | + Returns objects where the specified field contains a point within the polygon provided. properties: - parameters: - properties: - userId: - type: string - x-safety: unsafe - required: - - userId - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PolygonValue" + required: + - field + - value + IntersectsPolygonQuery: + type: object x-namespace: Ontologies - AggregationGroupCountExceededLimit: description: | - The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by - adjusting your query to reduce the number of groups created by your aggregation. For instance: - - If you are using multiple `groupBy` clauses, try reducing the number of clauses. - - If you are using a `groupBy` clause with a high cardinality property, try filtering the data first - to reduce the number of groups. + Returns objects where the specified field intersects the polygon provided. properties: - parameters: - properties: - groupsCount: - type: integer - x-safety: safe - groupsLimit: - type: integer - x-safety: safe - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PolygonValue" + required: + - field + - value + DoesNotIntersectPolygonQuery: + type: object x-namespace: Ontologies - AggregationMemoryExceededLimit: description: | - The amount of memory used in the request exceeded the limit. The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by - adjusting your query to reduce the number of groups created by your aggregation. For instance: - - If you are using multiple `groupBy` clauses, try reducing the number of clauses. - - If you are using a `groupBy` clause with a high cardinality property, try filtering the data first - to reduce the number of groups. + Returns objects where the specified field does not intersect the polygon provided. properties: - parameters: - properties: - memoryUsedBytes: - type: string - x-safety: safe - memoryLimitBytes: - type: string - x-safety: safe - type: object - required: - - memoryUsedBytes - - memoryLimitBytes - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + field: + $ref: "#/components/schemas/PropertyApiName" + value: + $ref: "#/components/schemas/PolygonValue" + required: + - field + - value + ContainsAllTermsQuery: + type: object x-namespace: Ontologies - InvalidParameterValue: description: | - The value of the given parameter is invalid. See the documentation of `DataValue` for details on - how parameters are represented. + Returns objects where the specified field contains all of the whitespace separated words in any + order in the provided value. This query supports fuzzy matching. properties: - parameters: - properties: - parameterBaseType: - $ref: "#/components/schemas/ValueType" - parameterDataType: - $ref: "#/components/schemas/OntologyDataType" - parameterId: - $ref: "#/components/schemas/ParameterId" - parameterValue: - $ref: "#/components/schemas/DataValue" - required: - - parameterId - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: + field: + $ref: "#/components/schemas/PropertyApiName" + value: type: string - x-type: error + x-safety: unsafe + fuzzy: + $ref: "#/components/schemas/FuzzyV2" + required: + - field + - value + FuzzyV2: + description: Setting fuzzy to `true` allows approximate matching in search queries that support it. + type: boolean + x-namespace: Ontologies + x-safety: safe + SearchOrderByV2: + description: Specifies the ordering of search results by a field and an ordering direction. + type: object x-namespace: Ontologies - InvalidQueryParameterValue: - description: | - The value of the given parameter is invalid. See the documentation of `DataValue` for details on - how parameters are represented. properties: - parameters: - properties: - parameterDataType: - $ref: "#/components/schemas/QueryDataType" - parameterId: - $ref: "#/components/schemas/ParameterId" - parameterValue: - $ref: "#/components/schemas/DataValue" - required: - - parameterId - - parameterDataType - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + fields: + items: + $ref: "#/components/schemas/SearchOrderingV2" + type: array + SearchOrderingV2: + type: object x-namespace: Ontologies - InvalidFields: - description: | - The value of the given field does not match the expected pattern. For example, an Ontology object property `id` - should be written `properties.id`. properties: - parameters: - properties: - properties: - items: - type: string - x-safety: unsafe - type: array - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: + field: + $ref: "#/components/schemas/PropertyApiName" + direction: + description: Specifies the ordering direction (can be either `asc` or `desc`) type: string - x-type: error + x-safety: safe + required: + - field + RequestId: + type: string + format: uuid + description: Unique request id x-namespace: Ontologies - InvalidPropertyFilterValue: - description: | - The value of the given property filter is invalid. For instance, 2 is an invalid value for - `isNull` in `properties.address.isNull=2` because the `isNull` filter expects a value of boolean type. + x-safety: safe + SubscriptionId: + type: string + format: uuid + description: A unique identifier used to associate subscription requests with responses. + x-namespace: Ontologies + x-safety: safe + ObjectSetStreamSubscribeRequest: + type: object properties: - parameters: - properties: - expectedType: - $ref: "#/components/schemas/ValueType" - propertyFilter: - $ref: "#/components/schemas/PropertyFilter" - propertyFilterValue: - $ref: "#/components/schemas/FilterValue" - property: - $ref: "#/components/schemas/PropertyApiName" - required: - - expectedType - - property - - propertyFilter - - propertyFilterValue - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + objectSet: + $ref: "#/components/schemas/ObjectSet" + propertySet: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" + referenceSet: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" + required: + - objectSet x-namespace: Ontologies - InvalidPropertyFiltersCombination: - description: The provided filters cannot be used together. + ObjectSetStreamSubscribeRequests: + type: object + description: "The list of object sets that should be subscribed to. A client can stop subscribing to an object set \nby removing the request from subsequent ObjectSetStreamSubscribeRequests.\n" properties: - parameters: - properties: - propertyFilters: - items: - $ref: "#/components/schemas/PropertyFilter" - type: array - property: - $ref: "#/components/schemas/PropertyApiName" - required: - - property - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error + id: + description: "A randomly generated RequestId used to associate a ObjectSetStreamSubscribeRequest with a subsequent \nObjectSetSubscribeResponses. Each RequestId should be unique.\n" + $ref: "#/components/schemas/RequestId" + requests: + type: array + items: + $ref: "#/components/schemas/ObjectSetStreamSubscribeRequest" + required: + - id x-namespace: Ontologies - InvalidPropertyValue: + StreamMessage: + type: object + discriminator: + propertyName: type + mapping: + subscribeResponses: "#/components/schemas/ObjectSetSubscribeResponses" + objectSetChanged: "#/components/schemas/ObjectSetUpdates" + refreshObjectSet: "#/components/schemas/RefreshObjectSet" + subscriptionClosed: "#/components/schemas/SubscriptionClosed" + oneOf: + - $ref: "#/components/schemas/ObjectSetSubscribeResponses" + - $ref: "#/components/schemas/ObjectSetUpdates" + - $ref: "#/components/schemas/RefreshObjectSet" + - $ref: "#/components/schemas/SubscriptionClosed" + x-namespace: Ontologies + ObjectSetSubscribeResponses: + type: object description: | - The value of the given property is invalid. See the documentation of `PropertyValue` for details on - how properties are represented. + Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId. properties: - parameters: - properties: - propertyBaseType: - $ref: "#/components/schemas/ValueType" - property: - $ref: "#/components/schemas/PropertyApiName" - propertyValue: - $ref: "#/components/schemas/PropertyValue" - required: - - property - - propertyBaseType - - propertyValue - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: + responses: + type: array + items: + $ref: "#/components/schemas/ObjectSetSubscribeResponse" + id: + $ref: "#/components/schemas/RequestId" + required: + - id + x-namespace: Ontologies + ObjectSetSubscribeResponse: + type: object + discriminator: + propertyName: type + mapping: + success: "#/components/schemas/SubscriptionSuccess" + error: "#/components/schemas/SubscriptionError" + qos: "#/components/schemas/QosError" + oneOf: + - $ref: "#/components/schemas/SubscriptionSuccess" + - $ref: "#/components/schemas/SubscriptionError" + - $ref: "#/components/schemas/QosError" + x-namespace: Ontologies + SubscriptionSuccess: + type: object + properties: + id: + $ref: "#/components/schemas/SubscriptionId" + required: + - id + x-namespace: Ontologies + SubscriptionError: + type: object + properties: + errors: + type: array + items: + $ref: "#/components/schemas/Error" + x-namespace: Ontologies + QosError: + type: object + description: | + An error indicating that the subscribe request should be attempted on a different node. + x-namespace: Ontologies + ErrorName: + type: string + x-safety: safe + x-namespace: Ontologies + Arg: + type: object + properties: + name: type: string - errorInstanceId: + x-safety: safe + value: type: string - x-type: error + x-safety: unsafe + required: + - name + - value x-namespace: Ontologies - InvalidPropertyType: + Error: + type: object + properties: + error: + $ref: "#/components/schemas/ErrorName" + args: + type: array + items: + $ref: "#/components/schemas/Arg" + required: + - error + x-namespace: Ontologies + ReasonType: description: | - The given property type is not of the expected type. + Represents the reason a subscription was closed. + enum: + - USER_CLOSED + - CHANNEL_CLOSED + x-namespace: Ontologies + Reason: + type: object + properties: + reason: + $ref: "#/components/schemas/ReasonType" + required: + - reason + x-namespace: Ontologies + SubscriptionClosureCause: + type: object + discriminator: + propertyName: type + mapping: + error: "#/components/schemas/Error" + reason: "#/components/schemas/Reason" + oneOf: + - $ref: "#/components/schemas/Error" + - $ref: "#/components/schemas/Reason" + x-namespace: Ontologies + RefreshObjectSet: + type: object + description: | + The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service. + properties: + id: + $ref: "#/components/schemas/SubscriptionId" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - id + - objectType + x-namespace: Ontologies + SubscriptionClosed: + type: object + description: | + The subscription has been closed due to an irrecoverable error during its lifecycle. + properties: + id: + $ref: "#/components/schemas/SubscriptionId" + cause: + $ref: "#/components/schemas/SubscriptionClosureCause" + required: + - id + - cause + x-namespace: Ontologies + ObjectSetUpdates: + type: object + properties: + id: + $ref: "#/components/schemas/SubscriptionId" + updates: + type: array + items: + $ref: "#/components/schemas/ObjectSetUpdate" + required: + - id + x-namespace: Ontologies + ObjectSetUpdate: + type: object + discriminator: + propertyName: type + mapping: + object: "#/components/schemas/ObjectUpdate" + reference: "#/components/schemas/ReferenceUpdate" + oneOf: + - $ref: "#/components/schemas/ObjectUpdate" + - $ref: "#/components/schemas/ReferenceUpdate" + x-namespace: Ontologies + ObjectState: + description: "Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was \nadded to the set or the object has updated and was previously in the set. REMOVED indicates that the object \nwas removed from the set due to the object being deleted or the object no longer meets the object set \ndefinition.\n" + enum: + - ADDED_OR_UPDATED + - REMOVED + x-namespace: Ontologies + ObjectUpdate: + type: object + properties: + object: + $ref: "#/components/schemas/OntologyObjectV2" + state: + $ref: "#/components/schemas/ObjectState" + required: + - object + - state + x-namespace: Ontologies + ObjectPrimaryKey: + type: object + additionalProperties: + $ref: "#/components/schemas/PropertyValue" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + x-namespace: Ontologies + ReferenceUpdate: + type: object + description: | + The updated data value associated with an object instance's external reference. The object instance + is uniquely identified by an object type and a primary key. Note that the value of the property + field returns a dereferenced value rather than the reference itself. + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + primaryKey: + $ref: "#/components/schemas/ObjectPrimaryKey" + description: The ObjectPrimaryKey of the object instance supplying the reference property. + property: + $ref: "#/components/schemas/PropertyApiName" + description: The PropertyApiName on the object type that corresponds to the reference property + value: + $ref: "#/components/schemas/ReferenceValue" + required: + - objectType + - primaryKey + - property + - value + x-namespace: Ontologies + ReferenceValue: + type: object + description: Resolved data values pointed to by a reference. + discriminator: + propertyName: type + mapping: + geotimeSeriesValue: "#/components/schemas/GeotimeSeriesValue" + oneOf: + - $ref: "#/components/schemas/GeotimeSeriesValue" + x-namespace: Ontologies + GeotimeSeriesValue: + type: object + description: The underlying data values pointed to by a GeotimeSeriesReference. + properties: + position: + $ref: "#/components/schemas/Position" + timestamp: + type: string + format: date-time + x-safety: unsafe + required: + - position + - timestamp + x-namespace: Ontologies + InvalidApplyActionOptionCombination: + description: The given options are individually valid but cannot be used in the given combination. properties: parameters: properties: - propertyBaseType: - $ref: "#/components/schemas/ValueType" - property: - $ref: "#/components/schemas/PropertyApiName" - required: - - property - - propertyBaseType + invalidCombination: + $ref: "#/components/schemas/ApplyActionRequestOptions" type: object errorCode: enum: @@ -765,22 +730,14 @@ components: type: string x-type: error x-namespace: Ontologies - InvalidSortOrder: - description: | - The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort - order can also be omitted, and defaults to 'asc'. + ActionContainsDuplicateEdits: + description: The given action request has multiple edits on the same object. properties: parameters: - properties: - invalidSortOrder: - type: string - x-safety: unsafe - required: - - invalidSortOrder type: object errorCode: enum: - - INVALID_ARGUMENT + - CONFLICT type: string errorName: type: string @@ -788,17 +745,14 @@ components: type: string x-type: error x-namespace: Ontologies - InvalidSortType: - description: The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'. + ActionEditsReadOnlyEntity: + description: The given action request performs edits on a type that is read-only or does not allow edits. properties: parameters: + type: object properties: - invalidSortType: - type: string - x-safety: safe - required: - - invalidSortType - type: object + entityTypeRid: + $ref: "#/components/schemas/ObjectTypeRid" errorCode: enum: - INVALID_ARGUMENT @@ -809,18 +763,15 @@ components: type: string x-type: error x-namespace: Ontologies - LinkTypeNotFound: - description: "The link type is not found, or the user does not have access to it." + ObjectSetNotFound: + description: "The requested object set is not found, or the client token does not have access to it." properties: parameters: properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - linkType: - $ref: "#/components/schemas/LinkTypeApiName" + objectSetRid: + $ref: "#/components/schemas/ObjectSetRid" required: - - linkType - - objectType + - objectSetRid type: object errorCode: enum: @@ -832,23 +783,19 @@ components: type: string x-type: error x-namespace: Ontologies - LinkedObjectNotFound: - description: "The linked object with the given primary key is not found, or the user does not have access to it." + MarketplaceInstallationNotFound: + description: | + The given marketplace installation could not be found or the user does not have access to it. properties: parameters: properties: - linkType: - $ref: "#/components/schemas/LinkTypeApiName" - linkedObjectType: - $ref: "#/components/schemas/ObjectTypeApiName" - linkedObjectPrimaryKey: - additionalProperties: - $ref: "#/components/schemas/PrimaryKeyValue" - x-mapKey: - $ref: "#/components/schemas/PropertyApiName" + artifactRepository: + $ref: "#/components/schemas/ArtifactRepositoryRid" + packageName: + $ref: "#/components/schemas/SdkPackageName" required: - - linkType - - linkedObjectType + - artifactRepository + - packageName type: object errorCode: enum: @@ -860,43 +807,25 @@ components: type: string x-type: error x-namespace: Ontologies - MalformedPropertyFilters: - description: | - At least one of requested filters are malformed. Please look at the documentation of `PropertyFilter`. + MarketplaceObjectMappingNotFound: + description: The given object could not be mapped to a Marketplace installation. properties: parameters: properties: - malformedPropertyFilter: - type: string - x-safety: unsafe + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + artifactRepository: + $ref: "#/components/schemas/ArtifactRepositoryRid" + packageName: + $ref: "#/components/schemas/SdkPackageName" required: - - malformedPropertyFilter - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - MissingParameter: - description: | - Required parameters are missing. Please look at the `parameters` field to see which required parameters are - missing from the request. - properties: - parameters: - properties: - parameters: - items: - $ref: "#/components/schemas/ParameterId" - type: array + - objectType + - artifactRepository + - packageName type: object errorCode: enum: - - INVALID_ARGUMENT + - NOT_FOUND type: string errorName: type: string @@ -904,43 +833,21 @@ components: type: string x-type: error x-namespace: Ontologies - MultiplePropertyValuesNotSupported: - description: | - One of the requested property filters does not support multiple values. Please include only a single value for - it. + MarketplaceActionMappingNotFound: + description: The given action could not be mapped to a Marketplace installation. properties: parameters: properties: - propertyFilter: - $ref: "#/components/schemas/PropertyFilter" - property: - $ref: "#/components/schemas/PropertyApiName" + actionType: + $ref: "#/components/schemas/ActionTypeApiName" + artifactRepository: + $ref: "#/components/schemas/ArtifactRepositoryRid" + packageName: + $ref: "#/components/schemas/SdkPackageName" required: - - property - - propertyFilter - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ObjectNotFound: - description: "The requested object is not found, or the client token does not have access to it." - properties: - parameters: - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - primaryKey: - additionalProperties: - $ref: "#/components/schemas/PrimaryKeyValue" - x-mapKey: - $ref: "#/components/schemas/PropertyApiName" + - actionType + - artifactRepository + - packageName type: object errorCode: enum: @@ -952,15 +859,21 @@ components: type: string x-type: error x-namespace: Ontologies - ObjectTypeNotFound: - description: "The requested object type is not found, or the client token does not have access to it." + MarketplaceQueryMappingNotFound: + description: The given query could not be mapped to a Marketplace installation. properties: parameters: properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - objectTypeRid: - $ref: "#/components/schemas/ObjectTypeRid" + queryType: + $ref: "#/components/schemas/QueryApiName" + artifactRepository: + $ref: "#/components/schemas/ArtifactRepositoryRid" + packageName: + $ref: "#/components/schemas/SdkPackageName" + required: + - queryType + - artifactRepository + - packageName type: object errorCode: enum: @@ -972,59 +885,25 @@ components: type: string x-type: error x-namespace: Ontologies - UnsupportedObjectSet: - description: The requested object set is not supported. - properties: - parameters: - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ObjectsExceededLimit: - description: | - There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this - API for a given request. - properties: - parameters: - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - OntologyEditsExceededLimit: - description: | - The number of edits to the Ontology exceeded the allowed limit. - This may happen because of the request or because the Action is modifying too many objects. - Please change the size of your request or contact the Ontology administrator. + MarketplaceLinkMappingNotFound: + description: The given link could not be mapped to a Marketplace installation. properties: parameters: properties: - editsCount: - type: integer - x-safety: unsafe - editsLimit: - type: integer - x-safety: unsafe + linkType: + $ref: "#/components/schemas/LinkTypeApiName" + artifactRepository: + $ref: "#/components/schemas/ArtifactRepositoryRid" + packageName: + $ref: "#/components/schemas/SdkPackageName" required: - - editsCount - - editsLimit + - linkType + - artifactRepository + - packageName type: object errorCode: enum: - - INVALID_ARGUMENT + - NOT_FOUND type: string errorName: type: string @@ -1032,41 +911,19 @@ components: type: string x-type: error x-namespace: Ontologies - OntologyNotFound: - description: "The requested Ontology is not found, or the client token does not have access to it." + OntologyApiNameNotUnique: + description: The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name. properties: parameters: properties: - ontologyRid: - $ref: "#/components/schemas/OntologyRid" - apiName: + ontologyApiName: $ref: "#/components/schemas/OntologyApiName" type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - OntologySyncing: - description: | - The requested object type has been changed in the **Ontology Manager** and changes are currently being applied. Wait a - few seconds and try again. - properties: - parameters: - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" required: - - objectType - type: object + - ontologyApiName errorCode: enum: - - CONFLICT + - INVALID_ARGUMENT type: string errorName: type: string @@ -1074,1899 +931,1304 @@ components: type: string x-type: error x-namespace: Ontologies - OntologySyncingObjectTypes: + GeoJsonObject: + x-namespace: Geo description: | - One or more requested object types have been changed in the **Ontology Manager** and changes are currently being - applied. Wait a few seconds and try again. - properties: - parameters: - properties: - objectTypes: - type: array - items: - $ref: "#/components/schemas/ObjectTypeApiName" - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ObjectTypeNotSynced: - description: | - The requested object type is not synced into the ontology. Please reach out to your Ontology - Administrator to re-index the object type in Ontology Management Application. - properties: - parameters: - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - required: - - objectType - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ObjectTypesNotSynced: - description: | - One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology - Administrator to re-index the object type(s) in Ontology Management Application. - properties: - parameters: - properties: - objectTypes: - type: array - items: - $ref: "#/components/schemas/ObjectTypeApiName" - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ParameterTypeNotSupported: - description: | - The type of the requested parameter is not currently supported by this API. If you need support for this, - please reach out to Palantir Support. - properties: - parameters: - properties: - parameterId: - $ref: "#/components/schemas/ParameterId" - parameterBaseType: - $ref: "#/components/schemas/ValueType" - required: - - parameterBaseType - - parameterId - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ParametersNotFound: - description: | - The provided parameter ID was not found for the action. Please look at the `configuredParameterIds` field - to see which ones are available. - properties: - parameters: - properties: - actionType: - $ref: "#/components/schemas/ActionTypeApiName" - unknownParameterIds: - items: - $ref: "#/components/schemas/ParameterId" - type: array - configuredParameterIds: - items: - $ref: "#/components/schemas/ParameterId" - type: array - required: - - actionType - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - PropertiesNotFound: - description: The requested properties are not found on the object type. - properties: - parameters: - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - properties: - items: - $ref: "#/components/schemas/PropertyApiName" - type: array - required: - - objectType - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - PropertiesNotSortable: - description: | - Results could not be ordered by the requested properties. Please mark the properties as *Searchable* and - *Sortable* in the **Ontology Manager** to enable their use in `orderBy` parameters. There may be a short delay - between the time a property is set to *Searchable* and *Sortable* and when it can be used. - properties: - parameters: - properties: - properties: - items: - $ref: "#/components/schemas/PropertyApiName" - type: array - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ParameterObjectNotFound: - description: | - The parameter object reference or parameter default value is not found, or the client token does not have access to it. - properties: - parameters: - type: object - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - primaryKey: - additionalProperties: - $ref: "#/components/schemas/PrimaryKeyValue" - x-mapKey: - $ref: "#/components/schemas/PropertyApiName" - required: - - objectType - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - ParameterObjectSetRidNotFound: - description: | - The parameter object set RID is not found, or the client token does not have access to it. - properties: - parameters: - type: object - properties: - objectSetRid: - type: string - format: rid - x-safety: safe - required: - - objectSetRid - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - PropertiesNotSearchable: - description: | - Search is not enabled on the specified properties. Please mark the properties as *Searchable* - in the **Ontology Manager** to enable search on them. There may be a short delay - between the time a property is marked *Searchable* and when it can be used. - properties: - parameters: - properties: - propertyApiNames: - items: - $ref: "#/components/schemas/PropertyApiName" - type: array - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - PropertiesNotFilterable: - description: | - Results could not be filtered by the requested properties. Please mark the properties as *Searchable* and - *Selectable* in the **Ontology Manager** to be able to filter on those properties. There may be a short delay - between the time a property is marked *Searchable* and *Selectable* and when it can be used. - properties: - parameters: - properties: - properties: - items: - $ref: "#/components/schemas/PropertyApiName" - type: array - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - PropertyApiNameNotFound: - description: | - A property that was required to have an API name, such as a primary key, is missing one. You can set an API - name for it using the **Ontology Manager**. - properties: - parameters: - properties: - propertyId: - $ref: "#/components/schemas/PropertyId" - propertyBaseType: - $ref: "#/components/schemas/ValueType" - required: - - propertyBaseType - - propertyId - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - PropertyBaseTypeNotSupported: - description: | - The type of the requested property is not currently supported by this API. If you need support for this, - please reach out to Palantir Support. - properties: - parameters: - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - property: - $ref: "#/components/schemas/PropertyApiName" - propertyBaseType: - $ref: "#/components/schemas/ValueType" - required: - - objectType - - property - - propertyBaseType - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - PropertyFiltersNotSupported: - description: | - At least one of the requested property filters are not supported. See the documentation of `PropertyFilter` for - a list of supported property filters. - properties: - parameters: - properties: - propertyFilters: - items: - $ref: "#/components/schemas/PropertyFilter" - type: array - property: - $ref: "#/components/schemas/PropertyApiName" - required: - - property - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - PropertyTypesSearchNotSupported: - description: | - The search on the property types are not supported. See the `Search Objects` documentation for - a list of supported search queries on different property types. - properties: - parameters: - properties: - parameters: - additionalProperties: - type: array - items: - $ref: "#/components/schemas/PropertyApiName" - x-mapKey: - $ref: "#/components/schemas/PropertyFilter" - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - InvalidRangeQuery: - description: | - The specified query range filter is invalid. - properties: - parameters: - properties: - lt: - description: Less than - x-safety: unsafe - gt: - description: Greater than - x-safety: unsafe - lte: - description: Less than or equal - x-safety: unsafe - gte: - description: Greater than or equal - x-safety: unsafe - field: - type: string - x-safety: unsafe - required: - - field - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - QueryNotFound: - description: "The query is not found, or the user does not have access to it." - properties: - parameters: - properties: - query: - $ref: "#/components/schemas/QueryApiName" - required: - - query - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - UnknownParameter: - description: | - The provided parameters were not found. Please look at the `knownParameters` field - to see which ones are available. - properties: - parameters: - properties: - unknownParameters: - items: - $ref: "#/components/schemas/ParameterId" - type: array - expectedParameters: - items: - $ref: "#/components/schemas/ParameterId" - type: array - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - QueryEncounteredUserFacingError: - description: | - The authored `Query` failed to execute because of a user induced error. The message argument - is meant to be displayed to the user. - properties: - parameters: - properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" - message: - type: string - x-safety: unsafe - required: - - functionRid - - functionVersion - - message - type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - QueryRuntimeError: - description: | - The authored `Query` failed to execute because of a runtime error. - properties: - parameters: - properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" - message: - type: string - x-safety: unsafe - stacktrace: - type: string - x-safety: unsafe - parameters: - additionalProperties: - type: string - x-safety: unsafe - x-mapKey: - $ref: "#/components/schemas/QueryRuntimeErrorParameter" - required: - - functionRid - - functionVersion - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - QueryRuntimeErrorParameter: - type: string - x-namespace: Ontologies - x-safety: unsafe - QueryTimeExceededLimit: - description: | - Time limits were exceeded for the `Query` execution. - properties: - parameters: - properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" - required: - - functionRid - - functionVersion - type: object - errorCode: - enum: - - TIMEOUT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - QueryMemoryExceededLimit: - description: | - Memory limits were exceeded for the `Query` execution. - properties: - parameters: - properties: - functionRid: - $ref: "#/components/schemas/FunctionRid" - functionVersion: - $ref: "#/components/schemas/FunctionVersion" - required: - - functionRid - - functionVersion - type: object - errorCode: - enum: - - TIMEOUT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - SearchJsonQuery: - type: object - x-namespace: Ontologies + GeoJSon object + + The coordinate reference system for all GeoJSON coordinates is a + geographic coordinate reference system, using the World Geodetic System + 1984 (WGS 84) datum, with longitude and latitude units of decimal + degrees. + This is equivalent to the coordinate reference system identified by the + Open Geospatial Consortium (OGC) URN + An OPTIONAL third-position element SHALL be the height in meters above + or below the WGS 84 reference ellipsoid. + In the absence of elevation values, applications sensitive to height or + depth SHOULD interpret positions as being at local ground or sea level. + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3 discriminator: propertyName: type mapping: - lt: "#/components/schemas/LtQuery" - gt: "#/components/schemas/GtQuery" - lte: "#/components/schemas/LteQuery" - gte: "#/components/schemas/GteQuery" - eq: "#/components/schemas/EqualsQuery" - isNull: "#/components/schemas/IsNullQuery" - contains: "#/components/schemas/ContainsQuery" - and: "#/components/schemas/AndQuery" - or: "#/components/schemas/OrQuery" - not: "#/components/schemas/NotQuery" - prefix: "#/components/schemas/PrefixQuery" - phrase: "#/components/schemas/PhraseQuery" - anyTerm: "#/components/schemas/AnyTermQuery" - allTerms: "#/components/schemas/AllTermsQuery" + Feature: "#/components/schemas/Feature" + FeatureCollection: "#/components/schemas/FeatureCollection" + Point: "#/components/schemas/GeoPoint" + MultiPoint: "#/components/schemas/MultiPoint" + LineString: "#/components/schemas/LineString" + MultiLineString: "#/components/schemas/MultiLineString" + Polygon: "#/components/schemas/Polygon" + MultiPolygon: "#/components/schemas/MultiPolygon" + GeometryCollection: "#/components/schemas/GeometryCollection" oneOf: - - $ref: "#/components/schemas/LtQuery" - - $ref: "#/components/schemas/GtQuery" - - $ref: "#/components/schemas/LteQuery" - - $ref: "#/components/schemas/GteQuery" - - $ref: "#/components/schemas/EqualsQuery" - - $ref: "#/components/schemas/IsNullQuery" - - $ref: "#/components/schemas/ContainsQuery" - - $ref: "#/components/schemas/AndQuery" - - $ref: "#/components/schemas/OrQuery" - - $ref: "#/components/schemas/NotQuery" - - $ref: "#/components/schemas/PrefixQuery" - - $ref: "#/components/schemas/PhraseQuery" - - $ref: "#/components/schemas/AnyTermQuery" - - $ref: "#/components/schemas/AllTermsQuery" - LtQuery: - type: object - x-namespace: Ontologies - description: Returns objects where the specified field is less than a value. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - GtQuery: - type: object - x-namespace: Ontologies - description: Returns objects where the specified field is greater than a value. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - LteQuery: - type: object - x-namespace: Ontologies - description: Returns objects where the specified field is less than or equal to a value. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - GteQuery: - type: object - x-namespace: Ontologies - description: Returns objects where the specified field is greater than or equal to a value. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - EqualsQuery: - type: object - x-namespace: Ontologies - description: Returns objects where the specified field is equal to a value. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - IsNullQuery: - type: object - x-namespace: Ontologies - description: Returns objects based on the existence of the specified field. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - type: boolean - x-safety: unsafe - required: - - field - - value - ContainsQuery: - type: object - x-namespace: Ontologies - description: Returns objects where the specified array contains a value. - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - AndQuery: - type: object - x-namespace: Ontologies - description: Returns objects where every query is satisfied. - properties: - value: - items: - $ref: "#/components/schemas/SearchJsonQuery" - type: array - OrQuery: - type: object - x-namespace: Ontologies - description: Returns objects where at least 1 query is satisfied. - properties: - value: - items: - $ref: "#/components/schemas/SearchJsonQuery" - type: array - NotQuery: - type: object - x-namespace: Ontologies - description: Returns objects where the query is not satisfied. - properties: - value: - $ref: "#/components/schemas/SearchJsonQuery" - required: - - value - PrefixQuery: + - $ref: "#/components/schemas/Feature" + - $ref: "#/components/schemas/FeatureCollection" + - $ref: "#/components/schemas/GeoPoint" + - $ref: "#/components/schemas/MultiPoint" + - $ref: "#/components/schemas/LineString" + - $ref: "#/components/schemas/MultiLineString" + - $ref: "#/components/schemas/Polygon" + - $ref: "#/components/schemas/MultiPolygon" + - $ref: "#/components/schemas/GeometryCollection" type: object - x-namespace: Ontologies - description: Returns objects where the specified field starts with the provided value. properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: + type: type: string - x-safety: unsafe - required: - - field - - value - PhraseQuery: + enum: + - Feature + - FeatureCollection + - Point + - MultiPoint + - LineString + - MultiLineString + - Polygon + - MultiPolygon + - GeometryCollection + Geometry: + x-namespace: Geo + nullable: true + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1 + description: Abstract type for all GeoJSon object except Feature and FeatureCollection + discriminator: + propertyName: type + mapping: + Point: "#/components/schemas/GeoPoint" + MultiPoint: "#/components/schemas/MultiPoint" + LineString: "#/components/schemas/LineString" + MultiLineString: "#/components/schemas/MultiLineString" + Polygon: "#/components/schemas/Polygon" + MultiPolygon: "#/components/schemas/MultiPolygon" + GeometryCollection: "#/components/schemas/GeometryCollection" + oneOf: + - $ref: "#/components/schemas/GeoPoint" + - $ref: "#/components/schemas/MultiPoint" + - $ref: "#/components/schemas/LineString" + - $ref: "#/components/schemas/MultiLineString" + - $ref: "#/components/schemas/Polygon" + - $ref: "#/components/schemas/MultiPolygon" + - $ref: "#/components/schemas/GeometryCollection" + FeaturePropertyKey: + x-namespace: Geo + type: string + x-safety: unsafe + FeatureCollectionTypes: + x-namespace: Geo + discriminator: + propertyName: type + mapping: + Feature: "#/components/schemas/Feature" + oneOf: + - $ref: "#/components/schemas/Feature" + Feature: + x-namespace: Geo type: object - x-namespace: Ontologies - description: Returns objects where the specified field contains the provided value as a substring. + description: GeoJSon 'Feature' object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.2 properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - type: string + geometry: + $ref: "#/components/schemas/Geometry" + properties: + description: | + A `Feature` object has a member with the name "properties". The + value of the properties member is an object (any JSON object or a + JSON null value). + additionalProperties: + x-safety: unsafe + x-mapKey: + $ref: "#/components/schemas/FeaturePropertyKey" + id: + description: | + If a `Feature` has a commonly used identifier, that identifier + SHOULD be included as a member of the Feature object with the name + "id", and the value of this member is either a JSON string or + number. x-safety: unsafe - required: - - field - - value - AnyTermQuery: + bbox: + $ref: "#/components/schemas/BBox" + FeatureCollection: + x-namespace: Geo + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.3 + description: GeoJSon 'FeatureCollection' object type: object - x-namespace: Ontologies - description: "Returns objects where the specified field contains any of the whitespace separated words in any \norder in the provided value. This query supports fuzzy matching.\n" properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - type: string - x-safety: unsafe - fuzzy: - $ref: "#/components/schemas/Fuzzy" - required: - - field - - value - AllTermsQuery: + features: + type: array + items: + $ref: "#/components/schemas/FeatureCollectionTypes" + bbox: + $ref: "#/components/schemas/BBox" + GeoPoint: + x-namespace: Geo + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 type: object - x-namespace: Ontologies - description: | - Returns objects where the specified field contains all of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. properties: - field: - $ref: "#/components/schemas/FieldNameV1" - value: - type: string - x-safety: unsafe - fuzzy: - $ref: "#/components/schemas/Fuzzy" + coordinates: + $ref: "#/components/schemas/Position" + bbox: + $ref: "#/components/schemas/BBox" required: - - field - - value - Fuzzy: - description: Setting fuzzy to `true` allows approximate matching in search queries that support it. - type: boolean - x-namespace: Ontologies - x-safety: safe - SearchOrderBy: - description: Specifies the ordering of search results by a field and an ordering direction. + - coordinates + MultiPoint: + x-namespace: Geo + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.3 type: object - x-namespace: Ontologies properties: - fields: - items: - $ref: "#/components/schemas/SearchOrdering" + coordinates: type: array - SearchOrdering: + items: + $ref: "#/components/schemas/Position" + bbox: + $ref: "#/components/schemas/BBox" + LineString: + x-namespace: Geo + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.4 type: object - x-namespace: Ontologies properties: - field: - $ref: "#/components/schemas/FieldNameV1" - direction: - description: Specifies the ordering direction (can be either `asc` or `desc`) - type: string - x-safety: safe - required: - - field - AggregationMetricName: - type: string - x-namespace: Ontologies - description: A user-specified alias for an aggregation metric name. - x-safety: unsafe - AggregationRange: - description: Specifies a date range from an inclusive start date to an exclusive end date. + coordinates: + $ref: "#/components/schemas/LineStringCoordinates" + bbox: + $ref: "#/components/schemas/BBox" + MultiLineString: + x-namespace: Geo + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.4 type: object - x-namespace: Ontologies properties: - lt: - description: Exclusive end date. - x-safety: unsafe - lte: - description: Inclusive end date. - x-safety: unsafe - gt: - description: Exclusive start date. - x-safety: unsafe - gte: - description: Inclusive start date. - x-safety: unsafe - Aggregation: - description: Specifies an aggregation function. + coordinates: + type: array + items: + $ref: "#/components/schemas/LineStringCoordinates" + bbox: + $ref: "#/components/schemas/BBox" + Polygon: + x-namespace: Geo + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6 type: object - x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - max: "#/components/schemas/MaxAggregation" - min: "#/components/schemas/MinAggregation" - avg: "#/components/schemas/AvgAggregation" - sum: "#/components/schemas/SumAggregation" - count: "#/components/schemas/CountAggregation" - approximateDistinct: "#/components/schemas/ApproximateDistinctAggregation" - oneOf: - - $ref: "#/components/schemas/MaxAggregation" - - $ref: "#/components/schemas/MinAggregation" - - $ref: "#/components/schemas/AvgAggregation" - - $ref: "#/components/schemas/SumAggregation" - - $ref: "#/components/schemas/CountAggregation" - - $ref: "#/components/schemas/ApproximateDistinctAggregation" - AggregationGroupBy: - description: Specifies a grouping for aggregation results. + properties: + coordinates: + type: array + items: + $ref: "#/components/schemas/LinearRing" + bbox: + $ref: "#/components/schemas/BBox" + MultiPolygon: + x-namespace: Geo + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.7 type: object - x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - fixedWidth: "#/components/schemas/AggregationFixedWidthGrouping" - ranges: "#/components/schemas/AggregationRangesGrouping" - exact: "#/components/schemas/AggregationExactGrouping" - duration: "#/components/schemas/AggregationDurationGrouping" - oneOf: - - $ref: "#/components/schemas/AggregationFixedWidthGrouping" - - $ref: "#/components/schemas/AggregationRangesGrouping" - - $ref: "#/components/schemas/AggregationExactGrouping" - - $ref: "#/components/schemas/AggregationDurationGrouping" - AggregationOrderBy: + properties: + coordinates: + type: array + items: + type: array + items: + $ref: "#/components/schemas/LinearRing" + bbox: + $ref: "#/components/schemas/BBox" + LineStringCoordinates: + x-namespace: Geo + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.4 + description: | + GeoJSon fundamental geometry construct, array of two or more positions. + type: array + items: + $ref: "#/components/schemas/Position" + minItems: 2 + LinearRing: + x-namespace: Geo + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.6 + description: | + A linear ring is a closed LineString with four or more positions. + + The first and last positions are equivalent, and they MUST contain + identical values; their representation SHOULD also be identical. + + A linear ring is the boundary of a surface or the boundary of a hole in + a surface. + + A linear ring MUST follow the right-hand rule with respect to the area + it bounds, i.e., exterior rings are counterclockwise, and holes are + clockwise. + type: array + items: + $ref: "#/components/schemas/Position" + minItems: 4 + GeometryCollection: + x-namespace: Geo + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.8 + description: | + GeoJSon geometry collection + + GeometryCollections composed of a single part or a number of parts of a + single type SHOULD be avoided when that single part or a single object + of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could + be used instead. type: object + properties: + geometries: + type: array + items: + $ref: "#/components/schemas/Geometry" + minItems: 0 + bbox: + $ref: "#/components/schemas/BBox" + Position: + x-namespace: Geo + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.1 + description: | + GeoJSon fundamental geometry construct. + + A position is an array of numbers. There MUST be two or more elements. + The first two elements are longitude and latitude, precisely in that order and using decimal numbers. + Altitude or elevation MAY be included as an optional third element. + + Implementations SHOULD NOT extend positions beyond three elements + because the semantics of extra elements are unspecified and ambiguous. + Historically, some implementations have used a fourth element to carry + a linear referencing measure (sometimes denoted as "M") or a numerical + timestamp, but in most situations a parser will not be able to properly + interpret these values. The interpretation and meaning of additional + elements is beyond the scope of this specification, and additional + elements MAY be ignored by parsers. + type: array + items: + $ref: "#/components/schemas/Coordinate" + minItems: 2 + maxItems: 3 + BBox: + x-namespace: Geo + externalDocs: + url: https://datatracker.ietf.org/doc/html/rfc7946#section-5 + description: | + A GeoJSON object MAY have a member named "bbox" to include + information on the coordinate range for its Geometries, Features, or + FeatureCollections. The value of the bbox member MUST be an array of + length 2*n where n is the number of dimensions represented in the + contained geometries, with all axes of the most southwesterly point + followed by all axes of the more northeasterly point. The axes order + of a bbox follows the axes order of geometries. + type: array + items: + $ref: "#/components/schemas/Coordinate" + Coordinate: + x-namespace: Geo + type: number + format: double + x-safety: unsafe + Action: + type: string + x-safety: unsafe x-namespace: Ontologies - properties: - metricName: - type: string - x-safety: unsafe - required: - - metricName - AggregationFixedWidthGrouping: - description: Divides objects into groups with the specified width. - type: object + Query: + type: string + x-safety: unsafe x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - fixedWidth: - type: integer - x-safety: safe - required: - - field - - fixedWidth - AggregationRangesGrouping: - description: Divides objects into groups according to specified ranges. - type: object + LinkedObjectV2: + type: string + x-safety: unsafe x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - ranges: - items: - $ref: "#/components/schemas/AggregationRange" - type: array - required: - - field - AggregationExactGrouping: - description: Divides objects into groups according to an exact value. - type: object + AttachmentPropertyV2: + type: string + x-safety: unsafe x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - maxGroupCount: - type: integer - x-safety: safe - required: - - field - AggregationDurationGrouping: - description: | - Divides objects into groups according to an interval. Note that this grouping applies only on date types. - The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. - type: object + TimeSeriesPropertyV2: + type: string + x-safety: unsafe x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - duration: - $ref: "#/components/schemas/Duration" - required: - - field - - duration - MaxAggregation: - description: Computes the maximum value for the provided field. - type: object + OntologyInterface: + type: string + x-safety: unsafe x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - name: - $ref: "#/components/schemas/AggregationMetricName" - required: - - field - MinAggregation: - description: Computes the minimum value for the provided field. - type: object + OntologyObjectSet: + type: string + x-safety: unsafe x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - name: - $ref: "#/components/schemas/AggregationMetricName" - required: - - field - AvgAggregation: - description: Computes the average value for the provided field. - type: object + ArtifactRepositoryRid: + type: string + format: rid + x-safety: safe x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - name: - $ref: "#/components/schemas/AggregationMetricName" - required: - - field - SumAggregation: - description: Computes the sum of values for the provided field. - type: object + SdkPackageName: + type: string + x-safety: unsafe x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/FieldNameV1" - name: - $ref: "#/components/schemas/AggregationMetricName" - required: - - field - CountAggregation: - description: Computes the total count of objects. - type: object + ObjectSetRid: + type: string + format: rid + x-safety: safe x-namespace: Ontologies - properties: - name: - $ref: "#/components/schemas/AggregationMetricName" - ApproximateDistinctAggregation: - description: Computes an approximate number of distinct values for the provided field. + CreateTemporaryObjectSetRequestV2: type: object x-namespace: Ontologies properties: - field: - $ref: "#/components/schemas/FieldNameV1" - name: - $ref: "#/components/schemas/AggregationMetricName" - required: - - field - ActionParameterArrayType: - type: object - properties: - subType: - $ref: "#/components/schemas/ActionParameterType" - required: - - subType - ActionParameterType: - description: | - A union of all the types supported by Ontology Action parameters. - discriminator: - propertyName: type - mapping: - array: "#/components/schemas/ActionParameterArrayType" - attachment: "#/components/schemas/AttachmentType" - boolean: "#/components/schemas/BooleanType" - date: "#/components/schemas/DateType" - double: "#/components/schemas/DoubleType" - integer: "#/components/schemas/IntegerType" - long: "#/components/schemas/LongType" - marking: "#/components/schemas/MarkingType" - objectSet: "#/components/schemas/OntologyObjectSetType" - object: "#/components/schemas/OntologyObjectType" - string: "#/components/schemas/StringType" - timestamp: "#/components/schemas/TimestampType" - oneOf: - - $ref: "#/components/schemas/ActionParameterArrayType" - - $ref: "#/components/schemas/AttachmentType" - - $ref: "#/components/schemas/BooleanType" - - $ref: "#/components/schemas/DateType" - - $ref: "#/components/schemas/DoubleType" - - $ref: "#/components/schemas/IntegerType" - - $ref: "#/components/schemas/LongType" - - $ref: "#/components/schemas/MarkingType" - - $ref: "#/components/schemas/OntologyObjectSetType" - - $ref: "#/components/schemas/OntologyObjectType" - - $ref: "#/components/schemas/StringType" - - $ref: "#/components/schemas/TimestampType" - OntologyDataType: - description: | - A union of all the primitive types used by Palantir's Ontology-based products. - discriminator: - propertyName: type - mapping: - any: "#/components/schemas/AnyType" - binary: "#/components/schemas/BinaryType" - boolean: "#/components/schemas/BooleanType" - byte: "#/components/schemas/ByteType" - date: "#/components/schemas/DateType" - decimal: "#/components/schemas/DecimalType" - double: "#/components/schemas/DoubleType" - float: "#/components/schemas/FloatType" - integer: "#/components/schemas/IntegerType" - long: "#/components/schemas/LongType" - marking: "#/components/schemas/MarkingType" - short: "#/components/schemas/ShortType" - string: "#/components/schemas/StringType" - timestamp: "#/components/schemas/TimestampType" - array: "#/components/schemas/OntologyArrayType" - map: "#/components/schemas/OntologyMapType" - set: "#/components/schemas/OntologySetType" - struct: "#/components/schemas/OntologyStructType" - object: "#/components/schemas/OntologyObjectType" - objectSet: "#/components/schemas/OntologyObjectSetType" - unsupported: "#/components/schemas/UnsupportedType" - oneOf: - - $ref: "#/components/schemas/AnyType" - - $ref: "#/components/schemas/BinaryType" - - $ref: "#/components/schemas/BooleanType" - - $ref: "#/components/schemas/ByteType" - - $ref: "#/components/schemas/DateType" - - $ref: "#/components/schemas/DecimalType" - - $ref: "#/components/schemas/DoubleType" - - $ref: "#/components/schemas/FloatType" - - $ref: "#/components/schemas/IntegerType" - - $ref: "#/components/schemas/LongType" - - $ref: "#/components/schemas/MarkingType" - - $ref: "#/components/schemas/ShortType" - - $ref: "#/components/schemas/StringType" - - $ref: "#/components/schemas/TimestampType" - - $ref: "#/components/schemas/OntologyArrayType" - - $ref: "#/components/schemas/OntologyMapType" - - $ref: "#/components/schemas/OntologySetType" - - $ref: "#/components/schemas/OntologyStructType" - - $ref: "#/components/schemas/OntologyObjectType" - - $ref: "#/components/schemas/OntologyObjectSetType" - - $ref: "#/components/schemas/UnsupportedType" - OntologyObjectSetType: - type: object - properties: - objectApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - objectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - OntologyObjectType: - type: object - properties: - objectApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - objectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - required: - - objectApiName - - objectTypeApiName - OntologyArrayType: - type: object - properties: - itemType: - $ref: "#/components/schemas/OntologyDataType" + objectSet: + $ref: "#/components/schemas/ObjectSet" required: - - itemType - OntologyMapType: + - objectSet + CreateTemporaryObjectSetResponseV2: type: object + x-namespace: Ontologies properties: - keyType: - $ref: "#/components/schemas/OntologyDataType" - valueType: - $ref: "#/components/schemas/OntologyDataType" + objectSetRid: + $ref: "#/components/schemas/ObjectSetRid" required: - - keyType - - valueType - OntologySetType: + - objectSetRid + AggregateObjectSetRequestV2: type: object + x-namespace: Ontologies properties: - itemType: - $ref: "#/components/schemas/OntologyDataType" + aggregation: + items: + $ref: "#/components/schemas/AggregationV2" + type: array + objectSet: + $ref: "#/components/schemas/ObjectSet" + groupBy: + items: + $ref: "#/components/schemas/AggregationGroupByV2" + type: array + accuracy: + $ref: "#/components/schemas/AggregationAccuracyRequest" required: - - itemType - OntologyStructType: + - objectSet + ActionTypeV2: type: object + x-namespace: Ontologies + description: Represents an action type in the Ontology. properties: - fields: + apiName: + $ref: "#/components/schemas/ActionTypeApiName" + description: + type: string + x-safety: unsafe + displayName: + $ref: "#/components/schemas/DisplayName" + status: + $ref: "#/components/schemas/ReleaseStatus" + parameters: + additionalProperties: + $ref: "#/components/schemas/ActionParameterV2" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + rid: + $ref: "#/components/schemas/ActionTypeRid" + operations: type: array items: - $ref: "#/components/schemas/OntologyStructField" - OntologyStructField: - type: object + $ref: "#/components/schemas/LogicRule" + required: + - apiName + - status + - rid + ActionParameterV2: + description: Details about a parameter of an action. properties: - name: - $ref: "#/components/schemas/StructFieldName" - fieldType: - $ref: "#/components/schemas/OntologyDataType" + description: + type: string + x-safety: unsafe + dataType: + $ref: "#/components/schemas/ActionParameterType" required: type: boolean x-safety: safe required: - - name + - dataType - required - - fieldType - QueryDataType: - description: | - A union of all the types supported by Ontology Query parameters or outputs. + type: object + x-namespace: Ontologies + BatchApplyActionRequestItem: + x-namespace: Ontologies + type: object + properties: + parameters: + nullable: true + additionalProperties: + $ref: "#/components/schemas/DataValue" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + BatchApplyActionRequestV2: + properties: + options: + $ref: "#/components/schemas/BatchApplyActionRequestOptions" + requests: + type: array + items: + $ref: "#/components/schemas/BatchApplyActionRequestItem" + type: object + x-namespace: Ontologies + BatchApplyActionResponseV2: + type: object + x-namespace: Ontologies + properties: + edits: + $ref: "#/components/schemas/ActionResults" + ListActionTypesResponseV2: + properties: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + items: + $ref: "#/components/schemas/ActionTypeV2" + type: array + type: object + x-namespace: Ontologies + ListInterfaceTypesResponse: + properties: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + items: + $ref: "#/components/schemas/InterfaceType" + type: array + type: object + x-namespace: Ontologies + SearchObjectsForInterfaceRequest: + type: object + x-namespace: Ontologies + properties: + where: + $ref: "#/components/schemas/SearchJsonQueryV2" + orderBy: + $ref: "#/components/schemas/SearchOrderByV2" + augmentedProperties: + description: "A map from object type API name to a list of property type API names. For each returned object, if the \nobject’s object type is a key in the map, then we augment the response for that object type with the list \nof properties specified in the value.\n" + additionalProperties: + items: + $ref: "#/components/schemas/PropertyApiName" + type: array + x-mapKey: + $ref: "#/components/schemas/ObjectTypeApiName" + augmentedSharedPropertyTypes: + description: "A map from interface type API name to a list of shared property type API names. For each returned object, if\nthe object implements an interface that is a key in the map, then we augment the response for that object \ntype with the list of properties specified in the value.\n" + additionalProperties: + items: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + type: array + x-mapKey: + $ref: "#/components/schemas/InterfaceTypeApiName" + selectedSharedPropertyTypes: + description: "A list of shared property type API names of the interface type that should be included in the response. \nOmit this parameter to include all properties of the interface type in the response.\n" + type: array + items: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + selectedObjectTypes: + description: "A list of object type API names that should be included in the response. If non-empty, object types that are\nnot mentioned will not be included in the response even if they implement the specified interface. Omit the \nparameter to include all object types.\n" + type: array + items: + $ref: "#/components/schemas/ObjectTypeApiName" + otherInterfaceTypes: + description: "A list of interface type API names. Object types must implement all the mentioned interfaces in order to be \nincluded in the response.\n" + type: array + items: + $ref: "#/components/schemas/InterfaceTypeApiName" + pageSize: + $ref: "#/components/schemas/PageSize" + pageToken: + $ref: "#/components/schemas/PageToken" + ListQueryTypesResponseV2: + properties: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + items: + $ref: "#/components/schemas/QueryTypeV2" + type: array + type: object + x-namespace: Ontologies + ListAttachmentsResponseV2: + type: object + x-namespace: Ontologies + properties: + data: + items: + $ref: "#/components/schemas/AttachmentV2" + type: array + nextPageToken: + $ref: "#/components/schemas/PageToken" + AttachmentMetadataResponse: + description: The attachment metadata response + type: object + x-namespace: Ontologies discriminator: propertyName: type mapping: - array: "#/components/schemas/QueryArrayType" - attachment: "#/components/schemas/AttachmentType" - boolean: "#/components/schemas/BooleanType" - date: "#/components/schemas/DateType" - double: "#/components/schemas/DoubleType" - float: "#/components/schemas/FloatType" - integer: "#/components/schemas/IntegerType" - long: "#/components/schemas/LongType" - objectSet: "#/components/schemas/OntologyObjectSetType" - object: "#/components/schemas/OntologyObjectType" - set: "#/components/schemas/QuerySetType" - string: "#/components/schemas/StringType" - struct: "#/components/schemas/QueryStructType" - threeDimensionalAggregation: "#/components/schemas/ThreeDimensionalAggregation" - timestamp: "#/components/schemas/TimestampType" - twoDimensionalAggregation: "#/components/schemas/TwoDimensionalAggregation" - union: "#/components/schemas/QueryUnionType" - "null": "#/components/schemas/NullType" - unsupported: "#/components/schemas/UnsupportedType" + single: "#/components/schemas/AttachmentV2" + multiple: "#/components/schemas/ListAttachmentsResponseV2" oneOf: - - $ref: "#/components/schemas/QueryArrayType" - - $ref: "#/components/schemas/AttachmentType" - - $ref: "#/components/schemas/BooleanType" - - $ref: "#/components/schemas/DateType" - - $ref: "#/components/schemas/DoubleType" - - $ref: "#/components/schemas/FloatType" - - $ref: "#/components/schemas/IntegerType" - - $ref: "#/components/schemas/LongType" - - $ref: "#/components/schemas/OntologyObjectSetType" - - $ref: "#/components/schemas/OntologyObjectType" - - $ref: "#/components/schemas/QuerySetType" - - $ref: "#/components/schemas/StringType" - - $ref: "#/components/schemas/QueryStructType" - - $ref: "#/components/schemas/ThreeDimensionalAggregation" - - $ref: "#/components/schemas/TimestampType" - - $ref: "#/components/schemas/TwoDimensionalAggregation" - - $ref: "#/components/schemas/QueryUnionType" - - $ref: "#/components/schemas/NullType" - - $ref: "#/components/schemas/UnsupportedType" - QueryArrayType: + - $ref: "#/components/schemas/AttachmentV2" + - $ref: "#/components/schemas/ListAttachmentsResponseV2" + AbsoluteTimeRange: + description: ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive. + type: object + x-namespace: Ontologies + properties: + startTime: + type: string + format: date-time + x-safety: unsafe + endTime: + type: string + format: date-time + x-safety: unsafe + ActionMode: + x-namespace: Ontologies + enum: + - ASYNC + - RUN + - VALIDATE + AsyncApplyActionResponseV2: type: object + x-namespace: Ontologies properties: - subType: - $ref: "#/components/schemas/QueryDataType" + operationId: + type: string + format: rid + x-safety: safe required: - - subType - QuerySetType: + - operationId + SyncApplyActionResponseV2: type: object + x-namespace: Ontologies properties: - subType: - $ref: "#/components/schemas/QueryDataType" - required: - - subType - QueryStructType: + validation: + $ref: "#/components/schemas/ValidateActionResponseV2" + edits: + $ref: "#/components/schemas/ActionResults" + ActionResults: + x-namespace: Ontologies + discriminator: + propertyName: type + mapping: + edits: "#/components/schemas/ObjectEdits" + largeScaleEdits: "#/components/schemas/ObjectTypeEdits" + oneOf: + - $ref: "#/components/schemas/ObjectEdits" + - $ref: "#/components/schemas/ObjectTypeEdits" + ObjectTypeEdits: + x-namespace: Ontologies type: object properties: - fields: + editedObjectTypes: type: array items: - $ref: "#/components/schemas/QueryStructField" - QueryStructField: - type: object - properties: - name: - $ref: "#/components/schemas/StructFieldName" - fieldType: - $ref: "#/components/schemas/QueryDataType" - required: - - name - - fieldType - QueryUnionType: + $ref: "#/components/schemas/ObjectTypeApiName" + ObjectEdits: + x-namespace: Ontologies type: object properties: - unionTypes: + edits: type: array items: - $ref: "#/components/schemas/QueryDataType" - QueryAggregationRangeType: - type: object - properties: - subType: - $ref: "#/components/schemas/QueryAggregationRangeSubType" + $ref: "#/components/schemas/ObjectEdit" + addedObjectCount: + type: integer + x-safety: safe + modifiedObjectsCount: + type: integer + x-safety: safe + deletedObjectsCount: + type: integer + x-safety: safe + addedLinksCount: + type: integer + x-safety: safe + deletedLinksCount: + type: integer + x-safety: safe required: - - subType - QueryAggregationRangeSubType: - description: | - A union of all the types supported by query aggregation ranges. - discriminator: - propertyName: type - mapping: - date: "#/components/schemas/DateType" - double: "#/components/schemas/DoubleType" - integer: "#/components/schemas/IntegerType" - timestamp: "#/components/schemas/TimestampType" - oneOf: - - $ref: "#/components/schemas/DateType" - - $ref: "#/components/schemas/DoubleType" - - $ref: "#/components/schemas/IntegerType" - - $ref: "#/components/schemas/TimestampType" - QueryAggregationKeyType: - description: | - A union of all the types supported by query aggregation keys. - discriminator: - propertyName: type - mapping: - boolean: "#/components/schemas/BooleanType" - date: "#/components/schemas/DateType" - double: "#/components/schemas/DoubleType" - integer: "#/components/schemas/IntegerType" - string: "#/components/schemas/StringType" - timestamp: "#/components/schemas/TimestampType" - range: "#/components/schemas/QueryAggregationRangeType" - oneOf: - - $ref: "#/components/schemas/BooleanType" - - $ref: "#/components/schemas/DateType" - - $ref: "#/components/schemas/DoubleType" - - $ref: "#/components/schemas/IntegerType" - - $ref: "#/components/schemas/StringType" - - $ref: "#/components/schemas/TimestampType" - - $ref: "#/components/schemas/QueryAggregationRangeType" - QueryAggregationValueType: - description: | - A union of all the types supported by query aggregation keys. + - addedObjectCount + - modifiedObjectsCount + - deletedObjectsCount + - addedLinksCount + - deletedLinksCount + ObjectEdit: + x-namespace: Ontologies discriminator: propertyName: type mapping: - date: "#/components/schemas/DateType" - double: "#/components/schemas/DoubleType" - timestamp: "#/components/schemas/TimestampType" + addObject: "#/components/schemas/AddObject" + modifyObject: "#/components/schemas/ModifyObject" + addLink: "#/components/schemas/AddLink" oneOf: - - $ref: "#/components/schemas/DateType" - - $ref: "#/components/schemas/DoubleType" - - $ref: "#/components/schemas/TimestampType" - TwoDimensionalAggregation: + - $ref: "#/components/schemas/AddObject" + - $ref: "#/components/schemas/ModifyObject" + - $ref: "#/components/schemas/AddLink" + AddObject: + x-namespace: Ontologies type: object properties: - keyType: - $ref: "#/components/schemas/QueryAggregationKeyType" - valueType: - $ref: "#/components/schemas/QueryAggregationValueType" + primaryKey: + $ref: "#/components/schemas/PropertyValue" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" required: - - keyType - - valueType - ThreeDimensionalAggregation: + - primaryKey + - objectType + ModifyObject: + x-namespace: Ontologies type: object properties: - keyType: - $ref: "#/components/schemas/QueryAggregationKeyType" - valueType: - $ref: "#/components/schemas/TwoDimensionalAggregation" + primaryKey: + $ref: "#/components/schemas/PropertyValue" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" required: - - keyType - - valueType - ValueType: + - primaryKey + - objectType + AddLink: + x-namespace: Ontologies + type: object + properties: + linkTypeApiNameAtoB: + $ref: "#/components/schemas/LinkTypeApiName" + linkTypeApiNameBtoA: + $ref: "#/components/schemas/LinkTypeApiName" + aSideObject: + $ref: "#/components/schemas/LinkSideObject" + bSideObject: + $ref: "#/components/schemas/LinkSideObject" + required: + - linkTypeApiNameAtoB + - linkTypeApiNameBtoA + - aSideObject + - bSideObject + LinkSideObject: + x-namespace: Ontologies + type: object + properties: + primaryKey: + $ref: "#/components/schemas/PropertyValue" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - primaryKey + - objectType + LinkTypeRid: type: string + format: rid x-safety: safe - description: | - A string indicating the type of each data value. Note that these types can be nested, for example an array of - structs. - - | Type | JSON value | - |---------------------|-------------------------------------------------------------------------------------------------------------------| - | Array | `Array`, where `T` is the type of the array elements, e.g. `Array`. | - | Attachment | `Attachment` | - | Boolean | `Boolean` | - | Byte | `Byte` | - | Date | `LocalDate` | - | Decimal | `Decimal` | - | Double | `Double` | - | Float | `Float` | - | Integer | `Integer` | - | Long | `Long` | - | Marking | `Marking` | - | OntologyObject | `OntologyObject` where `T` is the API name of the referenced object type. | - | Short | `Short` | - | String | `String` | - | Struct | `Struct` where `T` contains field name and type pairs, e.g. `Struct<{ firstName: String, lastName: string }>` | - | Timeseries | `TimeSeries` where `T` is either `String` for an enum series or `Double` for a numeric series. | - | Timestamp | `Timestamp` | - ArraySizeConstraint: - description: | - The parameter expects an array of values and the size of the array must fall within the defined range. + x-namespace: Ontologies + LinkTypeSideV2: + type: object + x-namespace: Ontologies + properties: + apiName: + $ref: "#/components/schemas/LinkTypeApiName" + displayName: + $ref: "#/components/schemas/DisplayName" + status: + $ref: "#/components/schemas/ReleaseStatus" + objectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + cardinality: + $ref: "#/components/schemas/LinkTypeSideCardinality" + foreignKeyPropertyApiName: + $ref: "#/components/schemas/PropertyApiName" + linkTypeRid: + $ref: "#/components/schemas/LinkTypeRid" + required: + - apiName + - displayName + - status + - objectTypeApiName + - cardinality + - linkTypeRid + ListOutgoingLinkTypesResponseV2: + properties: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + description: The list of link type sides in the current page. + items: + $ref: "#/components/schemas/LinkTypeSideV2" + type: array + type: object + x-namespace: Ontologies + ApplyActionRequestV2: + x-namespace: Ontologies type: object properties: - lt: - description: Less than - x-safety: unsafe - lte: - description: Less than or equal - x-safety: unsafe - gt: - description: Greater than - x-safety: unsafe - gte: - description: Greater than or equal - x-safety: unsafe - GroupMemberConstraint: - description: | - The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. + options: + $ref: "#/components/schemas/ApplyActionRequestOptions" + parameters: + nullable: true + additionalProperties: + $ref: "#/components/schemas/DataValue" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + ApplyActionMode: + x-namespace: Ontologies + enum: + - VALIDATE_ONLY + - VALIDATE_AND_EXECUTE + ApplyActionRequestOptions: type: object x-namespace: Ontologies - ObjectPropertyValueConstraint: - description: | - The parameter value must be a property value of an object found within an object set. + properties: + mode: + $ref: "#/components/schemas/ApplyActionMode" + returnEdits: + $ref: "#/components/schemas/ReturnEditsMode" + BatchApplyActionRequestOptions: type: object x-namespace: Ontologies - ObjectQueryResultConstraint: - description: | - The parameter value must be the primary key of an object found within an object set. + properties: + returnEdits: + $ref: "#/components/schemas/ReturnEditsMode" + ReturnEditsMode: + x-namespace: Ontologies + enum: + - ALL + - NONE + AsyncApplyActionRequestV2: + properties: + parameters: + nullable: true + additionalProperties: + $ref: "#/components/schemas/DataValue" + x-mapKey: + $ref: "#/components/schemas/ParameterId" type: object x-namespace: Ontologies - OneOfConstraint: - description: | - The parameter has a manually predefined set of options. + AsyncApplyActionOperationResponseV2: type: object x-namespace: Ontologies - properties: - options: - type: array - items: - $ref: "#/components/schemas/ParameterOption" - otherValuesAllowed: - description: "A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed \"Other\" value** toggle in the **Ontology Manager**." - type: boolean - x-safety: unsafe - required: - - otherValuesAllowed - RangeConstraint: - description: | - The parameter value must be within the defined range. + AsyncApplyActionOperationV2: + x-type: + type: asyncOperation + operationType: applyActionAsyncV2 + resultType: AsyncApplyActionOperationResponseV2 + stageType: AsyncActionStatus + x-namespace: Ontologies + AttachmentV2: type: object x-namespace: Ontologies + description: The representation of an attachment. properties: - lt: - description: Less than - x-safety: unsafe - lte: - description: Less than or equal - x-safety: unsafe - gt: - description: Greater than - x-safety: unsafe - gte: - description: Greater than or equal - x-safety: unsafe - StringLengthConstraint: - description: | - The parameter value must have a length within the defined range. - *This range is always inclusive.* + rid: + $ref: "#/components/schemas/AttachmentRid" + filename: + $ref: "#/components/schemas/Filename" + sizeBytes: + $ref: "#/components/schemas/SizeBytes" + mediaType: + $ref: "#/components/schemas/MediaType" + required: + - rid + - filename + - sizeBytes + - mediaType + ListLinkedObjectsResponseV2: type: object x-namespace: Ontologies properties: - lt: - description: Less than - x-safety: unsafe - lte: - description: Less than or equal - x-safety: unsafe - gt: - description: Greater than - x-safety: unsafe - gte: - description: Greater than or equal - x-safety: unsafe - StringRegexMatchConstraint: - description: | - The parameter value must match a predefined regular expression. + data: + items: + $ref: "#/components/schemas/OntologyObjectV2" + type: array + nextPageToken: + $ref: "#/components/schemas/PageToken" + ListObjectsResponseV2: type: object x-namespace: Ontologies properties: - regex: - description: The regular expression configured in the **Ontology Manager**. - type: string - x-safety: unsafe - configuredFailureMessage: - description: | - The message indicating that the regular expression was not matched. - This is configured per parameter in the **Ontology Manager**. - type: string - x-safety: unsafe + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + type: array + description: The list of objects in the current page. + items: + $ref: "#/components/schemas/OntologyObjectV2" + totalCount: + $ref: "#/components/schemas/TotalCount" required: - - regex - UnevaluableConstraint: - description: | - The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. - This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. - type: object - x-namespace: Ontologies - ParameterEvaluatedConstraint: - description: "A constraint that an action parameter value must satisfy in order to be considered valid.\nConstraints can be configured on action parameters in the **Ontology Manager**. \nApplicable constraints are determined dynamically based on parameter inputs. \nParameter values are evaluated against the final set of constraints.\n\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. |\n| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. |\n| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. |\n| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. |\n| `oneOf` | The parameter has a manually predefined set of options. |\n| `range` | The parameter value must be within the defined range. |\n| `stringLength` | The parameter value must have a length within the defined range. |\n| `stringRegexMatch` | The parameter value must match a predefined regular expression. |\n| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. |\n" + - totalCount + CountObjectsResponseV2: type: object x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - arraySize: "#/components/schemas/ArraySizeConstraint" - groupMember: "#/components/schemas/GroupMemberConstraint" - objectPropertyValue: "#/components/schemas/ObjectPropertyValueConstraint" - objectQueryResult: "#/components/schemas/ObjectQueryResultConstraint" - oneOf: "#/components/schemas/OneOfConstraint" - range: "#/components/schemas/RangeConstraint" - stringLength: "#/components/schemas/StringLengthConstraint" - stringRegexMatch: "#/components/schemas/StringRegexMatchConstraint" - unevaluable: "#/components/schemas/UnevaluableConstraint" - oneOf: - - $ref: "#/components/schemas/ArraySizeConstraint" - - $ref: "#/components/schemas/GroupMemberConstraint" - - $ref: "#/components/schemas/ObjectPropertyValueConstraint" - - $ref: "#/components/schemas/ObjectQueryResultConstraint" - - $ref: "#/components/schemas/OneOfConstraint" - - $ref: "#/components/schemas/RangeConstraint" - - $ref: "#/components/schemas/StringLengthConstraint" - - $ref: "#/components/schemas/StringRegexMatchConstraint" - - $ref: "#/components/schemas/UnevaluableConstraint" - ParameterEvaluationResult: - description: Represents the validity of a parameter against the configured constraints. + properties: + count: + type: integer + x-safety: unsafe + LoadObjectSetResponseV2: + description: Represents the API response when loading an `ObjectSet`. type: object x-namespace: Ontologies properties: - result: - $ref: "#/components/schemas/ValidationResult" - evaluatedConstraints: + data: type: array + description: The list of objects in the current Page. items: - $ref: "#/components/schemas/ParameterEvaluatedConstraint" - required: - description: Represents whether the parameter is a required input to the action. - type: boolean - x-safety: unsafe + $ref: "#/components/schemas/OntologyObjectV2" + nextPageToken: + $ref: "#/components/schemas/PageToken" + totalCount: + $ref: "#/components/schemas/TotalCount" required: - - result - - required - ParameterOption: - description: | - A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins. + - totalCount + LoadObjectSetRequestV2: + description: Represents the API POST body when loading an `ObjectSet`. type: object x-namespace: Ontologies properties: - displayName: - $ref: "#/components/schemas/DisplayName" - value: - description: An allowed configured value for a parameter within an action. - x-safety: unsafe - ActionType: - description: Represents an action type in the Ontology. - properties: - apiName: - $ref: "#/components/schemas/ActionTypeApiName" - description: - type: string - x-safety: unsafe - displayName: - $ref: "#/components/schemas/DisplayName" - status: - $ref: "#/components/schemas/ReleaseStatus" - parameters: - additionalProperties: - $ref: "#/components/schemas/Parameter" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - rid: - $ref: "#/components/schemas/ActionTypeRid" - operations: + objectSet: + $ref: "#/components/schemas/ObjectSet" + orderBy: + $ref: "#/components/schemas/SearchOrderByV2" + select: type: array items: - $ref: "#/components/schemas/LogicRule" + $ref: "#/components/schemas/SelectedPropertyApiName" + pageToken: + $ref: "#/components/schemas/PageToken" + pageSize: + $ref: "#/components/schemas/PageSize" + excludeRid: + description: | + A flag to exclude the retrieval of the `__rid` property. + Setting this to true may improve performance of this endpoint for object types in OSV2. + type: boolean + x-safety: safe required: - - apiName - - status - - rid + - objectSet + ObjectSet: + description: Represents the definition of an `ObjectSet` in the `Ontology`. type: object x-namespace: Ontologies - LogicRule: discriminator: propertyName: type mapping: - createObject: "#/components/schemas/CreateObjectRule" - modifyObject: "#/components/schemas/ModifyObjectRule" - deleteObject: "#/components/schemas/DeleteObjectRule" - createLink: "#/components/schemas/CreateLinkRule" - deleteLink: "#/components/schemas/DeleteLinkRule" + base: "#/components/schemas/ObjectSetBaseType" + static: "#/components/schemas/ObjectSetStaticType" + reference: "#/components/schemas/ObjectSetReferenceType" + filter: "#/components/schemas/ObjectSetFilterType" + union: "#/components/schemas/ObjectSetUnionType" + intersect: "#/components/schemas/ObjectSetIntersectionType" + subtract: "#/components/schemas/ObjectSetSubtractType" + searchAround: "#/components/schemas/ObjectSetSearchAroundType" oneOf: - - $ref: "#/components/schemas/CreateObjectRule" - - $ref: "#/components/schemas/ModifyObjectRule" - - $ref: "#/components/schemas/DeleteObjectRule" - - $ref: "#/components/schemas/CreateLinkRule" - - $ref: "#/components/schemas/DeleteLinkRule" - CreateObjectRule: + - $ref: "#/components/schemas/ObjectSetBaseType" + - $ref: "#/components/schemas/ObjectSetStaticType" + - $ref: "#/components/schemas/ObjectSetReferenceType" + - $ref: "#/components/schemas/ObjectSetFilterType" + - $ref: "#/components/schemas/ObjectSetUnionType" + - $ref: "#/components/schemas/ObjectSetIntersectionType" + - $ref: "#/components/schemas/ObjectSetSubtractType" + - $ref: "#/components/schemas/ObjectSetSearchAroundType" + ObjectSetBaseType: type: object + x-namespace: Ontologies properties: - objectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" + objectType: + type: string + x-safety: unsafe required: - - objectTypeApiName - ModifyObjectRule: + - objectType + ObjectSetStaticType: type: object + x-namespace: Ontologies properties: - objectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - required: - - objectTypeApiName - DeleteObjectRule: + objects: + type: array + items: + $ref: "#/components/schemas/ObjectRid" + ObjectSetReferenceType: type: object + x-namespace: Ontologies properties: - objectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" + reference: + type: string + format: rid + x-safety: safe required: - - objectTypeApiName - CreateLinkRule: + - reference + ObjectSetFilterType: type: object + x-namespace: Ontologies properties: - linkTypeApiNameAtoB: - $ref: "#/components/schemas/LinkTypeApiName" - linkTypeApiNameBtoA: - $ref: "#/components/schemas/LinkTypeApiName" - aSideObjectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - bSideObjectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" + objectSet: + $ref: "#/components/schemas/ObjectSet" + where: + $ref: "#/components/schemas/SearchJsonQueryV2" required: - - linkTypeApiNameAtoB - - linkTypeApiNameBtoA - - aSideObjectTypeApiName - - bSideObjectTypeApiName - DeleteLinkRule: + - objectSet + - where + ObjectSetUnionType: type: object - properties: - linkTypeApiNameAtoB: - $ref: "#/components/schemas/LinkTypeApiName" - linkTypeApiNameBtoA: - $ref: "#/components/schemas/LinkTypeApiName" - aSideObjectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - bSideObjectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - required: - - linkTypeApiNameAtoB - - linkTypeApiNameBtoA - - aSideObjectTypeApiName - - bSideObjectTypeApiName - ActionTypeApiName: - description: | - The name of the action type in the API. To find the API name for your Action Type, use the `List action types` - endpoint or check the **Ontology Manager**. - type: string - x-safety: unsafe - x-namespace: Ontologies - ActionTypeRid: - description: | - The unique resource identifier of an action type, useful for interacting with other Foundry APIs. - format: rid - type: string - x-safety: safe x-namespace: Ontologies - ApplyActionRequest: properties: - parameters: - nullable: true - additionalProperties: - $ref: "#/components/schemas/DataValue" - x-mapKey: - $ref: "#/components/schemas/ParameterId" + objectSets: + type: array + items: + $ref: "#/components/schemas/ObjectSet" + ObjectSetIntersectionType: type: object x-namespace: Ontologies - BatchApplyActionRequest: properties: - requests: + objectSets: type: array items: - $ref: "#/components/schemas/ApplyActionRequest" + $ref: "#/components/schemas/ObjectSet" + ObjectSetSubtractType: type: object x-namespace: Ontologies - AsyncApplyActionRequest: properties: - parameters: - nullable: true - additionalProperties: - $ref: "#/components/schemas/DataValue" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - type: object - x-namespace: Ontologies - ApplyActionResponse: - type: object - x-namespace: Ontologies - BatchApplyActionResponse: + objectSets: + type: array + items: + $ref: "#/components/schemas/ObjectSet" + ObjectSetSearchAroundType: type: object x-namespace: Ontologies - QueryType: - description: Represents a query type in the Ontology. properties: - apiName: - $ref: "#/components/schemas/QueryApiName" - description: - type: string - x-safety: unsafe - displayName: - $ref: "#/components/schemas/DisplayName" - parameters: - additionalProperties: - $ref: "#/components/schemas/Parameter" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - output: - $ref: "#/components/schemas/OntologyDataType" - rid: - $ref: "#/components/schemas/FunctionRid" - version: - $ref: "#/components/schemas/FunctionVersion" + objectSet: + $ref: "#/components/schemas/ObjectSet" + link: + $ref: "#/components/schemas/LinkTypeApiName" required: - - apiName - - rid - - version - type: object - x-namespace: Ontologies - QueryApiName: - description: | - The name of the Query in the API. - type: string - x-safety: unsafe - x-namespace: Ontologies - ExecuteQueryRequest: + - objectSet + - link + OntologyV2: + $ref: "#/components/schemas/Ontology" + OntologyFullMetadata: properties: - parameters: - nullable: true + ontology: + $ref: "#/components/schemas/OntologyV2" + objectTypes: additionalProperties: - $ref: "#/components/schemas/DataValue" + $ref: "#/components/schemas/ObjectTypeFullMetadata" x-mapKey: - $ref: "#/components/schemas/ParameterId" - type: object - x-namespace: Ontologies - Attachment: + $ref: "#/components/schemas/ObjectTypeApiName" + actionTypes: + additionalProperties: + $ref: "#/components/schemas/ActionTypeV2" + x-mapKey: + $ref: "#/components/schemas/ActionTypeApiName" + queryTypes: + additionalProperties: + $ref: "#/components/schemas/QueryTypeV2" + x-mapKey: + $ref: "#/components/schemas/QueryApiName" + interfaceTypes: + additionalProperties: + $ref: "#/components/schemas/InterfaceType" + x-mapKey: + $ref: "#/components/schemas/InterfaceTypeApiName" + sharedPropertyTypes: + additionalProperties: + $ref: "#/components/schemas/SharedPropertyType" + x-mapKey: + $ref: "#/components/schemas/SharedPropertyTypeApiName" type: object x-namespace: Ontologies - description: The representation of an attachment. - properties: - rid: - $ref: "#/components/schemas/AttachmentRid" - filename: - $ref: "#/components/schemas/Filename" - sizeBytes: - $ref: "#/components/schemas/SizeBytes" - mediaType: - $ref: "#/components/schemas/MediaType" required: - - rid - - filename - - sizeBytes - - mediaType - AttachmentProperty: - type: object + - ontology + OntologyObjectV2: + description: Represents an object in the Ontology. + additionalProperties: + $ref: "#/components/schemas/PropertyValue" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + x-namespace: Ontologies + OntologyIdentifier: + description: Either an ontology rid or an ontology api name. + type: string + x-safety: unsafe x-namespace: Ontologies - description: The representation of an attachment as a data type. + QueryTypeV2: + description: Represents a query type in the Ontology. properties: + apiName: + $ref: "#/components/schemas/QueryApiName" + description: + type: string + x-safety: unsafe + displayName: + $ref: "#/components/schemas/DisplayName" + parameters: + additionalProperties: + $ref: "#/components/schemas/QueryParameterV2" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + output: + $ref: "#/components/schemas/QueryDataType" rid: - $ref: "#/components/schemas/AttachmentRid" + $ref: "#/components/schemas/FunctionRid" + version: + $ref: "#/components/schemas/FunctionVersion" required: + - apiName - rid - AttachmentRid: - description: The unique resource identifier of an attachment. - format: rid - type: string - x-namespace: Ontologies - x-safety: safe - ActionRid: - description: The unique resource identifier for an action. - format: rid - type: string - x-namespace: Ontologies - x-safety: safe - AsyncApplyActionResponse: + - version + - output type: object x-namespace: Ontologies - AsyncActionOperation: - x-type: - type: asyncOperation - operationType: applyActionAsync - resultType: AsyncApplyActionResponse - stageType: AsyncActionStatus - x-namespace: Ontologies - AsyncActionStatus: - enum: - - RUNNING_SUBMISSION_CHECKS - - EXECUTING_WRITE_BACK_WEBHOOK - - COMPUTING_ONTOLOGY_EDITS - - COMPUTING_FUNCTION - - WRITING_ONTOLOGY_EDITS - - EXECUTING_SIDE_EFFECT_WEBHOOK - - SENDING_NOTIFICATIONS + QueryParameterV2: x-namespace: Ontologies - QueryAggregation: type: object + description: Details about a parameter of a query. properties: - key: - x-safety: unsafe - value: + description: + type: string x-safety: unsafe + dataType: + $ref: "#/components/schemas/QueryDataType" required: - - key - - value - NestedQueryAggregation: + - dataType + QueryOutputV2: + x-namespace: Ontologies type: object + description: Details about the output of a query. properties: - key: - x-safety: unsafe - groups: - type: array - items: - $ref: "#/components/schemas/QueryAggregation" + dataType: + $ref: "#/components/schemas/QueryDataType" + required: + type: boolean + x-safety: safe required: - - key - QueryAggregationRange: - description: Specifies a range from an inclusive start value to an exclusive end value. - type: object + - dataType + - required + RelativeTimeSeriesTimeUnit: x-namespace: Ontologies - properties: - startValue: - description: Inclusive start. - x-safety: unsafe - endValue: - description: Exclusive end. - x-safety: unsafe - QueryTwoDimensionalAggregation: - type: object - properties: - groups: - type: array - items: - $ref: "#/components/schemas/QueryAggregation" - QueryThreeDimensionalAggregation: - type: object - properties: - groups: - type: array - items: - $ref: "#/components/schemas/NestedQueryAggregation" - ExecuteQueryResponse: + enum: + - MILLISECONDS + - SECONDS + - MINUTES + - HOURS + - DAYS + - WEEKS + - MONTHS + - YEARS + RelativeTime: + description: | + A relative time, such as "3 days before" or "2 hours after" the current moment. type: object + x-namespace: Ontologies properties: + when: + $ref: "#/components/schemas/RelativeTimeRelation" value: - $ref: "#/components/schemas/DataValue" + type: integer + x-safety: unsafe + unit: + $ref: "#/components/schemas/RelativeTimeSeriesTimeUnit" required: + - when - value + - unit + RelativeTimeRelation: x-namespace: Ontologies - FilterValue: - description: | - Represents the value of a property filter. For instance, false is the FilterValue in - `properties.{propertyApiName}.isNull=false`. - type: string - x-namespace: Ontologies - x-safety: unsafe - FunctionRid: - description: | - The unique resource identifier of a Function, useful for interacting with other Foundry APIs. - format: rid - type: string - x-namespace: Ontologies - x-safety: safe - FunctionVersion: - description: | - The version of the given Function, written `..-`, where `-` is optional. - Examples: `1.2.3`, `1.2.3-rc1`. - type: string - x-namespace: Ontologies - x-safety: unsafe - CustomTypeId: + enum: + - BEFORE + - AFTER + RelativeTimeRange: description: | - A UUID representing a custom type in a given Function. - type: string + A relative time range for a time series query. + type: object x-namespace: Ontologies - x-safety: safe - LinkTypeApiName: - description: | - The name of the link type in the API. To find the API name for your Link Type, check the **Ontology Manager** - application. - type: string + properties: + startTime: + $ref: "#/components/schemas/RelativeTime" + endTime: + $ref: "#/components/schemas/RelativeTime" + SearchObjectsRequestV2: + type: object x-namespace: Ontologies - x-safety: unsafe - ListActionTypesResponse: properties: - nextPageToken: + where: + $ref: "#/components/schemas/SearchJsonQueryV2" + orderBy: + $ref: "#/components/schemas/SearchOrderByV2" + pageSize: + $ref: "#/components/schemas/PageSize" + pageToken: $ref: "#/components/schemas/PageToken" - data: - items: - $ref: "#/components/schemas/ActionType" + select: + description: | + The API names of the object type properties to include in the response. type: array + items: + $ref: "#/components/schemas/PropertyApiName" + excludeRid: + description: | + A flag to exclude the retrieval of the `__rid` property. + Setting this to true may improve performance of this endpoint for object types in OSV2. + type: boolean + x-safety: safe + SearchObjectsResponseV2: type: object x-namespace: Ontologies - ListQueryTypesResponse: properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" data: items: - $ref: "#/components/schemas/QueryType" + $ref: "#/components/schemas/OntologyObjectV2" type: array + nextPageToken: + $ref: "#/components/schemas/PageToken" + totalCount: + $ref: "#/components/schemas/TotalCount" + required: + - totalCount + StreamTimeSeriesPointsRequest: type: object x-namespace: Ontologies - ListLinkedObjectsResponse: properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - items: - $ref: "#/components/schemas/OntologyObject" - type: array + range: + $ref: "#/components/schemas/TimeRange" + StreamTimeSeriesPointsResponse: type: object x-namespace: Ontologies - ListObjectTypesResponse: properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" data: - description: The list of object types in the current page. items: - $ref: "#/components/schemas/ObjectType" + $ref: "#/components/schemas/TimeSeriesPoint" type: array + TimeRange: + description: An absolute or relative range for a time series query. + type: object + x-namespace: Ontologies + discriminator: + propertyName: type + mapping: + absolute: "#/components/schemas/AbsoluteTimeRange" + relative: "#/components/schemas/RelativeTimeRange" + oneOf: + - $ref: "#/components/schemas/AbsoluteTimeRange" + - $ref: "#/components/schemas/RelativeTimeRange" + TimeSeriesPoint: + x-namespace: Ontologies + description: | + A time and value pair. + type: object + properties: + time: + description: An ISO 8601 timestamp + type: string + format: date-time + x-safety: unsafe + value: + description: An object which is either an enum String or a double number. + x-safety: unsafe + required: + - time + - value + ValidateActionResponseV2: type: object x-namespace: Ontologies - ListObjectsResponse: properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - description: The list of objects in the current page. + result: + $ref: "#/components/schemas/ValidationResult" + submissionCriteria: items: - $ref: "#/components/schemas/OntologyObject" + $ref: "#/components/schemas/SubmissionCriteriaEvaluation" type: array - totalCount: - $ref: "#/components/schemas/TotalCount" + parameters: + additionalProperties: + $ref: "#/components/schemas/ParameterEvaluationResult" + x-mapKey: + $ref: "#/components/schemas/ParameterId" required: - - totalCount - type: object - x-namespace: Ontologies - ListOntologiesResponse: + - result + PropertyV2: + description: Details about some property of an object. properties: - data: - description: The list of Ontologies the user has access to. - items: - $ref: "#/components/schemas/Ontology" - type: array + description: + type: string + x-safety: unsafe + displayName: + $ref: "#/components/schemas/DisplayName" + dataType: + $ref: "#/components/schemas/ObjectPropertyType" + required: + - dataType type: object x-namespace: Ontologies - ListOutgoingLinkTypesResponse: - properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - description: The list of link type sides in the current page. - items: - $ref: "#/components/schemas/LinkTypeSide" - type: array + OntologyObjectArrayType: + x-namespace: Ontologies type: object + properties: + subType: + $ref: "#/components/schemas/ObjectPropertyType" + required: + - subType + ObjectPropertyType: x-namespace: Ontologies - ObjectRid: description: | - The unique resource identifier of an object, useful for interacting with other Foundry APIs. - format: rid - type: string + A union of all the types supported by Ontology Object properties. + discriminator: + propertyName: type + mapping: + array: "#/components/schemas/OntologyObjectArrayType" + attachment: "#/components/schemas/AttachmentType" + boolean: "#/components/schemas/BooleanType" + byte: "#/components/schemas/ByteType" + date: "#/components/schemas/DateType" + decimal: "#/components/schemas/DecimalType" + double: "#/components/schemas/DoubleType" + float: "#/components/schemas/FloatType" + geopoint: "#/components/schemas/GeoPointType" + geoshape: "#/components/schemas/GeoShapeType" + integer: "#/components/schemas/IntegerType" + long: "#/components/schemas/LongType" + marking: "#/components/schemas/MarkingType" + short: "#/components/schemas/ShortType" + string: "#/components/schemas/StringType" + timestamp: "#/components/schemas/TimestampType" + timeseries: "#/components/schemas/TimeseriesType" + oneOf: + - $ref: "#/components/schemas/OntologyObjectArrayType" + - $ref: "#/components/schemas/AttachmentType" + - $ref: "#/components/schemas/BooleanType" + - $ref: "#/components/schemas/ByteType" + - $ref: "#/components/schemas/DateType" + - $ref: "#/components/schemas/DecimalType" + - $ref: "#/components/schemas/DoubleType" + - $ref: "#/components/schemas/FloatType" + - $ref: "#/components/schemas/GeoPointType" + - $ref: "#/components/schemas/GeoShapeType" + - $ref: "#/components/schemas/IntegerType" + - $ref: "#/components/schemas/LongType" + - $ref: "#/components/schemas/MarkingType" + - $ref: "#/components/schemas/ShortType" + - $ref: "#/components/schemas/StringType" + - $ref: "#/components/schemas/TimestampType" + - $ref: "#/components/schemas/TimeseriesType" + BlueprintIcon: x-namespace: Ontologies - x-safety: safe - ObjectType: + type: object + properties: + color: + description: A hexadecimal color code. + type: string + x-safety: safe + name: + description: "The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. \nUsed to specify the Blueprint icon to represent the object type in a React app.\n" + type: string + x-safety: unsafe + required: + - color + - name + Icon: + x-namespace: Ontologies + description: A union currently only consisting of the BlueprintIcon (more icon types may be added in the future). + discriminator: + propertyName: type + mapping: + blueprint: "#/components/schemas/BlueprintIcon" + oneOf: + - $ref: "#/components/schemas/BlueprintIcon" + ObjectTypeV2: description: Represents an object type in the Ontology. properties: apiName: @@ -2979,344 +2241,555 @@ components: description: The description of the object type. type: string x-safety: unsafe - visibility: - $ref: "#/components/schemas/ObjectTypeVisibility" + pluralDisplayName: + description: The plural display name of the object type. + type: string + x-safety: unsafe + icon: + $ref: "#/components/schemas/Icon" primaryKey: - description: The primary key of the object. This is a list of properties that can be used to uniquely identify the object. - items: - $ref: "#/components/schemas/PropertyApiName" - type: array + $ref: "#/components/schemas/PropertyApiName" properties: description: A map of the properties of the object type. additionalProperties: - $ref: "#/components/schemas/Property" + $ref: "#/components/schemas/PropertyV2" x-mapKey: $ref: "#/components/schemas/PropertyApiName" rid: $ref: "#/components/schemas/ObjectTypeRid" + titleProperty: + $ref: "#/components/schemas/PropertyApiName" + visibility: + $ref: "#/components/schemas/ObjectTypeVisibility" required: - apiName - status - rid + - primaryKey + - titleProperty + - displayName + - pluralDisplayName + - icon type: object x-namespace: Ontologies - ObjectTypeApiName: - description: | - The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the - `List object types` endpoint or check the **Ontology Manager**. - type: string - x-namespace: Ontologies - x-safety: unsafe - ObjectTypeVisibility: - enum: - - NORMAL - - PROMINENT - - HIDDEN - description: The suggested visibility of the object type. - type: string - x-namespace: Ontologies - ObjectTypeRid: - description: "The unique resource identifier of an object type, useful for interacting with other Foundry APIs." - format: rid - type: string + ListObjectTypesV2Response: + properties: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + description: The list of object types in the current page. + items: + $ref: "#/components/schemas/ObjectTypeV2" + type: array + type: object x-namespace: Ontologies - x-safety: safe - Ontology: - description: Metadata about an Ontology. + ListOntologiesV2Response: properties: - apiName: - $ref: "#/components/schemas/OntologyApiName" - displayName: - $ref: "#/components/schemas/DisplayName" - description: - type: string - x-safety: unsafe - rid: - $ref: "#/components/schemas/OntologyRid" - required: - - apiName - - displayName - - description - - rid + data: + description: The list of Ontologies the user has access to. + items: + $ref: "#/components/schemas/OntologyV2" + type: array type: object x-namespace: Ontologies - OntologyObject: - description: Represents an object in the Ontology. + ObjectTypeInterfaceImplementation: properties: properties: - description: A map of the property values of the object. - nullable: true additionalProperties: - $ref: "#/components/schemas/PropertyValue" + $ref: "#/components/schemas/PropertyApiName" + x-mapKey: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + type: object + x-namespace: Ontologies + ObjectTypeFullMetadata: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeV2" + linkTypes: + type: array + items: + $ref: "#/components/schemas/LinkTypeSideV2" + implementsInterfaces: + description: A list of interfaces that this object type implements. + type: array + items: + $ref: "#/components/schemas/InterfaceTypeApiName" + implementsInterfaces2: + description: A list of interfaces that this object type implements and how it implements them. + additionalProperties: + $ref: "#/components/schemas/ObjectTypeInterfaceImplementation" x-mapKey: + $ref: "#/components/schemas/InterfaceTypeApiName" + x-safety: unsafe + sharedPropertyTypeMapping: + description: "A map from shared property type API name to backing local property API name for the shared property types \npresent on this object type.\n" + additionalProperties: $ref: "#/components/schemas/PropertyApiName" - rid: - $ref: "#/components/schemas/ObjectRid" - required: - - rid + x-mapKey: + $ref: "#/components/schemas/SharedPropertyTypeApiName" type: object x-namespace: Ontologies - OntologyRid: + required: + - objectType + InterfaceTypeApiName: + description: | + The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface + type, use the `List interface types` endpoint or check the **Ontology Manager**. + type: string + x-namespace: Ontologies + x-safety: unsafe + InterfaceTypeRid: + description: "The unique resource identifier of an interface, useful for interacting with other Foundry APIs." + format: rid + type: string + x-namespace: Ontologies + x-safety: safe + InterfaceLinkTypeRid: description: | - The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the - `List ontologies` endpoint or check the **Ontology Manager**. + The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs. format: rid type: string x-namespace: Ontologies x-safety: safe - OntologyApiName: + InterfaceLinkTypeApiName: + description: A string indicating the API name to use for the interface link. type: string x-namespace: Ontologies x-safety: unsafe - OrderBy: - description: "A command representing the list of properties to order by. Properties should be delimited by commas and\nprefixed by `p` or `properties`. The format expected format is\n`orderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...`\n\nBy default, the ordering for a property is ascending, and this can be explicitly specified by appending \n`:asc` (for ascending) or `:desc` (for descending).\n\nExample: use `orderBy=properties.lastName:asc` to order by a single property, \n`orderBy=properties.lastName,properties.firstName,properties.age:desc` to order by multiple properties. \nYou may also use the shorthand `p` instead of `properties` such as `orderBy=p.lastName:asc`.\n" - type: string + LinkedInterfaceTypeApiName: + x-namespace: Ontologies + description: A reference to the linked interface type. + type: object + properties: + apiName: + $ref: "#/components/schemas/InterfaceTypeApiName" + required: + - apiName + LinkedObjectTypeApiName: + x-namespace: Ontologies + description: A reference to the linked object type. + type: object + properties: + apiName: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - apiName + InterfaceLinkTypeLinkedEntityApiName: + x-namespace: Ontologies + description: A reference to the linked entity. This can either be an object or an interface type. + discriminator: + propertyName: type + mapping: + interfaceTypeApiName: "#/components/schemas/LinkedInterfaceTypeApiName" + objectTypeApiName: "#/components/schemas/LinkedObjectTypeApiName" + oneOf: + - $ref: "#/components/schemas/LinkedInterfaceTypeApiName" + - $ref: "#/components/schemas/LinkedObjectTypeApiName" + InterfaceLinkTypeCardinality: + x-namespace: Ontologies + description: | + The cardinality of the link in the given direction. Cardinality can be "ONE", meaning an object can + link to zero or one other objects, or "MANY", meaning an object can link to any number of other objects. + enum: + - ONE + - MANY + InterfaceLinkType: + description: | + A link type constraint defined at the interface level where the implementation of the links is provided + by the implementing object types. + type: object x-namespace: Ontologies - x-safety: unsafe - Parameter: - description: Details about a parameter of an action or query. properties: + rid: + $ref: "#/components/schemas/InterfaceLinkTypeRid" + apiName: + $ref: "#/components/schemas/InterfaceLinkTypeApiName" + displayName: + $ref: "#/components/schemas/DisplayName" description: + description: The description of the interface link type. type: string x-safety: unsafe - baseType: - $ref: "#/components/schemas/ValueType" - dataType: - $ref: "#/components/schemas/OntologyDataType" + linkedEntityApiName: + $ref: "#/components/schemas/InterfaceLinkTypeLinkedEntityApiName" + cardinality: + $ref: "#/components/schemas/InterfaceLinkTypeCardinality" required: + description: | + Whether each implementing object type must declare at least one implementation of this link. type: boolean x-safety: safe required: - - baseType + - rid + - apiName + - displayName + - linkedEntityApiName + - cardinality - required + InterfaceType: type: object x-namespace: Ontologies - ParameterId: - description: | - The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied. - Parameters can be viewed and managed in the **Ontology Manager**. - type: string - x-namespace: Ontologies - x-safety: unsafe - DataValue: - description: | - Represents the value of data in the following format. Note that these values can be nested, for example an array of structs. - | Type | JSON encoding | Example | - |-----------------------------|-------------------------------------------------------|-------------------------------------------------------------------------------| - | Array | array | `["alpha", "bravo", "charlie"]` | - | Attachment | string | `"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"` | - | Boolean | boolean | `true` | - | Byte | number | `31` | - | Date | ISO 8601 extended local date string | `"2021-05-01"` | - | Decimal | string | `"2.718281828"` | - | Float | number | `3.14159265` | - | Double | number | `3.14159265` | - | Integer | number | `238940` | - | Long | string | `"58319870951433"` | - | Marking | string | `"MU"` | - | Null | null | `null` | - | Object Set | string OR the object set definition | `ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z`| - | Ontology Object Reference | JSON encoding of the object's primary key | `10033123` or `"EMP1234"` | - | Set | array | `["alpha", "bravo", "charlie"]` | - | Short | number | `8739` | - | String | string | `"Call me Ishmael"` | - | Struct | JSON object | `{"name": "John Doe", "age": 42}` | - | TwoDimensionalAggregation | JSON object | `{"groups": [{"key": "alpha", "value": 100}, {"key": "beta", "value": 101}]}` | - | ThreeDimensionalAggregation | JSON object | `{"groups": [{"key": "NYC", "groups": [{"key": "Engineer", "value" : 100}]}]}`| - | Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | - x-safety: unsafe - PrimaryKeyValue: - description: Represents the primary key value that is used as a unique identifier for an object. - x-safety: unsafe - x-namespace: Ontologies - Property: - description: Details about some property of an object. + description: Represents an interface type in the Ontology. properties: + rid: + $ref: "#/components/schemas/InterfaceTypeRid" + apiName: + $ref: "#/components/schemas/InterfaceTypeApiName" + displayName: + $ref: "#/components/schemas/DisplayName" description: + description: The description of the interface. type: string x-safety: unsafe - displayName: - $ref: "#/components/schemas/DisplayName" - baseType: - $ref: "#/components/schemas/ValueType" + properties: + description: "A map from a shared property type API name to the corresponding shared property type. The map describes the \nset of properties the interface has. A shared property type must be unique across all of the properties.\n" + additionalProperties: + $ref: "#/components/schemas/SharedPropertyType" + x-mapKey: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + extendsInterfaces: + description: "A list of interface API names that this interface extends. An interface can extend other interfaces to \ninherit their properties.\n" + type: array + items: + $ref: "#/components/schemas/InterfaceTypeApiName" + links: + description: | + A map from an interface link type API name to the corresponding interface link type. The map describes the + set of link types the interface has. + additionalProperties: + $ref: "#/components/schemas/InterfaceLinkType" + x-mapKey: + $ref: "#/components/schemas/InterfaceLinkTypeApiName" required: - - baseType - type: object - x-namespace: Ontologies - PropertyApiName: - description: | - The name of the property in the API. To find the API name for your property, use the `Get object type` - endpoint or check the **Ontology Manager**. - type: string + - rid + - apiName + - displayName + InterfaceTypeNotFound: + description: "The requested interface type is not found, or the client token does not have access to it." + properties: + parameters: + properties: + apiName: + $ref: "#/components/schemas/InterfaceTypeApiName" + rid: + $ref: "#/components/schemas/InterfaceTypeRid" + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - x-safety: unsafe - FieldNameV1: - description: "A reference to an Ontology object property with the form `properties.{propertyApiName}`." - type: string + SharedPropertyTypeNotFound: + description: "The requested shared property type is not found, or the client token does not have access to it." + properties: + parameters: + properties: + apiName: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + rid: + $ref: "#/components/schemas/SharedPropertyTypeRid" + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - x-safety: unsafe - PropertyFilter: + PropertiesHaveDifferentIds: description: | - Represents a filter used on properties. - - Endpoints that accept this supports optional parameters that have the form: - `properties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString}` to filter the returned objects. - For instance, you may use `properties.firstName.eq=John` to find objects that contain a property called - "firstName" that has the exact value of "John". - - The following are a list of supported property filters: - - - `properties.{propertyApiName}.contains` - supported on arrays and can be used to filter array properties - that have at least one of the provided values. If multiple query parameters are provided, then objects - that have any of the given values for the specified property will be matched. - - `properties.{propertyApiName}.eq` - used to filter objects that have the exact value for the provided - property. If multiple query parameters are provided, then objects that have any of the given values - will be matched. For instance, if the user provides a request by doing - `?properties.firstName.eq=John&properties.firstName.eq=Anna`, then objects that have a firstName property - of either John or Anna will be matched. This filter is supported on all property types except Arrays. - - `properties.{propertyApiName}.neq` - used to filter objects that do not have the provided property values. - Similar to the `eq` filter, if multiple values are provided, then objects that have any of the given values - will be excluded from the result. - - `properties.{propertyApiName}.lt`, `properties.{propertyApiName}.lte`, `properties.{propertyApiName}.gt` - `properties.{propertyApiName}.gte` - represent less than, less than or equal to, greater than, and greater - than or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal. - - `properties.{propertyApiName}.isNull` - used to filter objects where the provided property is (or is not) null. - This filter is supported on all property types. - type: string + Properties used in ordering must have the same ids. Temporary restriction imposed due to OSS limitations. + properties: + parameters: + properties: + properties: + items: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + type: array + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - x-safety: safe - PropertyId: - description: | - The immutable ID of a property. Property IDs are only used to identify properties in the **Ontology Manager** - application and assign them API names. In every other case, API names should be used instead of property IDs. - type: string + SharedPropertiesNotFound: + description: The requested shared property types are not present on every object type. + properties: + parameters: + properties: + objectType: + type: array + items: + $ref: "#/components/schemas/ObjectTypeApiName" + missingSharedProperties: + type: array + items: + $ref: "#/components/schemas/SharedPropertyTypeApiName" + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - x-safety: unsafe - SelectedPropertyApiName: + SharedPropertyTypeApiName: description: | - By default, anytime an object is requested, every property belonging to that object is returned. - The response can be filtered to only include certain properties using the `properties` query parameter. - - Properties to include can be specified in one of two ways. - - - A comma delimited list as the value for the `properties` query parameter - `properties={property1ApiName},{property2ApiName}` - - Multiple `properties` query parameters. - `properties={property1ApiName}&properties={property2ApiName}` - - The primary key of the object will always be returned even if it wasn't specified in the `properties` values. - - Unknown properties specified in the `properties` list will result in a `PropertiesNotFound` error. - - To find the API name for your property, use the `Get object type` endpoint or check the **Ontology Manager**. + The name of the shared property type in the API in lowerCamelCase format. To find the API name for your + shared property type, use the `List shared property types` endpoint or check the **Ontology Manager**. type: string x-namespace: Ontologies x-safety: unsafe - PropertyValue: + SharedPropertyTypeRid: description: | - Represents the value of a property in the following format. - - | Type | JSON encoding | Example | - |----------- |-------------------------------------------------------|----------------------------------------------------------------------------------------------------| - | Array | array | `["alpha", "bravo", "charlie"]` | - | Attachment | JSON encoded `AttachmentProperty` object | `{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}` | - | Boolean | boolean | `true` | - | Byte | number | `31` | - | Date | ISO 8601 extended local date string | `"2021-05-01"` | - | Decimal | string | `"2.718281828"` | - | Double | number | `3.14159265` | - | Float | number | `3.14159265` | - | GeoPoint | geojson | `{"type":"Point","coordinates":[102.0,0.5]}` | - | GeoShape | geojson | `{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` | - | Integer | number | `238940` | - | Long | string | `"58319870951433"` | - | Short | number | `8739` | - | String | string | `"Call me Ishmael"` | - | Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | - - Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings. - x-safety: unsafe - x-namespace: Ontologies - PropertyValueEscapedString: - description: Represents the value of a property in string format. This is used in URL parameters. + The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs. + format: rid type: string x-namespace: Ontologies - x-safety: unsafe - LinkTypeSide: + x-safety: safe + SharedPropertyType: type: object x-namespace: Ontologies + description: A property type that can be shared across object types. properties: + rid: + $ref: "#/components/schemas/SharedPropertyTypeRid" apiName: - $ref: "#/components/schemas/LinkTypeApiName" + $ref: "#/components/schemas/SharedPropertyTypeApiName" displayName: $ref: "#/components/schemas/DisplayName" - status: - $ref: "#/components/schemas/ReleaseStatus" - objectTypeApiName: - $ref: "#/components/schemas/ObjectTypeApiName" - cardinality: - $ref: "#/components/schemas/LinkTypeSideCardinality" - foreignKeyPropertyApiName: - $ref: "#/components/schemas/PropertyApiName" + description: + type: string + description: A short text that describes the SharedPropertyType. + x-safety: unsafe + dataType: + $ref: "#/components/schemas/ObjectPropertyType" required: + - rid - apiName - displayName - - status - - objectTypeApiName - - cardinality - LinkTypeSideCardinality: - enum: - - ONE - - MANY + - dataType + AggregateObjectsRequestV2: + type: object + x-namespace: Ontologies + properties: + aggregation: + items: + $ref: "#/components/schemas/AggregationV2" + type: array + where: + $ref: "#/components/schemas/SearchJsonQueryV2" + groupBy: + items: + $ref: "#/components/schemas/AggregationGroupByV2" + type: array + accuracy: + $ref: "#/components/schemas/AggregationAccuracyRequest" + AggregationV2: + description: Specifies an aggregation function. + type: object + x-namespace: Ontologies + discriminator: + propertyName: type + mapping: + max: "#/components/schemas/MaxAggregationV2" + min: "#/components/schemas/MinAggregationV2" + avg: "#/components/schemas/AvgAggregationV2" + sum: "#/components/schemas/SumAggregationV2" + count: "#/components/schemas/CountAggregationV2" + approximateDistinct: "#/components/schemas/ApproximateDistinctAggregationV2" + approximatePercentile: "#/components/schemas/ApproximatePercentileAggregationV2" + exactDistinct: "#/components/schemas/ExactDistinctAggregationV2" + oneOf: + - $ref: "#/components/schemas/MaxAggregationV2" + - $ref: "#/components/schemas/MinAggregationV2" + - $ref: "#/components/schemas/AvgAggregationV2" + - $ref: "#/components/schemas/SumAggregationV2" + - $ref: "#/components/schemas/CountAggregationV2" + - $ref: "#/components/schemas/ApproximateDistinctAggregationV2" + - $ref: "#/components/schemas/ApproximatePercentileAggregationV2" + - $ref: "#/components/schemas/ExactDistinctAggregationV2" + MaxAggregationV2: + description: Computes the maximum value for the provided field. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/PropertyApiName" + name: + $ref: "#/components/schemas/AggregationMetricName" + direction: + $ref: "#/components/schemas/OrderByDirection" + required: + - field + MinAggregationV2: + description: Computes the minimum value for the provided field. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/PropertyApiName" + name: + $ref: "#/components/schemas/AggregationMetricName" + direction: + $ref: "#/components/schemas/OrderByDirection" + required: + - field + AvgAggregationV2: + description: Computes the average value for the provided field. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/PropertyApiName" + name: + $ref: "#/components/schemas/AggregationMetricName" + direction: + $ref: "#/components/schemas/OrderByDirection" + required: + - field + SumAggregationV2: + description: Computes the sum of values for the provided field. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/PropertyApiName" + name: + $ref: "#/components/schemas/AggregationMetricName" + direction: + $ref: "#/components/schemas/OrderByDirection" + required: + - field + CountAggregationV2: + description: Computes the total count of objects. + type: object + x-namespace: Ontologies + properties: + name: + $ref: "#/components/schemas/AggregationMetricName" + direction: + $ref: "#/components/schemas/OrderByDirection" + ApproximateDistinctAggregationV2: + description: Computes an approximate number of distinct values for the provided field. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/PropertyApiName" + name: + $ref: "#/components/schemas/AggregationMetricName" + direction: + $ref: "#/components/schemas/OrderByDirection" + required: + - field + ExactDistinctAggregationV2: + description: Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/PropertyApiName" + name: + $ref: "#/components/schemas/AggregationMetricName" + direction: + $ref: "#/components/schemas/OrderByDirection" + required: + - field + ApproximatePercentileAggregationV2: + description: Computes the approximate percentile value for the provided field. Requires Object Storage V2. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/PropertyApiName" + name: + $ref: "#/components/schemas/AggregationMetricName" + approximatePercentile: + type: number + format: double + x-safety: safe + direction: + $ref: "#/components/schemas/OrderByDirection" + required: + - field + - approximatePercentile + OrderByDirection: x-namespace: Ontologies - AggregateObjectsRequest: + enum: + - ASC + - DESC + AggregationGroupByV2: + description: Specifies a grouping for aggregation results. type: object x-namespace: Ontologies - properties: - aggregation: - items: - $ref: "#/components/schemas/Aggregation" - type: array - query: - $ref: "#/components/schemas/SearchJsonQuery" - groupBy: - items: - $ref: "#/components/schemas/AggregationGroupBy" - type: array - AggregateObjectsResponse: + discriminator: + propertyName: type + mapping: + fixedWidth: "#/components/schemas/AggregationFixedWidthGroupingV2" + ranges: "#/components/schemas/AggregationRangesGroupingV2" + exact: "#/components/schemas/AggregationExactGroupingV2" + duration: "#/components/schemas/AggregationDurationGroupingV2" + oneOf: + - $ref: "#/components/schemas/AggregationFixedWidthGroupingV2" + - $ref: "#/components/schemas/AggregationRangesGroupingV2" + - $ref: "#/components/schemas/AggregationExactGroupingV2" + - $ref: "#/components/schemas/AggregationDurationGroupingV2" + AggregationAccuracyRequest: + x-namespace: Ontologies + enum: + - REQUIRE_ACCURATE + - ALLOW_APPROXIMATE + AggregationAccuracy: + x-namespace: Ontologies + enum: + - ACCURATE + - APPROXIMATE + AggregateObjectsResponseV2: properties: excludedItems: type: integer x-safety: unsafe - nextPageToken: - $ref: "#/components/schemas/PageToken" + accuracy: + $ref: "#/components/schemas/AggregationAccuracy" data: items: - $ref: "#/components/schemas/AggregateObjectsResponseItem" + $ref: "#/components/schemas/AggregateObjectsResponseItemV2" type: array type: object + required: + - accuracy x-namespace: Ontologies - AggregateObjectsResponseItem: + AggregateObjectsResponseItemV2: type: object x-namespace: Ontologies properties: group: additionalProperties: - $ref: "#/components/schemas/AggregationGroupValue" + $ref: "#/components/schemas/AggregationGroupValueV2" x-mapKey: - $ref: "#/components/schemas/AggregationGroupKey" + $ref: "#/components/schemas/AggregationGroupKeyV2" metrics: items: - $ref: "#/components/schemas/AggregationMetricResult" + $ref: "#/components/schemas/AggregationMetricResultV2" type: array - AggregationGroupKey: - type: string - x-namespace: Ontologies - x-safety: unsafe - AggregationGroupValue: - x-safety: unsafe - x-namespace: Ontologies - AggregationMetricResult: + AggregationMetricResultV2: type: object x-namespace: Ontologies properties: @@ -3324,371 +2797,330 @@ components: type: string x-safety: unsafe value: - type: number - format: double - description: TBD + description: | + The value of the metric. This will be a double in the case of + a numeric metric, or a date string in the case of a date metric. x-safety: unsafe required: - name - SearchObjectsRequest: + AggregationGroupKeyV2: + type: string + x-namespace: Ontologies + x-safety: unsafe + AggregationGroupValueV2: + x-safety: unsafe + x-namespace: Ontologies + AggregationExactGroupingV2: + description: Divides objects into groups according to an exact value. + type: object + x-namespace: Ontologies properties: - query: - $ref: "#/components/schemas/SearchJsonQuery" - orderBy: - $ref: "#/components/schemas/SearchOrderBy" - pageSize: - $ref: "#/components/schemas/PageSize" - pageToken: - $ref: "#/components/schemas/PageToken" - fields: - description: | - The API names of the object type properties to include in the response. - type: array - items: - $ref: "#/components/schemas/PropertyApiName" + field: + $ref: "#/components/schemas/PropertyApiName" + maxGroupCount: + type: integer + x-safety: safe required: - - query + - field + AggregationFixedWidthGroupingV2: + description: Divides objects into groups with the specified width. type: object x-namespace: Ontologies - SearchObjectsResponse: properties: - data: + field: + $ref: "#/components/schemas/PropertyApiName" + fixedWidth: + type: integer + x-safety: safe + required: + - field + - fixedWidth + AggregationRangeV2: + description: Specifies a range from an inclusive start value to an exclusive end value. + type: object + x-namespace: Ontologies + properties: + startValue: + description: Inclusive start. + x-safety: unsafe + endValue: + description: Exclusive end. + x-safety: unsafe + required: + - startValue + - endValue + AggregationRangesGroupingV2: + description: Divides objects into groups according to specified ranges. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/PropertyApiName" + ranges: items: - $ref: "#/components/schemas/OntologyObject" + $ref: "#/components/schemas/AggregationRangeV2" type: array - nextPageToken: - $ref: "#/components/schemas/PageToken" - totalCount: - $ref: "#/components/schemas/TotalCount" required: - - totalCount + - field + AggregationDurationGroupingV2: + description: | + Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. + When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/PropertyApiName" + value: + type: integer + x-safety: unsafe + unit: + $ref: "#/components/schemas/TimeUnit" + required: + - field + - value + - unit + AggregationObjectTypeGrouping: + description: "Divides objects into groups based on their object type. This grouping is only useful when aggregating across \nmultiple object types, such as when aggregating over an interface type.\n" + type: object + x-namespace: Ontologies + properties: {} + OperationNotFound: + description: "The operation is not found, or the user does not have access to it." + properties: + parameters: + type: object + properties: + id: + type: string + format: rid + x-safety: safe + required: + - id + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Operations + AggregationMetricName: + type: string + x-namespace: Ontologies + description: A user-specified alias for an aggregation metric name. + x-safety: unsafe + AggregationRange: + description: Specifies a date range from an inclusive start date to an exclusive end date. + type: object + x-namespace: Ontologies + properties: + lt: + description: Exclusive end date. + x-safety: unsafe + lte: + description: Inclusive end date. + x-safety: unsafe + gt: + description: Exclusive start date. + x-safety: unsafe + gte: + description: Inclusive start date. + x-safety: unsafe + Aggregation: + description: Specifies an aggregation function. + type: object + x-namespace: Ontologies + discriminator: + propertyName: type + mapping: + max: "#/components/schemas/MaxAggregation" + min: "#/components/schemas/MinAggregation" + avg: "#/components/schemas/AvgAggregation" + sum: "#/components/schemas/SumAggregation" + count: "#/components/schemas/CountAggregation" + approximateDistinct: "#/components/schemas/ApproximateDistinctAggregation" + oneOf: + - $ref: "#/components/schemas/MaxAggregation" + - $ref: "#/components/schemas/MinAggregation" + - $ref: "#/components/schemas/AvgAggregation" + - $ref: "#/components/schemas/SumAggregation" + - $ref: "#/components/schemas/CountAggregation" + - $ref: "#/components/schemas/ApproximateDistinctAggregation" + AggregationGroupBy: + description: Specifies a grouping for aggregation results. + type: object + x-namespace: Ontologies + discriminator: + propertyName: type + mapping: + fixedWidth: "#/components/schemas/AggregationFixedWidthGrouping" + ranges: "#/components/schemas/AggregationRangesGrouping" + exact: "#/components/schemas/AggregationExactGrouping" + duration: "#/components/schemas/AggregationDurationGrouping" + oneOf: + - $ref: "#/components/schemas/AggregationFixedWidthGrouping" + - $ref: "#/components/schemas/AggregationRangesGrouping" + - $ref: "#/components/schemas/AggregationExactGrouping" + - $ref: "#/components/schemas/AggregationDurationGrouping" + AggregationOrderBy: + type: object + x-namespace: Ontologies + properties: + metricName: + type: string + x-safety: unsafe + required: + - metricName + AggregationFixedWidthGrouping: + description: Divides objects into groups with the specified width. type: object x-namespace: Ontologies - ValidateActionRequest: properties: - parameters: - nullable: true - additionalProperties: - $ref: "#/components/schemas/DataValue" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - type: object - x-namespace: Ontologies - ValidateActionResponse: + field: + $ref: "#/components/schemas/FieldNameV1" + fixedWidth: + type: integer + x-safety: safe + required: + - field + - fixedWidth + AggregationRangesGrouping: + description: Divides objects into groups according to specified ranges. type: object x-namespace: Ontologies properties: - result: - $ref: "#/components/schemas/ValidationResult" - submissionCriteria: + field: + $ref: "#/components/schemas/FieldNameV1" + ranges: items: - $ref: "#/components/schemas/SubmissionCriteriaEvaluation" + $ref: "#/components/schemas/AggregationRange" type: array - parameters: - additionalProperties: - $ref: "#/components/schemas/ParameterEvaluationResult" - x-mapKey: - $ref: "#/components/schemas/ParameterId" required: - - result - SubmissionCriteriaEvaluation: - description: | - Contains the status of the **submission criteria**. - **Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. - These are configured in the **Ontology Manager**. + - field + AggregationExactGrouping: + description: Divides objects into groups according to an exact value. type: object x-namespace: Ontologies properties: - configuredFailureMessage: - description: | - The message indicating one of the **submission criteria** was not satisfied. - This is configured per **submission criteria** in the **Ontology Manager**. - type: string - x-safety: unsafe - result: - $ref: "#/components/schemas/ValidationResult" + field: + $ref: "#/components/schemas/FieldNameV1" + maxGroupCount: + type: integer + x-safety: safe required: - - result - ValidationResult: + - field + AggregationDurationGrouping: description: | - Represents the state of a validation. - enum: - - VALID - - INVALID - type: string + Divides objects into groups according to an interval. Note that this grouping applies only on date types. + The interval uses the ISO 8601 notation. For example, "PT1H2M34S" represents a duration of 3754 seconds. + type: object x-namespace: Ontologies - ResourcePath: - description: | - A path in the Foundry file tree. - type: string - x-safety: unsafe - x-namespace: Datasets - DatasetName: - type: string - x-safety: unsafe - x-namespace: Datasets - DatasetRid: - description: | - The Resource Identifier (RID) of a Dataset. Example: `ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da`. - format: rid - type: string - x-safety: safe - Dataset: properties: - rid: - $ref: "#/components/schemas/DatasetRid" - name: - $ref: "#/components/schemas/DatasetName" - parentFolderRid: - $ref: "#/components/schemas/FolderRid" + field: + $ref: "#/components/schemas/FieldNameV1" + duration: + $ref: "#/components/schemas/Duration" required: - - rid - - name - - parentFolderRid + - field + - duration + MaxAggregation: + description: Computes the maximum value for the provided field. type: object - x-namespace: Datasets - CreateDatasetRequest: + x-namespace: Ontologies properties: + field: + $ref: "#/components/schemas/FieldNameV1" name: - $ref: "#/components/schemas/DatasetName" - parentFolderRid: - $ref: "#/components/schemas/FolderRid" - required: - - name - - parentFolderRid - type: object - x-namespace: Datasets - TableExportFormat: - description: | - Format for tabular dataset export. - enum: - - ARROW - - CSV - x-namespace: Datasets - BranchId: - description: | - The identifier (name) of a Branch. Example: `master`. - type: string - x-safety: unsafe - Branch: - description: | - A Branch of a Dataset. - properties: - branchId: - $ref: "#/components/schemas/BranchId" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - required: - - branchId - type: object - x-namespace: Datasets - CreateBranchRequest: - properties: - branchId: - $ref: "#/components/schemas/BranchId" - transactionRid: - $ref: "#/components/schemas/TransactionRid" + $ref: "#/components/schemas/AggregationMetricName" required: - - branchId - type: object - x-namespace: Datasets - ListBranchesResponse: - properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - description: The list of branches in the current page. - items: - $ref: "#/components/schemas/Branch" - type: array - type: object - x-namespace: Datasets - TransactionRid: - description: | - The Resource Identifier (RID) of a Transaction. Example: `ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4`. - format: rid - type: string - x-safety: safe - x-namespace: Datasets - TransactionType: - description: | - The type of a Transaction. - enum: - - APPEND - - UPDATE - - SNAPSHOT - - DELETE - x-namespace: Datasets - TransactionStatus: - description: | - The status of a Transaction. - enum: - - ABORTED - - COMMITTED - - OPEN - x-namespace: Datasets - CreateTransactionRequest: - properties: - transactionType: - $ref: "#/components/schemas/TransactionType" + - field + MinAggregation: + description: Computes the minimum value for the provided field. type: object - x-namespace: Datasets - Transaction: - description: | - An operation that modifies the files within a dataset. + x-namespace: Ontologies properties: - rid: - $ref: "#/components/schemas/TransactionRid" - transactionType: - $ref: "#/components/schemas/TransactionType" - status: - $ref: "#/components/schemas/TransactionStatus" - createdTime: - type: string - format: date-time - description: "The timestamp when the transaction was created, in ISO 8601 timestamp format." - x-safety: unsafe - closedTime: - type: string - format: date-time - description: "The timestamp when the transaction was closed, in ISO 8601 timestamp format." - x-safety: unsafe + field: + $ref: "#/components/schemas/FieldNameV1" + name: + $ref: "#/components/schemas/AggregationMetricName" required: - - rid - - transactionType - - status - - createdTime + - field + AvgAggregation: + description: Computes the average value for the provided field. type: object - x-namespace: Datasets - File: + x-namespace: Ontologies properties: - path: - $ref: "#/components/schemas/FilePath" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - sizeBytes: - type: string - format: long - x-safety: safe - updatedTime: - type: string - format: date-time - x-safety: unsafe + field: + $ref: "#/components/schemas/FieldNameV1" + name: + $ref: "#/components/schemas/AggregationMetricName" required: - - path - - transactionRid - - updatedTime + - field + SumAggregation: + description: Computes the sum of values for the provided field. type: object - x-namespace: Datasets - ListFilesResponse: - description: A page of Files and an optional page token that can be used to retrieve the next page. + x-namespace: Ontologies properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - items: - $ref: "#/components/schemas/File" - type: array + field: + $ref: "#/components/schemas/FieldNameV1" + name: + $ref: "#/components/schemas/AggregationMetricName" + required: + - field + CountAggregation: + description: Computes the total count of objects. type: object - x-namespace: Datasets - OperationNotFound: - description: "The operation is not found, or the user does not have access to it." + x-namespace: Ontologies properties: - parameters: - type: object - properties: - id: - type: string - format: rid - x-safety: safe - required: - - id - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Operations - DatasetNotFound: - description: "The requested dataset could not be found, or the client token does not have access to it." + name: + $ref: "#/components/schemas/AggregationMetricName" + ApproximateDistinctAggregation: + description: Computes an approximate number of distinct values for the provided field. + type: object + x-namespace: Ontologies properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - required: - - datasetRid - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - CreateDatasetPermissionDenied: - description: The provided token does not have permission to create a dataset in this folder. + field: + $ref: "#/components/schemas/FieldNameV1" + name: + $ref: "#/components/schemas/AggregationMetricName" + required: + - field + InvalidAggregationRange: + description: | + Aggregation range should include one lt or lte and one gt or gte. properties: parameters: - properties: - parentFolderRid: - $ref: "#/components/schemas/FolderRid" - name: - $ref: "#/components/schemas/DatasetName" - required: - - parentFolderRid - - name type: object errorCode: enum: - - PERMISSION_DENIED + - INVALID_ARGUMENT type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Datasets - BranchAlreadyExists: - description: The branch cannot be created because a branch with that name already exists. + x-namespace: Ontologies + InvalidAggregationRangePropertyType: + description: | + Range group by is not supported by property type. properties: parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" - required: - - datasetRid - - branchId type: object - errorCode: - enum: - - CONFLICT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - InvalidBranchId: - description: The requested branch name cannot be used. Branch names cannot be empty and must not look like RIDs or UUIDs. - properties: - parameters: properties: - branchId: - $ref: "#/components/schemas/BranchId" + property: + $ref: "#/components/schemas/PropertyApiName" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + propertyBaseType: + $ref: "#/components/schemas/ValueType" required: - - branchId - type: object + - property + - objectType + - propertyBaseType errorCode: enum: - INVALID_ARGUMENT @@ -3698,138 +3130,91 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Datasets - BranchNotFound: - description: "The requested branch could not be found, or the client token does not have access to it." + x-namespace: Ontologies + InvalidAggregationRangeValue: + description: | + Aggregation value does not conform to the expected underlying type. properties: parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" - required: - - datasetRid - - branchId type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - CreateBranchPermissionDenied: - description: The provided token does not have permission to create a branch of this dataset. - properties: - parameters: properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" + property: + $ref: "#/components/schemas/PropertyApiName" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + propertyBaseType: + $ref: "#/components/schemas/ValueType" required: - - datasetRid - - branchId - type: object + - property + - objectType + - propertyBaseType errorCode: enum: - - PERMISSION_DENIED + - INVALID_ARGUMENT type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Datasets - DeleteBranchPermissionDenied: - description: The provided token does not have permission to delete the given branch from this dataset. + x-namespace: Ontologies + InvalidDurationGroupByPropertyType: + description: | + Invalid property type for duration groupBy. properties: parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" - required: - - datasetRid - - branchId type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - CreateTransactionPermissionDenied: - description: The provided token does not have permission to create a transaction on this dataset. - properties: - parameters: properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" + property: + $ref: "#/components/schemas/PropertyApiName" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + propertyBaseType: + $ref: "#/components/schemas/ValueType" required: - - datasetRid - - branchId - type: object + - property + - objectType + - propertyBaseType errorCode: enum: - - PERMISSION_DENIED + - INVALID_ARGUMENT type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Datasets - OpenTransactionAlreadyExists: - description: A transaction is already open on this dataset and branch. A branch of a dataset can only have one open transaction at a time. + x-namespace: Ontologies + InvalidDurationGroupByValue: + description: | + Duration groupBy value is invalid. Units larger than day must have value `1` and date properties do not support + filtering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by + every two hours are allowed. properties: parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - branchId: - $ref: "#/components/schemas/BranchId" - required: - - datasetRid - - branchId type: object errorCode: enum: - - CONFLICT + - INVALID_ARGUMENT type: string errorName: type: string errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - TransactionNotOpen: - description: The given transaction is not open. - properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - transactionStatus: - $ref: "#/components/schemas/TransactionStatus" - required: - - datasetRid - - transactionRid - - transactionStatus + type: string + x-type: error + x-namespace: Ontologies + MultipleGroupByOnFieldNotSupported: + description: | + Aggregation cannot group by on the same field multiple times. + properties: + parameters: type: object + properties: + duplicateFields: + items: + type: string + x-safety: unsafe + type: array errorCode: enum: - INVALID_ARGUMENT @@ -3839,22 +3224,12 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Datasets - TransactionNotCommitted: - description: The given transaction has not been committed. + x-namespace: Ontologies + InvalidAggregationOrdering: + description: | + Aggregation ordering can only be applied to metrics with exactly one groupBy clause. properties: parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - transactionStatus: - $ref: "#/components/schemas/TransactionStatus" - required: - - datasetRid - - transactionRid - - transactionStatus type: object errorCode: enum: @@ -3864,20 +3239,248 @@ components: type: string errorInstanceId: type: string - x-type: error - x-namespace: Datasets - TransactionNotFound: - description: "The requested transaction could not be found on the dataset, or the client token does not have access to it." + x-type: error + x-namespace: Ontologies + SearchJsonQuery: + type: object + x-namespace: Ontologies + discriminator: + propertyName: type + mapping: + lt: "#/components/schemas/LtQuery" + gt: "#/components/schemas/GtQuery" + lte: "#/components/schemas/LteQuery" + gte: "#/components/schemas/GteQuery" + eq: "#/components/schemas/EqualsQuery" + isNull: "#/components/schemas/IsNullQuery" + contains: "#/components/schemas/ContainsQuery" + and: "#/components/schemas/AndQuery" + or: "#/components/schemas/OrQuery" + not: "#/components/schemas/NotQuery" + prefix: "#/components/schemas/PrefixQuery" + phrase: "#/components/schemas/PhraseQuery" + anyTerm: "#/components/schemas/AnyTermQuery" + allTerms: "#/components/schemas/AllTermsQuery" + oneOf: + - $ref: "#/components/schemas/LtQuery" + - $ref: "#/components/schemas/GtQuery" + - $ref: "#/components/schemas/LteQuery" + - $ref: "#/components/schemas/GteQuery" + - $ref: "#/components/schemas/EqualsQuery" + - $ref: "#/components/schemas/IsNullQuery" + - $ref: "#/components/schemas/ContainsQuery" + - $ref: "#/components/schemas/AndQuery" + - $ref: "#/components/schemas/OrQuery" + - $ref: "#/components/schemas/NotQuery" + - $ref: "#/components/schemas/PrefixQuery" + - $ref: "#/components/schemas/PhraseQuery" + - $ref: "#/components/schemas/AnyTermQuery" + - $ref: "#/components/schemas/AllTermsQuery" + LtQuery: + type: object + x-namespace: Ontologies + description: Returns objects where the specified field is less than a value. + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + GtQuery: + type: object + x-namespace: Ontologies + description: Returns objects where the specified field is greater than a value. + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + LteQuery: + type: object + x-namespace: Ontologies + description: Returns objects where the specified field is less than or equal to a value. + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + GteQuery: + type: object + x-namespace: Ontologies + description: Returns objects where the specified field is greater than or equal to a value. + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + EqualsQuery: + type: object + x-namespace: Ontologies + description: Returns objects where the specified field is equal to a value. + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + IsNullQuery: + type: object + x-namespace: Ontologies + description: Returns objects based on the existence of the specified field. + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + value: + type: boolean + x-safety: unsafe + required: + - field + - value + ContainsQuery: + type: object + x-namespace: Ontologies + description: Returns objects where the specified array contains a value. + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + value: + $ref: "#/components/schemas/PropertyValue" + required: + - field + - value + AndQuery: + type: object + x-namespace: Ontologies + description: Returns objects where every query is satisfied. + properties: + value: + items: + $ref: "#/components/schemas/SearchJsonQuery" + type: array + OrQuery: + type: object + x-namespace: Ontologies + description: Returns objects where at least 1 query is satisfied. + properties: + value: + items: + $ref: "#/components/schemas/SearchJsonQuery" + type: array + NotQuery: + type: object + x-namespace: Ontologies + description: Returns objects where the query is not satisfied. + properties: + value: + $ref: "#/components/schemas/SearchJsonQuery" + required: + - value + PrefixQuery: + type: object + x-namespace: Ontologies + description: Returns objects where the specified field starts with the provided value. + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + value: + type: string + x-safety: unsafe + required: + - field + - value + PhraseQuery: + type: object + x-namespace: Ontologies + description: Returns objects where the specified field contains the provided value as a substring. + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + value: + type: string + x-safety: unsafe + required: + - field + - value + AnyTermQuery: + type: object + x-namespace: Ontologies + description: "Returns objects where the specified field contains any of the whitespace separated words in any \norder in the provided value. This query supports fuzzy matching.\n" + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + value: + type: string + x-safety: unsafe + fuzzy: + $ref: "#/components/schemas/Fuzzy" + required: + - field + - value + AllTermsQuery: + type: object + x-namespace: Ontologies + description: | + Returns objects where the specified field contains all of the whitespace separated words in any + order in the provided value. This query supports fuzzy matching. + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + value: + type: string + x-safety: unsafe + fuzzy: + $ref: "#/components/schemas/Fuzzy" + required: + - field + - value + Fuzzy: + description: Setting fuzzy to `true` allows approximate matching in search queries that support it. + type: boolean + x-namespace: Ontologies + x-safety: safe + SearchOrderBy: + description: Specifies the ordering of search results by a field and an ordering direction. + type: object + x-namespace: Ontologies + properties: + fields: + items: + $ref: "#/components/schemas/SearchOrdering" + type: array + SearchOrdering: + type: object + x-namespace: Ontologies + properties: + field: + $ref: "#/components/schemas/FieldNameV1" + direction: + description: Specifies the ordering direction (can be either `asc` or `desc`) + type: string + x-safety: safe + required: + - field + DatasetNotFound: + description: "The requested dataset could not be found, or the client token does not have access to it." properties: parameters: properties: datasetRid: $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" required: - datasetRid - - transactionRid type: object errorCode: enum: @@ -3889,18 +3492,18 @@ components: type: string x-type: error x-namespace: Datasets - CommitTransactionPermissionDenied: - description: The provided token does not have permission to commit the given transaction on the given dataset. + CreateDatasetPermissionDenied: + description: The provided token does not have permission to create a dataset in this folder. properties: parameters: properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" + parentFolderRid: + $ref: "#/components/schemas/FolderRid" + name: + $ref: "#/components/schemas/DatasetName" required: - - datasetRid - - transactionRid + - parentFolderRid + - name type: object errorCode: enum: @@ -3912,22 +3515,22 @@ components: type: string x-type: error x-namespace: Datasets - AbortTransactionPermissionDenied: - description: The provided token does not have permission to abort the given transaction on the given dataset. + BranchAlreadyExists: + description: The branch cannot be created because a branch with that name already exists. properties: parameters: properties: datasetRid: $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" + branchId: + $ref: "#/components/schemas/BranchId" required: - datasetRid - - transactionRid + - branchId type: object errorCode: enum: - - PERMISSION_DENIED + - CONFLICT type: string errorName: type: string @@ -3935,21 +3538,15 @@ components: type: string x-type: error x-namespace: Datasets - InvalidTransactionType: - description: "The given transaction type is not valid. Valid transaction types are `SNAPSHOT`, `UPDATE`, `APPEND`, and `DELETE`." + InvalidBranchId: + description: The requested branch name cannot be used. Branch names cannot be empty and must not look like RIDs or UUIDs. properties: parameters: properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - transactionType: - $ref: "#/components/schemas/TransactionType" + branchId: + $ref: "#/components/schemas/BranchId" required: - - datasetRid - - transactionRid - - transactionType + - branchId type: object errorCode: enum: @@ -3961,34 +3558,8 @@ components: type: string x-type: error x-namespace: Datasets - UploadFilePermissionDenied: - description: The provided token does not have permission to upload the given file to the given dataset and transaction. - properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - path: - $ref: "#/components/schemas/FilePath" - required: - - datasetRid - - transactionRid - - path - type: object - errorCode: - enum: - - PERMISSION_DENIED - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - FileNotFoundOnBranch: - description: "The requested file could not be found on the given branch, or the client token does not have access to it." + BranchNotFound: + description: "The requested branch could not be found, or the client token does not have access to it." properties: parameters: properties: @@ -3996,12 +3567,9 @@ components: $ref: "#/components/schemas/DatasetRid" branchId: $ref: "#/components/schemas/BranchId" - path: - $ref: "#/components/schemas/FilePath" required: - datasetRid - branchId - - path type: object errorCode: enum: @@ -4013,52 +3581,22 @@ components: type: string x-type: error x-namespace: Datasets - FileNotFoundOnTransactionRange: - description: "The requested file could not be found on the given transaction range, or the client token does not have access to it." - properties: - parameters: - properties: - datasetRid: - $ref: "#/components/schemas/DatasetRid" - startTransactionRid: - $ref: "#/components/schemas/TransactionRid" - endTransactionRid: - $ref: "#/components/schemas/TransactionRid" - path: - $ref: "#/components/schemas/FilePath" - required: - - datasetRid - - endTransactionRid - - path - type: object - errorCode: - enum: - - NOT_FOUND - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - FileAlreadyExists: - description: The given file path already exists in the dataset and transaction. + CreateBranchPermissionDenied: + description: The provided token does not have permission to create a branch of this dataset. properties: parameters: properties: datasetRid: $ref: "#/components/schemas/DatasetRid" - transactionRid: - $ref: "#/components/schemas/TransactionRid" - path: - $ref: "#/components/schemas/FilePath" + branchId: + $ref: "#/components/schemas/BranchId" required: - datasetRid - - transactionRid - - path + - branchId type: object errorCode: enum: - - NOT_FOUND + - PERMISSION_DENIED type: string errorName: type: string @@ -4066,8 +3604,8 @@ components: type: string x-type: error x-namespace: Datasets - SchemaNotFound: - description: "A schema could not be found for the given dataset and branch, or the client token does not have access to it." + DeleteBranchPermissionDenied: + description: The provided token does not have permission to delete the given branch from this dataset. properties: parameters: properties: @@ -4075,15 +3613,13 @@ components: $ref: "#/components/schemas/DatasetRid" branchId: $ref: "#/components/schemas/BranchId" - transactionRid: - $ref: "#/components/schemas/TransactionRid" required: - datasetRid - branchId type: object errorCode: enum: - - NOT_FOUND + - PERMISSION_DENIED type: string errorName: type: string @@ -4091,8 +3627,8 @@ components: type: string x-type: error x-namespace: Datasets - PutSchemaPermissionDenied: - description: todo + CreateTransactionPermissionDenied: + description: The provided token does not have permission to create a transaction on this dataset. properties: parameters: properties: @@ -4114,8 +3650,8 @@ components: type: string x-type: error x-namespace: Datasets - DeleteSchemaPermissionDenied: - description: todo + OpenTransactionAlreadyExists: + description: A transaction is already open on this dataset and branch. A branch of a dataset can only have one open transaction at a time. properties: parameters: properties: @@ -4123,15 +3659,13 @@ components: $ref: "#/components/schemas/DatasetRid" branchId: $ref: "#/components/schemas/BranchId" - transactionRid: - $ref: "#/components/schemas/TransactionRid" required: - datasetRid - branchId type: object errorCode: enum: - - PERMISSION_DENIED + - CONFLICT type: string errorName: type: string @@ -4139,19 +3673,25 @@ components: type: string x-type: error x-namespace: Datasets - ReadTablePermissionDenied: - description: The provided token does not have permission to read the given dataset as a table. + TransactionNotOpen: + description: The given transaction is not open. properties: parameters: properties: datasetRid: $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + transactionStatus: + $ref: "#/components/schemas/TransactionStatus" required: - datasetRid + - transactionRid + - transactionStatus type: object errorCode: enum: - - PERMISSION_DENIED + - INVALID_ARGUMENT type: string errorName: type: string @@ -4159,15 +3699,21 @@ components: type: string x-type: error x-namespace: Datasets - DatasetReadNotSupported: - description: The dataset does not support being read. + TransactionNotCommitted: + description: The given transaction has not been committed. properties: parameters: properties: datasetRid: $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + transactionStatus: + $ref: "#/components/schemas/TransactionStatus" required: - datasetRid + - transactionRid + - transactionStatus type: object errorCode: enum: @@ -4179,153 +3725,91 @@ components: type: string x-type: error x-namespace: Datasets - ColumnTypesNotSupported: - description: The dataset contains column types that are not supported. + TransactionNotFound: + description: "The requested transaction could not be found on the dataset, or the client token does not have access to it." properties: parameters: properties: datasetRid: $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" required: - datasetRid + - transactionRid type: object errorCode: enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Datasets - InvalidAggregationRange: - description: | - Aggregation range should include one lt or lte and one gt or gte. - properties: - parameters: - type: object - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - InvalidAggregationRangePropertyType: - description: | - Range group by is not supported by property type. - properties: - parameters: - type: object - properties: - property: - $ref: "#/components/schemas/PropertyApiName" - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - propertyBaseType: - $ref: "#/components/schemas/ValueType" - required: - - property - - objectType - - propertyBaseType - errorCode: - enum: - - INVALID_ARGUMENT - type: string - errorName: - type: string - errorInstanceId: - type: string - x-type: error - x-namespace: Ontologies - InvalidAggregationRangeValue: - description: | - Aggregation value does not conform to the expected underlying type. - properties: - parameters: - type: object - properties: - property: - $ref: "#/components/schemas/PropertyApiName" - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - propertyBaseType: - $ref: "#/components/schemas/ValueType" - required: - - property - - objectType - - propertyBaseType - errorCode: - enum: - - INVALID_ARGUMENT + - NOT_FOUND type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - InvalidDurationGroupByPropertyType: - description: | - Invalid property type for duration groupBy. + x-namespace: Datasets + CommitTransactionPermissionDenied: + description: The provided token does not have permission to commit the given transaction on the given dataset. properties: parameters: - type: object properties: - property: - $ref: "#/components/schemas/PropertyApiName" - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - propertyBaseType: - $ref: "#/components/schemas/ValueType" + datasetRid: + $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" required: - - property - - objectType - - propertyBaseType + - datasetRid + - transactionRid + type: object errorCode: enum: - - INVALID_ARGUMENT + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - InvalidDurationGroupByValue: - description: | - Duration groupBy value is invalid. Units larger than day must have value `1` and date properties do not support - filtering on units smaller than day. As examples, neither bucketing by every two weeks nor bucketing a date by - every two hours are allowed. + x-namespace: Datasets + AbortTransactionPermissionDenied: + description: The provided token does not have permission to abort the given transaction on the given dataset. properties: parameters: + properties: + datasetRid: + $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + required: + - datasetRid + - transactionRid type: object errorCode: enum: - - INVALID_ARGUMENT + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - MultipleGroupByOnFieldNotSupported: - description: | - Aggregation cannot group by on the same field multiple times. + x-namespace: Datasets + InvalidTransactionType: + description: "The given transaction type is not valid. Valid transaction types are `SNAPSHOT`, `UPDATE`, `APPEND`, and `DELETE`." properties: parameters: - type: object properties: - duplicateFields: - items: - type: string - x-safety: unsafe - type: array + datasetRid: + $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + transactionType: + $ref: "#/components/schemas/TransactionType" + required: + - datasetRid + - transactionRid + - transactionType + type: object errorCode: enum: - INVALID_ARGUMENT @@ -4335,164 +3819,215 @@ components: errorInstanceId: type: string x-type: error - x-namespace: Ontologies - InvalidAggregationOrdering: - description: | - Aggregation ordering can only be applied to metrics with exactly one groupBy clause. + x-namespace: Datasets + UploadFilePermissionDenied: + description: The provided token does not have permission to upload the given file to the given dataset and transaction. properties: parameters: + properties: + datasetRid: + $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + path: + $ref: "#/components/schemas/FilePath" + required: + - datasetRid + - transactionRid + - path type: object errorCode: enum: - - INVALID_ARGUMENT + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - ApiFeaturePreviewUsageOnly: - description: | - This feature is only supported in preview mode. Please use `preview=true` in the query - parameters to call this endpoint. + x-namespace: Datasets + FileNotFoundOnBranch: + description: "The requested file could not be found on the given branch, or the client token does not have access to it." properties: parameters: + properties: + datasetRid: + $ref: "#/components/schemas/DatasetRid" + branchId: + $ref: "#/components/schemas/BranchId" + path: + $ref: "#/components/schemas/FilePath" + required: + - datasetRid + - branchId + - path type: object errorCode: enum: - - INVALID_ARGUMENT + - NOT_FOUND type: string errorName: type: string errorInstanceId: type: string x-type: error - ApiUsageDenied: - description: You are not allowed to use Palantir APIs. + x-namespace: Datasets + FileNotFoundOnTransactionRange: + description: "The requested file could not be found on the given transaction range, or the client token does not have access to it." properties: parameters: + properties: + datasetRid: + $ref: "#/components/schemas/DatasetRid" + startTransactionRid: + $ref: "#/components/schemas/TransactionRid" + endTransactionRid: + $ref: "#/components/schemas/TransactionRid" + path: + $ref: "#/components/schemas/FilePath" + required: + - datasetRid + - endTransactionRid + - path type: object errorCode: enum: - - PERMISSION_DENIED + - NOT_FOUND type: string errorName: type: string errorInstanceId: type: string x-type: error - InvalidPageSize: - description: The provided page size was zero or negative. Page sizes must be greater than zero. + x-namespace: Datasets + FileAlreadyExists: + description: The given file path already exists in the dataset and transaction. properties: parameters: properties: - pageSize: - $ref: "#/components/schemas/PageSize" + datasetRid: + $ref: "#/components/schemas/DatasetRid" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + path: + $ref: "#/components/schemas/FilePath" required: - - pageSize + - datasetRid + - transactionRid + - path type: object errorCode: enum: - - INVALID_ARGUMENT + - NOT_FOUND type: string errorName: type: string errorInstanceId: type: string x-type: error - InvalidPageToken: - description: The provided page token could not be used to retrieve the next page of results. + x-namespace: Datasets + SchemaNotFound: + description: "A schema could not be found for the given dataset and branch, or the client token does not have access to it." properties: parameters: properties: - pageToken: - $ref: "#/components/schemas/PageToken" + datasetRid: + $ref: "#/components/schemas/DatasetRid" + branchId: + $ref: "#/components/schemas/BranchId" + transactionRid: + $ref: "#/components/schemas/TransactionRid" required: - - pageToken + - datasetRid + - branchId type: object errorCode: enum: - - INVALID_ARGUMENT + - NOT_FOUND type: string errorName: type: string errorInstanceId: type: string x-type: error - InvalidParameterCombination: - description: The given parameters are individually valid but cannot be used in the given combination. + x-namespace: Datasets + PutSchemaPermissionDenied: + description: todo properties: parameters: properties: - validCombinations: - type: array - items: - type: array - items: - type: string - x-safety: safe - providedParameters: - type: array - items: - type: string - x-safety: safe + datasetRid: + $ref: "#/components/schemas/DatasetRid" + branchId: + $ref: "#/components/schemas/BranchId" + required: + - datasetRid + - branchId type: object errorCode: enum: - - INVALID_ARGUMENT + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - ResourceNameAlreadyExists: - description: The provided resource name is already in use by another resource in the same folder. + x-namespace: Datasets + DeleteSchemaPermissionDenied: + description: todo properties: parameters: properties: - parentFolderRid: - $ref: "#/components/schemas/FolderRid" - resourceName: - type: string - x-safety: unsafe + datasetRid: + $ref: "#/components/schemas/DatasetRid" + branchId: + $ref: "#/components/schemas/BranchId" + transactionRid: + $ref: "#/components/schemas/TransactionRid" required: - - parentFolderRid - - resourceName + - datasetRid + - branchId type: object errorCode: enum: - - CONFLICT + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - FolderNotFound: - description: "The requested folder could not be found, or the client token does not have access to it." + x-namespace: Datasets + ReadTablePermissionDenied: + description: The provided token does not have permission to read the given dataset as a table. properties: parameters: properties: - folderRid: - $ref: "#/components/schemas/FolderRid" + datasetRid: + $ref: "#/components/schemas/DatasetRid" required: - - folderRid + - datasetRid type: object errorCode: enum: - - NOT_FOUND + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - MissingPostBody: - description: "A post body is required for this endpoint, but was not found in the request." + x-namespace: Datasets + DatasetReadNotSupported: + description: The dataset does not support being read. properties: parameters: + properties: + datasetRid: + $ref: "#/components/schemas/DatasetRid" + required: + - datasetRid type: object errorCode: enum: @@ -4503,21 +4038,17 @@ components: errorInstanceId: type: string x-type: error - UnknownDistanceUnit: - description: An unknown distance unit was provided. - properties: - parameters: - type: object - properties: - unknownUnit: - type: string - x-safety: unsafe - knownUnits: - type: array - items: - $ref: "#/components/schemas/DistanceUnit" + x-namespace: Datasets + ColumnTypesNotSupported: + description: The dataset contains column types that are not supported. + properties: + parameters: + properties: + datasetRid: + $ref: "#/components/schemas/DatasetRid" required: - - unknownUnit + - datasetRid + type: object errorCode: enum: - INVALID_ARGUMENT @@ -4527,968 +4058,1247 @@ components: errorInstanceId: type: string x-type: error - AnyType: - type: object - AttachmentType: - type: object - BinaryType: - type: object - BooleanType: - type: object - ByteType: + x-namespace: Datasets + ActionParameterArrayType: type: object - DateType: + properties: + subType: + $ref: "#/components/schemas/ActionParameterType" + required: + - subType + x-namespace: Ontologies + ActionParameterType: + x-namespace: Ontologies + description: | + A union of all the types supported by Ontology Action parameters. + discriminator: + propertyName: type + mapping: + array: "#/components/schemas/ActionParameterArrayType" + attachment: "#/components/schemas/AttachmentType" + boolean: "#/components/schemas/BooleanType" + date: "#/components/schemas/DateType" + double: "#/components/schemas/DoubleType" + integer: "#/components/schemas/IntegerType" + long: "#/components/schemas/LongType" + marking: "#/components/schemas/MarkingType" + objectSet: "#/components/schemas/OntologyObjectSetType" + object: "#/components/schemas/OntologyObjectType" + string: "#/components/schemas/StringType" + timestamp: "#/components/schemas/TimestampType" + oneOf: + - $ref: "#/components/schemas/ActionParameterArrayType" + - $ref: "#/components/schemas/AttachmentType" + - $ref: "#/components/schemas/BooleanType" + - $ref: "#/components/schemas/DateType" + - $ref: "#/components/schemas/DoubleType" + - $ref: "#/components/schemas/IntegerType" + - $ref: "#/components/schemas/LongType" + - $ref: "#/components/schemas/MarkingType" + - $ref: "#/components/schemas/OntologyObjectSetType" + - $ref: "#/components/schemas/OntologyObjectType" + - $ref: "#/components/schemas/StringType" + - $ref: "#/components/schemas/TimestampType" + OntologyDataType: + x-namespace: Ontologies + description: | + A union of all the primitive types used by Palantir's Ontology-based products. + discriminator: + propertyName: type + mapping: + any: "#/components/schemas/AnyType" + binary: "#/components/schemas/BinaryType" + boolean: "#/components/schemas/BooleanType" + byte: "#/components/schemas/ByteType" + date: "#/components/schemas/DateType" + decimal: "#/components/schemas/DecimalType" + double: "#/components/schemas/DoubleType" + float: "#/components/schemas/FloatType" + integer: "#/components/schemas/IntegerType" + long: "#/components/schemas/LongType" + marking: "#/components/schemas/MarkingType" + short: "#/components/schemas/ShortType" + string: "#/components/schemas/StringType" + timestamp: "#/components/schemas/TimestampType" + array: "#/components/schemas/OntologyArrayType" + map: "#/components/schemas/OntologyMapType" + set: "#/components/schemas/OntologySetType" + struct: "#/components/schemas/OntologyStructType" + object: "#/components/schemas/OntologyObjectType" + objectSet: "#/components/schemas/OntologyObjectSetType" + unsupported: "#/components/schemas/UnsupportedType" + oneOf: + - $ref: "#/components/schemas/AnyType" + - $ref: "#/components/schemas/BinaryType" + - $ref: "#/components/schemas/BooleanType" + - $ref: "#/components/schemas/ByteType" + - $ref: "#/components/schemas/DateType" + - $ref: "#/components/schemas/DecimalType" + - $ref: "#/components/schemas/DoubleType" + - $ref: "#/components/schemas/FloatType" + - $ref: "#/components/schemas/IntegerType" + - $ref: "#/components/schemas/LongType" + - $ref: "#/components/schemas/MarkingType" + - $ref: "#/components/schemas/ShortType" + - $ref: "#/components/schemas/StringType" + - $ref: "#/components/schemas/TimestampType" + - $ref: "#/components/schemas/OntologyArrayType" + - $ref: "#/components/schemas/OntologyMapType" + - $ref: "#/components/schemas/OntologySetType" + - $ref: "#/components/schemas/OntologyStructType" + - $ref: "#/components/schemas/OntologyObjectType" + - $ref: "#/components/schemas/OntologyObjectSetType" + - $ref: "#/components/schemas/UnsupportedType" + OntologyObjectSetType: + x-namespace: Ontologies type: object - DecimalType: + properties: + objectApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + objectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + OntologyObjectType: + x-namespace: Ontologies type: object properties: - precision: - type: integer - x-safety: safe - scale: - type: integer - x-safety: safe - DoubleType: + objectApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + objectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - objectApiName + - objectTypeApiName + OntologyArrayType: + x-namespace: Ontologies type: object - FilesystemResource: + properties: + itemType: + $ref: "#/components/schemas/OntologyDataType" + required: + - itemType + OntologyMapType: + x-namespace: Ontologies type: object - FloatType: + properties: + keyType: + $ref: "#/components/schemas/OntologyDataType" + valueType: + $ref: "#/components/schemas/OntologyDataType" + required: + - keyType + - valueType + OntologySetType: + x-namespace: Ontologies type: object - GeoShapeType: + properties: + itemType: + $ref: "#/components/schemas/OntologyDataType" + required: + - itemType + OntologyStructType: + x-namespace: Ontologies type: object - GeoPointType: + properties: + fields: + type: array + items: + $ref: "#/components/schemas/OntologyStructField" + OntologyStructField: + x-namespace: Ontologies type: object - IntegerType: + properties: + name: + $ref: "#/components/schemas/StructFieldName" + fieldType: + $ref: "#/components/schemas/OntologyDataType" + required: + type: boolean + x-safety: safe + required: + - name + - required + - fieldType + QueryDataType: + x-namespace: Ontologies + description: | + A union of all the types supported by Ontology Query parameters or outputs. + discriminator: + propertyName: type + mapping: + array: "#/components/schemas/QueryArrayType" + attachment: "#/components/schemas/AttachmentType" + boolean: "#/components/schemas/BooleanType" + date: "#/components/schemas/DateType" + double: "#/components/schemas/DoubleType" + float: "#/components/schemas/FloatType" + integer: "#/components/schemas/IntegerType" + long: "#/components/schemas/LongType" + objectSet: "#/components/schemas/OntologyObjectSetType" + object: "#/components/schemas/OntologyObjectType" + set: "#/components/schemas/QuerySetType" + string: "#/components/schemas/StringType" + struct: "#/components/schemas/QueryStructType" + threeDimensionalAggregation: "#/components/schemas/ThreeDimensionalAggregation" + timestamp: "#/components/schemas/TimestampType" + twoDimensionalAggregation: "#/components/schemas/TwoDimensionalAggregation" + union: "#/components/schemas/QueryUnionType" + "null": "#/components/schemas/NullType" + unsupported: "#/components/schemas/UnsupportedType" + oneOf: + - $ref: "#/components/schemas/QueryArrayType" + - $ref: "#/components/schemas/AttachmentType" + - $ref: "#/components/schemas/BooleanType" + - $ref: "#/components/schemas/DateType" + - $ref: "#/components/schemas/DoubleType" + - $ref: "#/components/schemas/FloatType" + - $ref: "#/components/schemas/IntegerType" + - $ref: "#/components/schemas/LongType" + - $ref: "#/components/schemas/OntologyObjectSetType" + - $ref: "#/components/schemas/OntologyObjectType" + - $ref: "#/components/schemas/QuerySetType" + - $ref: "#/components/schemas/StringType" + - $ref: "#/components/schemas/QueryStructType" + - $ref: "#/components/schemas/ThreeDimensionalAggregation" + - $ref: "#/components/schemas/TimestampType" + - $ref: "#/components/schemas/TwoDimensionalAggregation" + - $ref: "#/components/schemas/QueryUnionType" + - $ref: "#/components/schemas/NullType" + - $ref: "#/components/schemas/UnsupportedType" + QueryArrayType: + x-namespace: Ontologies type: object - LocalFilePath: + properties: + subType: + $ref: "#/components/schemas/QueryDataType" + required: + - subType + QuerySetType: + x-namespace: Ontologies type: object - LongType: + properties: + subType: + $ref: "#/components/schemas/QueryDataType" + required: + - subType + QueryStructType: + x-namespace: Ontologies type: object - MarkingType: + properties: + fields: + type: array + items: + $ref: "#/components/schemas/QueryStructField" + QueryStructField: + x-namespace: Ontologies type: object - ShortType: + properties: + name: + $ref: "#/components/schemas/StructFieldName" + fieldType: + $ref: "#/components/schemas/QueryDataType" + required: + - name + - fieldType + QueryUnionType: + x-namespace: Ontologies type: object - StringType: + properties: + unionTypes: + type: array + items: + $ref: "#/components/schemas/QueryDataType" + QueryAggregationRangeType: + x-namespace: Ontologies type: object - TimeSeriesItemType: + properties: + subType: + $ref: "#/components/schemas/QueryAggregationRangeSubType" + required: + - subType + QueryAggregationRangeSubType: + x-namespace: Ontologies description: | - A union of the types supported by time series properties. + A union of all the types supported by query aggregation ranges. + discriminator: + propertyName: type + mapping: + date: "#/components/schemas/DateType" + double: "#/components/schemas/DoubleType" + integer: "#/components/schemas/IntegerType" + timestamp: "#/components/schemas/TimestampType" + oneOf: + - $ref: "#/components/schemas/DateType" + - $ref: "#/components/schemas/DoubleType" + - $ref: "#/components/schemas/IntegerType" + - $ref: "#/components/schemas/TimestampType" + QueryAggregationKeyType: + x-namespace: Ontologies + description: | + A union of all the types supported by query aggregation keys. discriminator: propertyName: type mapping: + boolean: "#/components/schemas/BooleanType" + date: "#/components/schemas/DateType" double: "#/components/schemas/DoubleType" + integer: "#/components/schemas/IntegerType" string: "#/components/schemas/StringType" + timestamp: "#/components/schemas/TimestampType" + range: "#/components/schemas/QueryAggregationRangeType" oneOf: + - $ref: "#/components/schemas/BooleanType" + - $ref: "#/components/schemas/DateType" - $ref: "#/components/schemas/DoubleType" + - $ref: "#/components/schemas/IntegerType" - $ref: "#/components/schemas/StringType" - TimeseriesType: - type: object - properties: - itemType: - $ref: "#/components/schemas/TimeSeriesItemType" - required: - - itemType - TimestampType: - type: object - StructFieldName: - description: | - The name of a field in a `Struct`. - type: string - x-safety: unsafe - NullType: - type: object - UnsupportedType: - type: object - properties: - unsupportedType: - type: string - x-safety: safe - required: - - unsupportedType - ContentLength: - type: string - format: long - x-safety: safe - ContentType: - type: string - x-safety: safe - Duration: - type: string - description: An ISO 8601 formatted duration. - x-safety: unsafe - PageSize: - description: The page size to use for the endpoint. - type: integer - x-safety: safe - PageToken: - description: | - The page token indicates where to start paging. This should be omitted from the first page's request. - To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response - and populate the next request's `pageToken` field with it. - type: string - x-safety: unsafe - TotalCount: - description: | - The total number of items across all pages. - type: string - format: long - x-safety: safe - PreviewMode: - description: Enables the use of preview functionality. - type: boolean - x-safety: safe - SizeBytes: - description: The size of the file or attachment in bytes. - type: string - format: long - x-safety: safe - UserId: - description: | - A Foundry User ID. - format: uuid - type: string - x-safety: safe - CreatedTime: - description: | - The time at which the resource was created. - type: string - x-safety: safe - UpdatedTime: - description: | - The time at which the resource was most recently updated. - type: string - x-safety: safe - FolderRid: - type: string - format: rid - x-safety: safe - FilePath: - description: | - The path to a File within Foundry. Examples: `my-file.txt`, `path/to/my-file.jpg`, `dataframe.snappy.parquet`. - type: string - x-safety: unsafe - Filename: - description: | - The name of a File within Foundry. Examples: `my-file.txt`, `my-file.jpg`, `dataframe.snappy.parquet`. - type: string - x-safety: unsafe - ArchiveFileFormat: - description: | - The format of an archive file. - enum: - - ZIP - DisplayName: - type: string - description: The display name of the entity. - x-safety: unsafe - MediaType: - description: | - The [media type](https://www.iana.org/assignments/media-types/media-types.xhtml) of the file or attachment. - Examples: `application/json`, `application/pdf`, `application/octet-stream`, `image/jpeg` - type: string - x-safety: safe - ReleaseStatus: - enum: - - ACTIVE - - EXPERIMENTAL - - DEPRECATED - description: The release status of the entity. - TimeUnit: - enum: - - MILLISECONDS - - SECONDS - - MINUTES - - HOURS - - DAYS - - WEEKS - - MONTHS - - YEARS - - QUARTERS - Distance: - type: object - description: A measurement of distance. - properties: - value: - type: number - format: double - x-safety: unsafe - unit: - $ref: "#/components/schemas/DistanceUnit" - required: - - value - - unit - DistanceUnit: - enum: - - MILLIMETERS - - CENTIMETERS - - METERS - - KILOMETERS - - INCHES - - FEET - - YARDS - - MILES - - NAUTICAL_MILES - SearchJsonQueryV2: - type: object + - $ref: "#/components/schemas/TimestampType" + - $ref: "#/components/schemas/QueryAggregationRangeType" + QueryAggregationValueType: x-namespace: Ontologies + description: | + A union of all the types supported by query aggregation keys. discriminator: propertyName: type mapping: - lt: "#/components/schemas/LtQueryV2" - gt: "#/components/schemas/GtQueryV2" - lte: "#/components/schemas/LteQueryV2" - gte: "#/components/schemas/GteQueryV2" - eq: "#/components/schemas/EqualsQueryV2" - isNull: "#/components/schemas/IsNullQueryV2" - contains: "#/components/schemas/ContainsQueryV2" - and: "#/components/schemas/AndQueryV2" - or: "#/components/schemas/OrQueryV2" - not: "#/components/schemas/NotQueryV2" - startsWith: "#/components/schemas/StartsWithQuery" - containsAllTermsInOrder: "#/components/schemas/ContainsAllTermsInOrderQuery" - containsAllTermsInOrderPrefixLastTerm: "#/components/schemas/ContainsAllTermsInOrderPrefixLastTerm" - containsAnyTerm: "#/components/schemas/ContainsAnyTermQuery" - containsAllTerms: "#/components/schemas/ContainsAllTermsQuery" - withinDistanceOf: "#/components/schemas/WithinDistanceOfQuery" - withinBoundingBox: "#/components/schemas/WithinBoundingBoxQuery" - intersectsBoundingBox: "#/components/schemas/IntersectsBoundingBoxQuery" - doesNotIntersectBoundingBox: "#/components/schemas/DoesNotIntersectBoundingBoxQuery" - withinPolygon: "#/components/schemas/WithinPolygonQuery" - intersectsPolygon: "#/components/schemas/IntersectsPolygonQuery" - doesNotIntersectPolygon: "#/components/schemas/DoesNotIntersectPolygonQuery" + date: "#/components/schemas/DateType" + double: "#/components/schemas/DoubleType" + timestamp: "#/components/schemas/TimestampType" oneOf: - - $ref: "#/components/schemas/LtQueryV2" - - $ref: "#/components/schemas/GtQueryV2" - - $ref: "#/components/schemas/LteQueryV2" - - $ref: "#/components/schemas/GteQueryV2" - - $ref: "#/components/schemas/EqualsQueryV2" - - $ref: "#/components/schemas/IsNullQueryV2" - - $ref: "#/components/schemas/ContainsQueryV2" - - $ref: "#/components/schemas/AndQueryV2" - - $ref: "#/components/schemas/OrQueryV2" - - $ref: "#/components/schemas/NotQueryV2" - - $ref: "#/components/schemas/StartsWithQuery" - - $ref: "#/components/schemas/ContainsAllTermsInOrderQuery" - - $ref: "#/components/schemas/ContainsAllTermsInOrderPrefixLastTerm" - - $ref: "#/components/schemas/ContainsAnyTermQuery" - - $ref: "#/components/schemas/ContainsAllTermsQuery" - - $ref: "#/components/schemas/WithinDistanceOfQuery" - - $ref: "#/components/schemas/WithinBoundingBoxQuery" - - $ref: "#/components/schemas/IntersectsBoundingBoxQuery" - - $ref: "#/components/schemas/DoesNotIntersectBoundingBoxQuery" - - $ref: "#/components/schemas/WithinPolygonQuery" - - $ref: "#/components/schemas/IntersectsPolygonQuery" - - $ref: "#/components/schemas/DoesNotIntersectPolygonQuery" - LtQueryV2: - type: object + - $ref: "#/components/schemas/DateType" + - $ref: "#/components/schemas/DoubleType" + - $ref: "#/components/schemas/TimestampType" + TwoDimensionalAggregation: x-namespace: Ontologies - description: Returns objects where the specified field is less than a value. - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - GtQueryV2: type: object - x-namespace: Ontologies - description: Returns objects where the specified field is greater than a value. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PropertyValue" + keyType: + $ref: "#/components/schemas/QueryAggregationKeyType" + valueType: + $ref: "#/components/schemas/QueryAggregationValueType" required: - - field - - value - LteQueryV2: - type: object + - keyType + - valueType + ThreeDimensionalAggregation: x-namespace: Ontologies - description: Returns objects where the specified field is less than or equal to a value. - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - GteQueryV2: type: object - x-namespace: Ontologies - description: Returns objects where the specified field is greater than or equal to a value. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PropertyValue" + keyType: + $ref: "#/components/schemas/QueryAggregationKeyType" + valueType: + $ref: "#/components/schemas/TwoDimensionalAggregation" required: - - field - - value - EqualsQueryV2: - type: object + - keyType + - valueType + ValueType: x-namespace: Ontologies - description: Returns objects where the specified field is equal to a value. - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - IsNullQueryV2: - type: object + type: string + x-safety: safe + description: | + A string indicating the type of each data value. Note that these types can be nested, for example an array of + structs. + + | Type | JSON value | + |---------------------|-------------------------------------------------------------------------------------------------------------------| + | Array | `Array`, where `T` is the type of the array elements, e.g. `Array`. | + | Attachment | `Attachment` | + | Boolean | `Boolean` | + | Byte | `Byte` | + | Date | `LocalDate` | + | Decimal | `Decimal` | + | Double | `Double` | + | Float | `Float` | + | Integer | `Integer` | + | Long | `Long` | + | Marking | `Marking` | + | OntologyObject | `OntologyObject` where `T` is the API name of the referenced object type. | + | Short | `Short` | + | String | `String` | + | Struct | `Struct` where `T` contains field name and type pairs, e.g. `Struct<{ firstName: String, lastName: string }>` | + | Timeseries | `TimeSeries` where `T` is either `String` for an enum series or `Double` for a numeric series. | + | Timestamp | `Timestamp` | + ArraySizeConstraint: x-namespace: Ontologies - description: Returns objects based on the existence of the specified field. + description: | + The parameter expects an array of values and the size of the array must fall within the defined range. + type: object properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - type: boolean + lt: + description: Less than x-safety: unsafe - required: - - field - - value - ContainsQueryV2: + lte: + description: Less than or equal + x-safety: unsafe + gt: + description: Greater than + x-safety: unsafe + gte: + description: Greater than or equal + x-safety: unsafe + GroupMemberConstraint: + description: | + The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. type: object x-namespace: Ontologies - description: Returns objects where the specified array contains a value. - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PropertyValue" - required: - - field - - value - AndQueryV2: + ObjectPropertyValueConstraint: + description: | + The parameter value must be a property value of an object found within an object set. type: object x-namespace: Ontologies - description: Returns objects where every query is satisfied. - properties: - value: - items: - $ref: "#/components/schemas/SearchJsonQueryV2" - type: array - OrQueryV2: + ObjectQueryResultConstraint: + description: | + The parameter value must be the primary key of an object found within an object set. type: object x-namespace: Ontologies - description: Returns objects where at least 1 query is satisfied. - properties: - value: - items: - $ref: "#/components/schemas/SearchJsonQueryV2" - type: array - NotQueryV2: + OneOfConstraint: + description: | + The parameter has a manually predefined set of options. type: object x-namespace: Ontologies - description: Returns objects where the query is not satisfied. properties: - value: - $ref: "#/components/schemas/SearchJsonQueryV2" + options: + type: array + items: + $ref: "#/components/schemas/ParameterOption" + otherValuesAllowed: + description: "A flag denoting whether custom, user provided values will be considered valid. This is configured via the **Allowed \"Other\" value** toggle in the **Ontology Manager**." + type: boolean + x-safety: unsafe required: - - value - StartsWithQuery: + - otherValuesAllowed + RangeConstraint: + description: | + The parameter value must be within the defined range. type: object x-namespace: Ontologies - description: Returns objects where the specified field starts with the provided value. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - type: string + lt: + description: Less than x-safety: unsafe - required: - - field - - value - ContainsAllTermsInOrderQuery: + lte: + description: Less than or equal + x-safety: unsafe + gt: + description: Greater than + x-safety: unsafe + gte: + description: Greater than or equal + x-safety: unsafe + StringLengthConstraint: + description: | + The parameter value must have a length within the defined range. + *This range is always inclusive.* type: object x-namespace: Ontologies + properties: + lt: + description: Less than + x-safety: unsafe + lte: + description: Less than or equal + x-safety: unsafe + gt: + description: Greater than + x-safety: unsafe + gte: + description: Greater than or equal + x-safety: unsafe + StringRegexMatchConstraint: description: | - Returns objects where the specified field contains all of the terms in the order provided, - but they do have to be adjacent to each other. + The parameter value must match a predefined regular expression. + type: object + x-namespace: Ontologies properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: + regex: + description: The regular expression configured in the **Ontology Manager**. + type: string + x-safety: unsafe + configuredFailureMessage: + description: | + The message indicating that the regular expression was not matched. + This is configured per parameter in the **Ontology Manager**. type: string x-safety: unsafe required: - - field - - value - ContainsAllTermsInOrderPrefixLastTerm: + - regex + UnevaluableConstraint: + description: | + The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. + This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. + type: object + x-namespace: Ontologies + ParameterEvaluatedConstraint: + description: "A constraint that an action parameter value must satisfy in order to be considered valid.\nConstraints can be configured on action parameters in the **Ontology Manager**. \nApplicable constraints are determined dynamically based on parameter inputs. \nParameter values are evaluated against the final set of constraints.\n\nThe type of the constraint.\n| Type | Description |\n|-----------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `arraySize` | The parameter expects an array of values and the size of the array must fall within the defined range. |\n| `groupMember` | The parameter value must be the user id of a member belonging to at least one of the groups defined by the constraint. |\n| `objectPropertyValue` | The parameter value must be a property value of an object found within an object set. |\n| `objectQueryResult` | The parameter value must be the primary key of an object found within an object set. |\n| `oneOf` | The parameter has a manually predefined set of options. |\n| `range` | The parameter value must be within the defined range. |\n| `stringLength` | The parameter value must have a length within the defined range. |\n| `stringRegexMatch` | The parameter value must match a predefined regular expression. |\n| `unevaluable` | The parameter cannot be evaluated because it depends on another parameter or object set that can't be evaluated. This can happen when a parameter's allowed values are defined by another parameter that is missing or invalid. |\n" + type: object + x-namespace: Ontologies + discriminator: + propertyName: type + mapping: + arraySize: "#/components/schemas/ArraySizeConstraint" + groupMember: "#/components/schemas/GroupMemberConstraint" + objectPropertyValue: "#/components/schemas/ObjectPropertyValueConstraint" + objectQueryResult: "#/components/schemas/ObjectQueryResultConstraint" + oneOf: "#/components/schemas/OneOfConstraint" + range: "#/components/schemas/RangeConstraint" + stringLength: "#/components/schemas/StringLengthConstraint" + stringRegexMatch: "#/components/schemas/StringRegexMatchConstraint" + unevaluable: "#/components/schemas/UnevaluableConstraint" + oneOf: + - $ref: "#/components/schemas/ArraySizeConstraint" + - $ref: "#/components/schemas/GroupMemberConstraint" + - $ref: "#/components/schemas/ObjectPropertyValueConstraint" + - $ref: "#/components/schemas/ObjectQueryResultConstraint" + - $ref: "#/components/schemas/OneOfConstraint" + - $ref: "#/components/schemas/RangeConstraint" + - $ref: "#/components/schemas/StringLengthConstraint" + - $ref: "#/components/schemas/StringRegexMatchConstraint" + - $ref: "#/components/schemas/UnevaluableConstraint" + ParameterEvaluationResult: + description: Represents the validity of a parameter against the configured constraints. type: object x-namespace: Ontologies - description: "Returns objects where the specified field contains all of the terms in the order provided, \nbut they do have to be adjacent to each other.\nThe last term can be a partial prefix match.\n" properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - type: string + result: + $ref: "#/components/schemas/ValidationResult" + evaluatedConstraints: + type: array + items: + $ref: "#/components/schemas/ParameterEvaluatedConstraint" + required: + description: Represents whether the parameter is a required input to the action. + type: boolean x-safety: unsafe required: - - field - - value - ContainsAnyTermQuery: + - result + - required + ParameterOption: + description: | + A possible value for the parameter. This is defined in the **Ontology Manager** by Actions admins. type: object x-namespace: Ontologies - description: "Returns objects where the specified field contains any of the whitespace separated words in any \norder in the provided value. This query supports fuzzy matching.\n" properties: - field: - $ref: "#/components/schemas/PropertyApiName" + displayName: + $ref: "#/components/schemas/DisplayName" value: + description: An allowed configured value for a parameter within an action. + x-safety: unsafe + ActionType: + description: Represents an action type in the Ontology. + properties: + apiName: + $ref: "#/components/schemas/ActionTypeApiName" + description: type: string x-safety: unsafe - fuzzy: - $ref: "#/components/schemas/FuzzyV2" + displayName: + $ref: "#/components/schemas/DisplayName" + status: + $ref: "#/components/schemas/ReleaseStatus" + parameters: + additionalProperties: + $ref: "#/components/schemas/Parameter" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + rid: + $ref: "#/components/schemas/ActionTypeRid" + operations: + type: array + items: + $ref: "#/components/schemas/LogicRule" required: - - field - - value - CenterPointTypes: + - apiName + - status + - rid type: object x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - Point: "#/components/schemas/GeoPoint" - oneOf: - - $ref: "#/components/schemas/GeoPoint" - WithinBoundingBoxPoint: - type: object + LogicRule: x-namespace: Ontologies discriminator: propertyName: type mapping: - Point: "#/components/schemas/GeoPoint" + createObject: "#/components/schemas/CreateObjectRule" + modifyObject: "#/components/schemas/ModifyObjectRule" + deleteObject: "#/components/schemas/DeleteObjectRule" + createLink: "#/components/schemas/CreateLinkRule" + deleteLink: "#/components/schemas/DeleteLinkRule" + createInterfaceObject: "#/components/schemas/CreateInterfaceObjectRule" + modifyInterfaceObject: "#/components/schemas/ModifyInterfaceObjectRule" oneOf: - - $ref: "#/components/schemas/GeoPoint" - CenterPoint: - type: object + - $ref: "#/components/schemas/CreateObjectRule" + - $ref: "#/components/schemas/ModifyObjectRule" + - $ref: "#/components/schemas/DeleteObjectRule" + - $ref: "#/components/schemas/CreateLinkRule" + - $ref: "#/components/schemas/DeleteLinkRule" + - $ref: "#/components/schemas/CreateInterfaceObjectRule" + - $ref: "#/components/schemas/ModifyInterfaceObjectRule" + CreateObjectRule: x-namespace: Ontologies - description: | - The coordinate point to use as the center of the distance query. + type: object properties: - center: - $ref: "#/components/schemas/CenterPointTypes" - distance: - $ref: "#/components/schemas/Distance" + objectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" required: - - center - - distance - WithinDistanceOfQuery: - type: object + - objectTypeApiName + ModifyObjectRule: x-namespace: Ontologies - description: | - Returns objects where the specified field contains a point within the distance provided of the center point. + type: object properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/CenterPoint" + objectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" required: - - field - - value - BoundingBoxValue: - type: object + - objectTypeApiName + DeleteObjectRule: x-namespace: Ontologies - description: | - The top left and bottom right coordinate points that make up the bounding box. + type: object properties: - topLeft: - $ref: "#/components/schemas/WithinBoundingBoxPoint" - bottomRight: - $ref: "#/components/schemas/WithinBoundingBoxPoint" + objectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" required: - - topLeft - - bottomRight - WithinBoundingBoxQuery: - type: object + - objectTypeApiName + CreateLinkRule: x-namespace: Ontologies - description: | - Returns objects where the specified field contains a point within the bounding box provided. + type: object properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/BoundingBoxValue" + linkTypeApiNameAtoB: + $ref: "#/components/schemas/LinkTypeApiName" + linkTypeApiNameBtoA: + $ref: "#/components/schemas/LinkTypeApiName" + aSideObjectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + bSideObjectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" required: - - field - - value - IntersectsBoundingBoxQuery: - type: object + - linkTypeApiNameAtoB + - linkTypeApiNameBtoA + - aSideObjectTypeApiName + - bSideObjectTypeApiName + DeleteLinkRule: x-namespace: Ontologies - description: | - Returns objects where the specified field intersects the bounding box provided. + type: object properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/BoundingBoxValue" + linkTypeApiNameAtoB: + $ref: "#/components/schemas/LinkTypeApiName" + linkTypeApiNameBtoA: + $ref: "#/components/schemas/LinkTypeApiName" + aSideObjectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" + bSideObjectTypeApiName: + $ref: "#/components/schemas/ObjectTypeApiName" required: - - field - - value - DoesNotIntersectBoundingBoxQuery: + - linkTypeApiNameAtoB + - linkTypeApiNameBtoA + - aSideObjectTypeApiName + - bSideObjectTypeApiName + CreateInterfaceObjectRule: + x-namespace: Ontologies type: object + properties: {} + ModifyInterfaceObjectRule: x-namespace: Ontologies + type: object + properties: {} + ActionTypeApiName: description: | - Returns objects where the specified field does not intersect the bounding box provided. + The name of the action type in the API. To find the API name for your Action Type, use the `List action types` + endpoint or check the **Ontology Manager**. + type: string + x-safety: unsafe + x-namespace: Ontologies + ActionTypeRid: + description: | + The unique resource identifier of an action type, useful for interacting with other Foundry APIs. + format: rid + type: string + x-safety: safe + x-namespace: Ontologies + ApplyActionRequest: properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/BoundingBoxValue" - required: - - field - - value - PolygonValue: + parameters: + nullable: true + additionalProperties: + $ref: "#/components/schemas/DataValue" + x-mapKey: + $ref: "#/components/schemas/ParameterId" type: object x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - Polygon: "#/components/schemas/Polygon" - oneOf: - - $ref: "#/components/schemas/Polygon" - WithinPolygonQuery: + BatchApplyActionRequest: + properties: + requests: + type: array + items: + $ref: "#/components/schemas/ApplyActionRequest" type: object x-namespace: Ontologies - description: | - Returns objects where the specified field contains a point within the polygon provided. + AsyncApplyActionRequest: properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PolygonValue" - required: - - field - - value - IntersectsPolygonQuery: + parameters: + nullable: true + additionalProperties: + $ref: "#/components/schemas/DataValue" + x-mapKey: + $ref: "#/components/schemas/ParameterId" type: object x-namespace: Ontologies - description: | - Returns objects where the specified field intersects the polygon provided. - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PolygonValue" - required: - - field - - value - DoesNotIntersectPolygonQuery: + ApplyActionResponse: + type: object + x-namespace: Ontologies + BatchApplyActionResponse: type: object x-namespace: Ontologies - description: | - Returns objects where the specified field does not intersect the polygon provided. + QueryType: + description: Represents a query type in the Ontology. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - $ref: "#/components/schemas/PolygonValue" + apiName: + $ref: "#/components/schemas/QueryApiName" + description: + type: string + x-safety: unsafe + displayName: + $ref: "#/components/schemas/DisplayName" + parameters: + additionalProperties: + $ref: "#/components/schemas/Parameter" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + output: + $ref: "#/components/schemas/OntologyDataType" + rid: + $ref: "#/components/schemas/FunctionRid" + version: + $ref: "#/components/schemas/FunctionVersion" required: - - field - - value - ContainsAllTermsQuery: + - apiName + - rid + - version type: object x-namespace: Ontologies + QueryApiName: description: | - Returns objects where the specified field contains all of the whitespace separated words in any - order in the provided value. This query supports fuzzy matching. + The name of the Query in the API. + type: string + x-safety: unsafe + x-namespace: Ontologies + ExecuteQueryRequest: properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - type: string - x-safety: unsafe - fuzzy: - $ref: "#/components/schemas/FuzzyV2" - required: - - field - - value - FuzzyV2: - description: Setting fuzzy to `true` allows approximate matching in search queries that support it. - type: boolean + parameters: + nullable: true + additionalProperties: + $ref: "#/components/schemas/DataValue" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + type: object x-namespace: Ontologies - x-safety: safe - SearchOrderByV2: - description: Specifies the ordering of search results by a field and an ordering direction. + Attachment: type: object x-namespace: Ontologies + description: The representation of an attachment. properties: - fields: - items: - $ref: "#/components/schemas/SearchOrderingV2" - type: array - SearchOrderingV2: + rid: + $ref: "#/components/schemas/AttachmentRid" + filename: + $ref: "#/components/schemas/Filename" + sizeBytes: + $ref: "#/components/schemas/SizeBytes" + mediaType: + $ref: "#/components/schemas/MediaType" + required: + - rid + - filename + - sizeBytes + - mediaType + AttachmentProperty: type: object x-namespace: Ontologies + description: The representation of an attachment as a data type. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - direction: - description: Specifies the ordering direction (can be either `asc` or `desc`) - type: string - x-safety: safe + rid: + $ref: "#/components/schemas/AttachmentRid" required: - - field - ArtifactRepositoryRid: - type: string + - rid + AttachmentRid: + description: The unique resource identifier of an attachment. format: rid - x-safety: safe - SdkPackageName: - type: string - x-safety: unsafe - ObjectSetRid: type: string + x-namespace: Ontologies + x-safety: safe + ActionRid: + description: The unique resource identifier for an action. format: rid + type: string + x-namespace: Ontologies x-safety: safe - CreateTemporaryObjectSetRequestV2: + AsyncApplyActionResponse: type: object x-namespace: Ontologies - properties: - objectSet: - $ref: "#/components/schemas/ObjectSet" - required: - - objectSet - CreateTemporaryObjectSetResponseV2: - type: object + AsyncActionOperation: + x-type: + type: asyncOperation + operationType: applyActionAsync + resultType: AsyncApplyActionResponse + stageType: AsyncActionStatus + x-namespace: Ontologies + AsyncActionStatus: + enum: + - RUNNING_SUBMISSION_CHECKS + - EXECUTING_WRITE_BACK_WEBHOOK + - COMPUTING_ONTOLOGY_EDITS + - COMPUTING_FUNCTION + - WRITING_ONTOLOGY_EDITS + - EXECUTING_SIDE_EFFECT_WEBHOOK + - SENDING_NOTIFICATIONS + x-namespace: Ontologies + QueryAggregation: x-namespace: Ontologies + type: object properties: - objectSetRid: - $ref: "#/components/schemas/ObjectSetRid" + key: + x-safety: unsafe + value: + x-safety: unsafe required: - - objectSetRid - AggregateObjectSetRequestV2: - type: object + - key + - value + NestedQueryAggregation: x-namespace: Ontologies + type: object properties: - aggregation: - items: - $ref: "#/components/schemas/AggregationV2" + key: + x-safety: unsafe + groups: type: array - objectSet: - $ref: "#/components/schemas/ObjectSet" - groupBy: items: - $ref: "#/components/schemas/AggregationGroupByV2" - type: array - accuracy: - $ref: "#/components/schemas/AggregationAccuracyRequest" + $ref: "#/components/schemas/QueryAggregation" required: - - objectSet - ActionTypeV2: + - key + QueryAggregationRange: + description: Specifies a range from an inclusive start value to an exclusive end value. type: object x-namespace: Ontologies - description: Represents an action type in the Ontology. properties: - apiName: - $ref: "#/components/schemas/ActionTypeApiName" - description: - type: string + startValue: + description: Inclusive start. x-safety: unsafe - displayName: - $ref: "#/components/schemas/DisplayName" - status: - $ref: "#/components/schemas/ReleaseStatus" - parameters: - additionalProperties: - $ref: "#/components/schemas/ActionParameterV2" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - rid: - $ref: "#/components/schemas/ActionTypeRid" - operations: + endValue: + description: Exclusive end. + x-safety: unsafe + QueryTwoDimensionalAggregation: + x-namespace: Ontologies + type: object + properties: + groups: type: array items: - $ref: "#/components/schemas/LogicRule" - required: - - apiName - - status - - rid - ActionParameterV2: - description: Details about a parameter of an action. + $ref: "#/components/schemas/QueryAggregation" + QueryThreeDimensionalAggregation: + x-namespace: Ontologies + type: object properties: - description: - type: string - x-safety: unsafe - dataType: - $ref: "#/components/schemas/ActionParameterType" - required: - type: boolean - x-safety: safe - required: - - dataType - - required + groups: + type: array + items: + $ref: "#/components/schemas/NestedQueryAggregation" + ExecuteQueryResponse: type: object + properties: + value: + $ref: "#/components/schemas/DataValue" + required: + - value x-namespace: Ontologies - BatchApplyActionRequestItem: + FilterValue: + description: | + Represents the value of a property filter. For instance, false is the FilterValue in + `properties.{propertyApiName}.isNull=false`. + type: string + x-namespace: Ontologies + x-safety: unsafe + FunctionRid: + description: | + The unique resource identifier of a Function, useful for interacting with other Foundry APIs. + format: rid + type: string + x-namespace: Ontologies + x-safety: safe + FunctionVersion: + description: | + The version of the given Function, written `..-`, where `-` is optional. + Examples: `1.2.3`, `1.2.3-rc1`. + type: string + x-namespace: Ontologies + x-safety: unsafe + CustomTypeId: + description: | + A UUID representing a custom type in a given Function. + type: string + x-namespace: Ontologies + x-safety: safe + LinkTypeApiName: + description: | + The name of the link type in the API. To find the API name for your Link Type, check the **Ontology Manager** + application. + type: string x-namespace: Ontologies - type: object - properties: - parameters: - nullable: true - additionalProperties: - $ref: "#/components/schemas/DataValue" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - BatchApplyActionRequestV2: + x-safety: unsafe + ListActionTypesResponse: properties: - options: - $ref: "#/components/schemas/BatchApplyActionRequestOptions" - requests: - type: array + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: items: - $ref: "#/components/schemas/BatchApplyActionRequestItem" - type: object - x-namespace: Ontologies - BatchApplyActionResponseV2: + $ref: "#/components/schemas/ActionType" + type: array type: object x-namespace: Ontologies - properties: - edits: - $ref: "#/components/schemas/ActionResults" - ListActionTypesResponseV2: + ListQueryTypesResponse: properties: nextPageToken: $ref: "#/components/schemas/PageToken" data: items: - $ref: "#/components/schemas/ActionTypeV2" + $ref: "#/components/schemas/QueryType" type: array type: object x-namespace: Ontologies - ListInterfaceTypesResponse: + ListLinkedObjectsResponse: properties: nextPageToken: $ref: "#/components/schemas/PageToken" data: items: - $ref: "#/components/schemas/InterfaceType" + $ref: "#/components/schemas/OntologyObject" type: array type: object x-namespace: Ontologies - SearchObjectsForInterfaceRequest: - type: object - x-namespace: Ontologies + ListObjectTypesResponse: properties: - where: - $ref: "#/components/schemas/SearchJsonQueryV2" - orderBy: - $ref: "#/components/schemas/SearchOrderByV2" - augmentedProperties: - description: "A map from object type API name to a list of property type API names. For each returned object, if the \nobject’s object type is a key in the map, then we augment the response for that object type with the list \nof properties specified in the value.\n" - additionalProperties: - items: - $ref: "#/components/schemas/PropertyApiName" - type: array - x-mapKey: - $ref: "#/components/schemas/ObjectTypeApiName" - augmentedSharedPropertyTypes: - description: "A map from interface type API name to a list of shared property type API names. For each returned object, if\nthe object implements an interface that is a key in the map, then we augment the response for that object \ntype with the list of properties specified in the value.\n" - additionalProperties: - items: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - type: array - x-mapKey: - $ref: "#/components/schemas/InterfaceTypeApiName" - selectedSharedPropertyTypes: - description: "A list of shared property type API names of the interface type that should be included in the response. \nOmit this parameter to include all properties of the interface type in the response.\n" - type: array - items: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - selectedObjectTypes: - description: "A list of object type API names that should be included in the response. If non-empty, object types that are\nnot mentioned will not be included in the response even if they implement the specified interface. Omit the \nparameter to include all object types.\n" - type: array + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + description: The list of object types in the current page. items: - $ref: "#/components/schemas/ObjectTypeApiName" - otherInterfaceTypes: - description: "A list of interface type API names. Object types must implement all the mentioned interfaces in order to be \nincluded in the response.\n" + $ref: "#/components/schemas/ObjectType" type: array - items: - $ref: "#/components/schemas/InterfaceTypeApiName" - pageSize: - $ref: "#/components/schemas/PageSize" - pageToken: - $ref: "#/components/schemas/PageToken" - ListQueryTypesResponseV2: + type: object + x-namespace: Ontologies + ListObjectsResponse: properties: nextPageToken: $ref: "#/components/schemas/PageToken" data: + description: The list of objects in the current page. items: - $ref: "#/components/schemas/QueryTypeV2" + $ref: "#/components/schemas/OntologyObject" type: array + totalCount: + $ref: "#/components/schemas/TotalCount" + required: + - totalCount type: object x-namespace: Ontologies - ListAttachmentsResponseV2: - type: object - x-namespace: Ontologies + ListOntologiesResponse: properties: data: + description: The list of Ontologies the user has access to. items: - $ref: "#/components/schemas/AttachmentV2" + $ref: "#/components/schemas/Ontology" type: array + type: object + x-namespace: Ontologies + ListOutgoingLinkTypesResponse: + properties: nextPageToken: $ref: "#/components/schemas/PageToken" - AttachmentMetadataResponse: - description: The attachment metadata response + data: + description: The list of link type sides in the current page. + items: + $ref: "#/components/schemas/LinkTypeSide" + type: array type: object x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - single: "#/components/schemas/AttachmentV2" - multiple: "#/components/schemas/ListAttachmentsResponseV2" - oneOf: - - $ref: "#/components/schemas/AttachmentV2" - - $ref: "#/components/schemas/ListAttachmentsResponseV2" - AbsoluteTimeRange: - description: ISO 8601 timestamps forming a range for a time series query. Start is inclusive and end is exclusive. - type: object + ObjectRid: + description: | + The unique resource identifier of an object, useful for interacting with other Foundry APIs. + format: rid + type: string x-namespace: Ontologies + x-safety: safe + ObjectType: + description: Represents an object type in the Ontology. properties: - startTime: - type: string - format: date-time - x-safety: unsafe - endTime: + apiName: + $ref: "#/components/schemas/ObjectTypeApiName" + displayName: + $ref: "#/components/schemas/DisplayName" + status: + $ref: "#/components/schemas/ReleaseStatus" + description: + description: The description of the object type. type: string - format: date-time x-safety: unsafe - ActionMode: - x-namespace: Ontologies - enum: - - ASYNC - - RUN - - VALIDATE - AsyncApplyActionResponseV2: - type: object - x-namespace: Ontologies - properties: - operationId: - type: string - format: rid - x-safety: safe - required: - - operationId - SyncApplyActionResponseV2: - type: object - x-namespace: Ontologies - properties: - validation: - $ref: "#/components/schemas/ValidateActionResponseV2" - edits: - $ref: "#/components/schemas/ActionResults" - ActionResults: - discriminator: - propertyName: type - mapping: - edits: "#/components/schemas/ObjectEdits" - largeScaleEdits: "#/components/schemas/ObjectTypeEdits" - oneOf: - - $ref: "#/components/schemas/ObjectEdits" - - $ref: "#/components/schemas/ObjectTypeEdits" - ObjectTypeEdits: - type: object - properties: - editedObjectTypes: - type: array + visibility: + $ref: "#/components/schemas/ObjectTypeVisibility" + primaryKey: + description: The primary key of the object. This is a list of properties that can be used to uniquely identify the object. items: - $ref: "#/components/schemas/ObjectTypeApiName" - ObjectEdits: - type: object - properties: - edits: + $ref: "#/components/schemas/PropertyApiName" type: array - items: - $ref: "#/components/schemas/ObjectEdit" - addedObjectCount: - type: integer - x-safety: safe - modifiedObjectsCount: - type: integer - x-safety: safe - deletedObjectsCount: - type: integer - x-safety: safe - addedLinksCount: - type: integer - x-safety: safe - deletedLinksCount: - type: integer - x-safety: safe + properties: + description: A map of the properties of the object type. + additionalProperties: + $ref: "#/components/schemas/Property" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + rid: + $ref: "#/components/schemas/ObjectTypeRid" required: - - addedObjectCount - - modifiedObjectsCount - - deletedObjectsCount - - addedLinksCount - - deletedLinksCount - ObjectEdit: - discriminator: - propertyName: type - mapping: - addObject: "#/components/schemas/AddObject" - modifyObject: "#/components/schemas/ModifyObject" - addLink: "#/components/schemas/AddLink" - oneOf: - - $ref: "#/components/schemas/AddObject" - - $ref: "#/components/schemas/ModifyObject" - - $ref: "#/components/schemas/AddLink" - AddObject: + - apiName + - status + - rid type: object + x-namespace: Ontologies + ObjectTypeApiName: + description: | + The name of the object type in the API in camelCase format. To find the API name for your Object Type, use the + `List object types` endpoint or check the **Ontology Manager**. + type: string + x-namespace: Ontologies + x-safety: unsafe + ObjectTypeVisibility: + enum: + - NORMAL + - PROMINENT + - HIDDEN + description: The suggested visibility of the object type. + type: string + x-namespace: Ontologies + ObjectTypeRid: + description: "The unique resource identifier of an object type, useful for interacting with other Foundry APIs." + format: rid + type: string + x-namespace: Ontologies + x-safety: safe + Ontology: + description: Metadata about an Ontology. properties: - primaryKey: - $ref: "#/components/schemas/PropertyValue" - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" + apiName: + $ref: "#/components/schemas/OntologyApiName" + displayName: + $ref: "#/components/schemas/DisplayName" + description: + type: string + x-safety: unsafe + rid: + $ref: "#/components/schemas/OntologyRid" required: - - primaryKey - - objectType - ModifyObject: + - apiName + - displayName + - description + - rid type: object + x-namespace: Ontologies + OntologyObject: + description: Represents an object in the Ontology. properties: - primaryKey: - $ref: "#/components/schemas/PropertyValue" - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" + properties: + description: A map of the property values of the object. + nullable: true + additionalProperties: + $ref: "#/components/schemas/PropertyValue" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + rid: + $ref: "#/components/schemas/ObjectRid" required: - - primaryKey - - objectType - AddLink: + - rid type: object + x-namespace: Ontologies + OntologyRid: + description: | + The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the + `List ontologies` endpoint or check the **Ontology Manager**. + format: rid + type: string + x-namespace: Ontologies + x-safety: safe + OntologyApiName: + type: string + x-namespace: Ontologies + x-safety: unsafe + OrderBy: + description: "A command representing the list of properties to order by. Properties should be delimited by commas and\nprefixed by `p` or `properties`. The format expected format is\n`orderBy=properties.{property}:{sortDirection},properties.{property}:{sortDirection}...`\n\nBy default, the ordering for a property is ascending, and this can be explicitly specified by appending \n`:asc` (for ascending) or `:desc` (for descending).\n\nExample: use `orderBy=properties.lastName:asc` to order by a single property, \n`orderBy=properties.lastName,properties.firstName,properties.age:desc` to order by multiple properties. \nYou may also use the shorthand `p` instead of `properties` such as `orderBy=p.lastName:asc`.\n" + type: string + x-namespace: Ontologies + x-safety: unsafe + Parameter: + description: Details about a parameter of an action or query. properties: - linkTypeApiNameAtoB: - $ref: "#/components/schemas/LinkTypeApiName" - linkTypeApiNameBtoA: - $ref: "#/components/schemas/LinkTypeApiName" - aSideObject: - $ref: "#/components/schemas/LinkSideObject" - bSideObject: - $ref: "#/components/schemas/LinkSideObject" + description: + type: string + x-safety: unsafe + baseType: + $ref: "#/components/schemas/ValueType" + dataType: + $ref: "#/components/schemas/OntologyDataType" + required: + type: boolean + x-safety: safe required: - - linkTypeApiNameAtoB - - linkTypeApiNameBtoA - - aSideObject - - bSideObject - LinkSideObject: + - baseType + - required type: object + x-namespace: Ontologies + ParameterId: + description: | + The unique identifier of the parameter. Parameters are used as inputs when an action or query is applied. + Parameters can be viewed and managed in the **Ontology Manager**. + type: string + x-namespace: Ontologies + x-safety: unsafe + DataValue: + x-namespace: Ontologies + description: | + Represents the value of data in the following format. Note that these values can be nested, for example an array of structs. + | Type | JSON encoding | Example | + |-----------------------------|-------------------------------------------------------|-------------------------------------------------------------------------------| + | Array | array | `["alpha", "bravo", "charlie"]` | + | Attachment | string | `"ri.attachments.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"` | + | Boolean | boolean | `true` | + | Byte | number | `31` | + | Date | ISO 8601 extended local date string | `"2021-05-01"` | + | Decimal | string | `"2.718281828"` | + | Float | number | `3.14159265` | + | Double | number | `3.14159265` | + | Integer | number | `238940` | + | Long | string | `"58319870951433"` | + | Marking | string | `"MU"` | + | Null | null | `null` | + | Object Set | string OR the object set definition | `ri.object-set.main.versioned-object-set.h13274m8-23f5-431c-8aee-a4554157c57z`| + | Ontology Object Reference | JSON encoding of the object's primary key | `10033123` or `"EMP1234"` | + | Set | array | `["alpha", "bravo", "charlie"]` | + | Short | number | `8739` | + | String | string | `"Call me Ishmael"` | + | Struct | JSON object | `{"name": "John Doe", "age": 42}` | + | TwoDimensionalAggregation | JSON object | `{"groups": [{"key": "alpha", "value": 100}, {"key": "beta", "value": 101}]}` | + | ThreeDimensionalAggregation | JSON object | `{"groups": [{"key": "NYC", "groups": [{"key": "Engineer", "value" : 100}]}]}`| + | Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | + x-safety: unsafe + PrimaryKeyValue: + description: Represents the primary key value that is used as a unique identifier for an object. + x-safety: unsafe + x-namespace: Ontologies + Property: + description: Details about some property of an object. properties: - primaryKey: - $ref: "#/components/schemas/PropertyValue" - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" + description: + type: string + x-safety: unsafe + displayName: + $ref: "#/components/schemas/DisplayName" + baseType: + $ref: "#/components/schemas/ValueType" required: - - primaryKey - - objectType - LinkTypeRid: + - baseType + type: object + x-namespace: Ontologies + PropertyApiName: + description: | + The name of the property in the API. To find the API name for your property, use the `Get object type` + endpoint or check the **Ontology Manager**. type: string - format: rid + x-namespace: Ontologies + x-safety: unsafe + FieldNameV1: + description: "A reference to an Ontology object property with the form `properties.{propertyApiName}`." + type: string + x-namespace: Ontologies + x-safety: unsafe + PropertyFilter: + description: | + Represents a filter used on properties. + + Endpoints that accept this supports optional parameters that have the form: + `properties.{propertyApiName}.{propertyFilter}={propertyValueEscapedString}` to filter the returned objects. + For instance, you may use `properties.firstName.eq=John` to find objects that contain a property called + "firstName" that has the exact value of "John". + + The following are a list of supported property filters: + + - `properties.{propertyApiName}.contains` - supported on arrays and can be used to filter array properties + that have at least one of the provided values. If multiple query parameters are provided, then objects + that have any of the given values for the specified property will be matched. + - `properties.{propertyApiName}.eq` - used to filter objects that have the exact value for the provided + property. If multiple query parameters are provided, then objects that have any of the given values + will be matched. For instance, if the user provides a request by doing + `?properties.firstName.eq=John&properties.firstName.eq=Anna`, then objects that have a firstName property + of either John or Anna will be matched. This filter is supported on all property types except Arrays. + - `properties.{propertyApiName}.neq` - used to filter objects that do not have the provided property values. + Similar to the `eq` filter, if multiple values are provided, then objects that have any of the given values + will be excluded from the result. + - `properties.{propertyApiName}.lt`, `properties.{propertyApiName}.lte`, `properties.{propertyApiName}.gt` + `properties.{propertyApiName}.gte` - represent less than, less than or equal to, greater than, and greater + than or equal to respectively. These are supported on date, timestamp, byte, integer, long, double, decimal. + - `properties.{propertyApiName}.isNull` - used to filter objects where the provided property is (or is not) null. + This filter is supported on all property types. + type: string + x-namespace: Ontologies x-safety: safe + PropertyId: + description: | + The immutable ID of a property. Property IDs are only used to identify properties in the **Ontology Manager** + application and assign them API names. In every other case, API names should be used instead of property IDs. + type: string x-namespace: Ontologies - LinkTypeSideV2: + x-safety: unsafe + SelectedPropertyApiName: + description: | + By default, anytime an object is requested, every property belonging to that object is returned. + The response can be filtered to only include certain properties using the `properties` query parameter. + + Properties to include can be specified in one of two ways. + + - A comma delimited list as the value for the `properties` query parameter + `properties={property1ApiName},{property2ApiName}` + - Multiple `properties` query parameters. + `properties={property1ApiName}&properties={property2ApiName}` + + The primary key of the object will always be returned even if it wasn't specified in the `properties` values. + + Unknown properties specified in the `properties` list will result in a `PropertiesNotFound` error. + + To find the API name for your property, use the `Get object type` endpoint or check the **Ontology Manager**. + type: string + x-namespace: Ontologies + x-safety: unsafe + PropertyValue: + description: | + Represents the value of a property in the following format. + + | Type | JSON encoding | Example | + |----------- |-------------------------------------------------------|----------------------------------------------------------------------------------------------------| + | Array | array | `["alpha", "bravo", "charlie"]` | + | Attachment | JSON encoded `AttachmentProperty` object | `{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}` | + | Boolean | boolean | `true` | + | Byte | number | `31` | + | Date | ISO 8601 extended local date string | `"2021-05-01"` | + | Decimal | string | `"2.718281828"` | + | Double | number | `3.14159265` | + | Float | number | `3.14159265` | + | GeoPoint | geojson | `{"type":"Point","coordinates":[102.0,0.5]}` | + | GeoShape | geojson | `{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` | + | Integer | number | `238940` | + | Long | string | `"58319870951433"` | + | Short | number | `8739` | + | String | string | `"Call me Ishmael"` | + | Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | + + Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings. + x-safety: unsafe + x-namespace: Ontologies + PropertyValueEscapedString: + description: Represents the value of a property in string format. This is used in URL parameters. + type: string + x-namespace: Ontologies + x-safety: unsafe + LinkTypeSide: type: object x-namespace: Ontologies properties: @@ -5503,64 +5313,114 @@ components: cardinality: $ref: "#/components/schemas/LinkTypeSideCardinality" foreignKeyPropertyApiName: - $ref: "#/components/schemas/PropertyApiName" - linkTypeRid: - $ref: "#/components/schemas/LinkTypeRid" + $ref: "#/components/schemas/PropertyApiName" required: - apiName - displayName - status - objectTypeApiName - cardinality - - linkTypeRid - ListOutgoingLinkTypesResponseV2: + LinkTypeSideCardinality: + enum: + - ONE + - MANY + x-namespace: Ontologies + AggregateObjectsRequest: + type: object + x-namespace: Ontologies + properties: + aggregation: + items: + $ref: "#/components/schemas/Aggregation" + type: array + query: + $ref: "#/components/schemas/SearchJsonQuery" + groupBy: + items: + $ref: "#/components/schemas/AggregationGroupBy" + type: array + AggregateObjectsResponse: properties: + excludedItems: + type: integer + x-safety: unsafe nextPageToken: $ref: "#/components/schemas/PageToken" data: - description: The list of link type sides in the current page. items: - $ref: "#/components/schemas/LinkTypeSideV2" + $ref: "#/components/schemas/AggregateObjectsResponseItem" type: array type: object x-namespace: Ontologies - ApplyActionRequestV2: - x-namespace: Ontologies + AggregateObjectsResponseItem: type: object + x-namespace: Ontologies properties: - options: - $ref: "#/components/schemas/ApplyActionRequestOptions" - parameters: - nullable: true + group: additionalProperties: - $ref: "#/components/schemas/DataValue" + $ref: "#/components/schemas/AggregationGroupValue" x-mapKey: - $ref: "#/components/schemas/ParameterId" - ApplyActionMode: + $ref: "#/components/schemas/AggregationGroupKey" + metrics: + items: + $ref: "#/components/schemas/AggregationMetricResult" + type: array + AggregationGroupKey: + type: string x-namespace: Ontologies - enum: - - VALIDATE_ONLY - - VALIDATE_AND_EXECUTE - ApplyActionRequestOptions: + x-safety: unsafe + AggregationGroupValue: + x-safety: unsafe + x-namespace: Ontologies + AggregationMetricResult: type: object x-namespace: Ontologies properties: - mode: - $ref: "#/components/schemas/ApplyActionMode" - returnEdits: - $ref: "#/components/schemas/ReturnEditsMode" - BatchApplyActionRequestOptions: + name: + type: string + x-safety: unsafe + value: + type: number + format: double + description: TBD + x-safety: unsafe + required: + - name + SearchObjectsRequest: + properties: + query: + $ref: "#/components/schemas/SearchJsonQuery" + orderBy: + $ref: "#/components/schemas/SearchOrderBy" + pageSize: + $ref: "#/components/schemas/PageSize" + pageToken: + $ref: "#/components/schemas/PageToken" + fields: + description: | + The API names of the object type properties to include in the response. + type: array + items: + $ref: "#/components/schemas/PropertyApiName" + required: + - query type: object x-namespace: Ontologies + SearchObjectsResponse: properties: - returnEdits: - $ref: "#/components/schemas/ReturnEditsMode" - ReturnEditsMode: + data: + items: + $ref: "#/components/schemas/OntologyObject" + type: array + nextPageToken: + $ref: "#/components/schemas/PageToken" + totalCount: + $ref: "#/components/schemas/TotalCount" + required: + - totalCount + type: object x-namespace: Ontologies - enum: - - ALL - - NONE - AsyncApplyActionRequestV2: + ValidateActionRequest: properties: parameters: nullable: true @@ -5570,769 +5430,1048 @@ components: $ref: "#/components/schemas/ParameterId" type: object x-namespace: Ontologies - AsyncApplyActionOperationResponseV2: + ValidateActionResponse: type: object x-namespace: Ontologies - AsyncApplyActionOperationV2: - x-type: - type: asyncOperation - operationType: applyActionAsyncV2 - resultType: AsyncApplyActionOperationResponseV2 - stageType: AsyncActionStatus - x-namespace: Ontologies - AttachmentV2: + properties: + result: + $ref: "#/components/schemas/ValidationResult" + submissionCriteria: + items: + $ref: "#/components/schemas/SubmissionCriteriaEvaluation" + type: array + parameters: + additionalProperties: + $ref: "#/components/schemas/ParameterEvaluationResult" + x-mapKey: + $ref: "#/components/schemas/ParameterId" + required: + - result + SubmissionCriteriaEvaluation: + description: | + Contains the status of the **submission criteria**. + **Submission criteria** are the prerequisites that need to be satisfied before an Action can be applied. + These are configured in the **Ontology Manager**. type: object x-namespace: Ontologies - description: The representation of an attachment. properties: - rid: - $ref: "#/components/schemas/AttachmentRid" - filename: - $ref: "#/components/schemas/Filename" - sizeBytes: - $ref: "#/components/schemas/SizeBytes" - mediaType: - $ref: "#/components/schemas/MediaType" - required: - - rid - - filename - - sizeBytes - - mediaType - ListLinkedObjectsResponseV2: - type: object + configuredFailureMessage: + description: | + The message indicating one of the **submission criteria** was not satisfied. + This is configured per **submission criteria** in the **Ontology Manager**. + type: string + x-safety: unsafe + result: + $ref: "#/components/schemas/ValidationResult" + required: + - result + ValidationResult: + description: | + Represents the state of a validation. + enum: + - VALID + - INVALID + type: string + x-namespace: Ontologies + ActionEditedPropertiesNotFound: + description: | + Actions attempted to edit properties that could not be found on the object type. + Please contact the Ontology administrator to resolve this issue. + properties: + parameters: + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + ObjectAlreadyExists: + description: | + The object the user is attempting to create already exists. + properties: + parameters: + type: object + errorCode: + enum: + - CONFLICT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + LinkAlreadyExists: + description: | + The link the user is attempting to create already exists. + properties: + parameters: + type: object + errorCode: + enum: + - CONFLICT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + FunctionExecutionFailed: + x-type: error + x-namespace: Ontologies + properties: + parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + required: + - functionRid + - functionVersion + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + ParentAttachmentPermissionDenied: + description: | + The user does not have permission to parent attachments. + properties: + parameters: + type: object + errorCode: + enum: + - PERMISSION_DENIED + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + EditObjectPermissionDenied: + description: | + The user does not have permission to edit this `ObjectType`. + properties: + parameters: + type: object + errorCode: + enum: + - PERMISSION_DENIED + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + ViewObjectPermissionDenied: + description: | + The provided token does not have permission to view any data sources backing this object type. Ensure the object + type has backing data sources configured and visible. + properties: + parameters: + type: object + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - objectType + errorCode: + enum: + - PERMISSION_DENIED + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ObjectChanged: + description: | + An object used by this `Action` was changed by someone else while the `Action` was running. properties: - data: - items: - $ref: "#/components/schemas/OntologyObjectV2" - type: array - nextPageToken: - $ref: "#/components/schemas/PageToken" - ListObjectsResponseV2: - type: object + parameters: + type: object + errorCode: + enum: + - CONFLICT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ActionParameterObjectTypeNotFound: + description: | + The parameter references an object type that could not be found, or the client token does not have access to it. properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - type: array - description: The list of objects in the current page. - items: - $ref: "#/components/schemas/OntologyObjectV2" - totalCount: - $ref: "#/components/schemas/TotalCount" - required: - - totalCount - CountObjectsResponseV2: - type: object + parameters: + type: object + properties: + parameterId: + $ref: "#/components/schemas/ParameterId" + required: + - parameterId + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ActionParameterObjectNotFound: + description: | + The parameter object reference or parameter default value is not found, or the client token does not have access to it. properties: - count: - type: integer - x-safety: unsafe - LoadObjectSetResponseV2: - description: Represents the API response when loading an `ObjectSet`. - type: object + parameters: + type: object + properties: + parameterId: + $ref: "#/components/schemas/ParameterId" + required: + - parameterId + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ActionNotFound: + description: "The action is not found, or the user does not have access to it." properties: - data: - type: array - description: The list of objects in the current Page. - items: - $ref: "#/components/schemas/OntologyObjectV2" - nextPageToken: - $ref: "#/components/schemas/PageToken" - totalCount: - $ref: "#/components/schemas/TotalCount" - required: - - totalCount - LoadObjectSetRequestV2: - description: Represents the API POST body when loading an `ObjectSet`. - type: object + parameters: + properties: + actionRid: + $ref: "#/components/schemas/ActionRid" + required: + - actionRid + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ActionTypeNotFound: + description: "The action type is not found, or the user does not have access to it." properties: - objectSet: - $ref: "#/components/schemas/ObjectSet" - orderBy: - $ref: "#/components/schemas/SearchOrderByV2" - select: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - pageToken: - $ref: "#/components/schemas/PageToken" - pageSize: - $ref: "#/components/schemas/PageSize" - excludeRid: - description: | - A flag to exclude the retrieval of the `__rid` property. - Setting this to true may improve performance of this endpoint for object types in OSV2. - type: boolean - x-safety: safe - required: - - objectSet - ObjectSet: - description: Represents the definition of an `ObjectSet` in the `Ontology`. - type: object - x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - base: "#/components/schemas/ObjectSetBaseType" - static: "#/components/schemas/ObjectSetStaticType" - reference: "#/components/schemas/ObjectSetReferenceType" - filter: "#/components/schemas/ObjectSetFilterType" - union: "#/components/schemas/ObjectSetUnionType" - intersect: "#/components/schemas/ObjectSetIntersectionType" - subtract: "#/components/schemas/ObjectSetSubtractType" - searchAround: "#/components/schemas/ObjectSetSearchAroundType" - oneOf: - - $ref: "#/components/schemas/ObjectSetBaseType" - - $ref: "#/components/schemas/ObjectSetStaticType" - - $ref: "#/components/schemas/ObjectSetReferenceType" - - $ref: "#/components/schemas/ObjectSetFilterType" - - $ref: "#/components/schemas/ObjectSetUnionType" - - $ref: "#/components/schemas/ObjectSetIntersectionType" - - $ref: "#/components/schemas/ObjectSetSubtractType" - - $ref: "#/components/schemas/ObjectSetSearchAroundType" - ObjectSetBaseType: - type: object + parameters: + properties: + actionType: + $ref: "#/components/schemas/ActionTypeApiName" + rid: + $ref: "#/components/schemas/ActionTypeRid" + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ActionValidationFailed: + description: | + The validation failed for the given action parameters. Please use the `validateAction` endpoint for more + details. properties: - objectType: + parameters: + properties: + actionType: + $ref: "#/components/schemas/ActionTypeApiName" + required: + - actionType + type: object + errorCode: + enum: + - INVALID_ARGUMENT type: string - x-safety: unsafe - required: - - objectType - ObjectSetStaticType: - type: object + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ApplyActionFailed: properties: - objects: - type: array - items: - $ref: "#/components/schemas/ObjectRid" - ObjectSetReferenceType: - type: object + parameters: + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + AttachmentNotFound: + description: "The requested attachment is not found, or the client token does not have access to it. \nAttachments that are not attached to any objects are deleted after two weeks.\nAttachments that have not been attached to an object can only be viewed by the user who uploaded them.\nAttachments that have been attached to an object can be viewed by users who can view the object.\n" properties: - reference: + parameters: + type: object + properties: + attachmentRid: + $ref: "#/components/schemas/AttachmentRid" + errorCode: + enum: + - NOT_FOUND type: string - format: rid - x-safety: safe - required: - - reference - ObjectSetFilterType: - type: object + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + AttachmentSizeExceededLimit: + description: | + The file is too large to be uploaded as an attachment. + The maximum attachment size is 200MB. properties: - objectSet: - $ref: "#/components/schemas/ObjectSet" - where: - $ref: "#/components/schemas/SearchJsonQueryV2" - required: - - objectSet - - where - ObjectSetUnionType: - type: object + parameters: + type: object + properties: + fileSizeBytes: + type: string + x-safety: unsafe + fileLimitBytes: + type: string + x-safety: safe + required: + - fileSizeBytes + - fileLimitBytes + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + DuplicateOrderBy: + description: The requested sort order includes duplicate properties. properties: - objectSets: - type: array - items: - $ref: "#/components/schemas/ObjectSet" - ObjectSetIntersectionType: - type: object + parameters: + properties: + properties: + type: array + items: + $ref: "#/components/schemas/PropertyApiName" + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - properties: - objectSets: - type: array - items: - $ref: "#/components/schemas/ObjectSet" - ObjectSetSubtractType: - type: object + FunctionInvalidInput: + x-type: error x-namespace: Ontologies properties: - objectSets: - type: array - items: - $ref: "#/components/schemas/ObjectSet" - ObjectSetSearchAroundType: - type: object + parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + required: + - functionRid + - functionVersion + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + FunctionExecutionTimedOut: + x-type: error x-namespace: Ontologies properties: - objectSet: - $ref: "#/components/schemas/ObjectSet" - link: - $ref: "#/components/schemas/LinkTypeApiName" - required: - - objectSet - - link - OntologyV2: - $ref: "#/components/schemas/Ontology" - OntologyFullMetadata: + parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + required: + - functionRid + - functionVersion + type: object + errorCode: + enum: + - TIMEOUT + type: string + errorName: + type: string + errorInstanceId: + type: string + CompositePrimaryKeyNotSupported: + description: | + Primary keys consisting of multiple properties are not supported by this API. If you need support for this, + please reach out to Palantir Support. properties: - ontology: - $ref: "#/components/schemas/OntologyV2" - objectTypes: - additionalProperties: - $ref: "#/components/schemas/ObjectTypeFullMetadata" - x-mapKey: - $ref: "#/components/schemas/ObjectTypeApiName" - actionTypes: - additionalProperties: - $ref: "#/components/schemas/ActionTypeV2" - x-mapKey: - $ref: "#/components/schemas/ActionTypeApiName" - queryTypes: - additionalProperties: - $ref: "#/components/schemas/QueryTypeV2" - x-mapKey: - $ref: "#/components/schemas/QueryApiName" - interfaceTypes: - additionalProperties: - $ref: "#/components/schemas/InterfaceType" - x-mapKey: - $ref: "#/components/schemas/InterfaceTypeApiName" - sharedPropertyTypes: - additionalProperties: - $ref: "#/components/schemas/SharedPropertyType" - x-mapKey: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - type: object - x-namespace: Ontologies - required: - - ontology - OntologyObjectV2: - description: Represents an object in the Ontology. - additionalProperties: - $ref: "#/components/schemas/PropertyValue" - x-mapKey: - $ref: "#/components/schemas/PropertyApiName" - x-namespace: Ontologies - OntologyIdentifier: - description: Either an ontology rid or an ontology api name. - type: string - x-safety: unsafe + parameters: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + primaryKey: + items: + $ref: "#/components/schemas/PropertyApiName" + type: array + required: + - objectType + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - QueryTypeV2: - description: Represents a query type in the Ontology. + InvalidContentLength: + description: "A `Content-Length` header is required for all uploads, but was missing or invalid." properties: - apiName: - $ref: "#/components/schemas/QueryApiName" - description: - type: string - x-safety: unsafe - displayName: - $ref: "#/components/schemas/DisplayName" parameters: - additionalProperties: - $ref: "#/components/schemas/QueryParameterV2" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - output: - $ref: "#/components/schemas/QueryDataType" - rid: - $ref: "#/components/schemas/FunctionRid" - version: - $ref: "#/components/schemas/FunctionVersion" - required: - - apiName - - rid - - version - - output - type: object + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - QueryParameterV2: - type: object - description: Details about a parameter of a query. + InvalidContentType: + description: | + The `Content-Type` cannot be inferred from the request content and filename. + Please check your request content and filename to ensure they are compatible. properties: - description: + parameters: + type: object + errorCode: + enum: + - INVALID_ARGUMENT type: string - x-safety: unsafe - dataType: - $ref: "#/components/schemas/QueryDataType" - required: - - dataType - QueryOutputV2: - type: object - description: Details about the output of a query. - properties: - dataType: - $ref: "#/components/schemas/QueryDataType" - required: - type: boolean - x-safety: safe - required: - - dataType - - required - RelativeTimeSeriesTimeUnit: - enum: - - MILLISECONDS - - SECONDS - - MINUTES - - HOURS - - DAYS - - WEEKS - - MONTHS - - YEARS - RelativeTime: - description: | - A relative time, such as "3 days before" or "2 hours after" the current moment. - type: object + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - properties: - when: - $ref: "#/components/schemas/RelativeTimeRelation" - value: - type: integer - x-safety: unsafe - unit: - $ref: "#/components/schemas/RelativeTimeSeriesTimeUnit" - required: - - when - - value - - unit - RelativeTimeRelation: - enum: - - BEFORE - - AFTER - RelativeTimeRange: + FunctionEncounteredUserFacingError: description: | - A relative time range for a time series query. - type: object + The authored function failed to execute because of a user induced error. The message argument + is meant to be displayed to the user. + properties: + parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + message: + type: string + x-safety: unsafe + required: + - functionRid + - functionVersion + - message + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidGroupId: + description: The provided value for a group id must be a UUID. properties: - startTime: - $ref: "#/components/schemas/RelativeTime" - endTime: - $ref: "#/components/schemas/RelativeTime" - SearchObjectsRequestV2: - type: object + parameters: + properties: + groupId: + type: string + x-safety: unsafe + required: + - groupId + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidUserId: + description: The provided value for a user id must be a UUID. properties: - where: - $ref: "#/components/schemas/SearchJsonQueryV2" - orderBy: - $ref: "#/components/schemas/SearchOrderByV2" - pageSize: - $ref: "#/components/schemas/PageSize" - pageToken: - $ref: "#/components/schemas/PageToken" - select: - description: | - The API names of the object type properties to include in the response. - type: array - items: - $ref: "#/components/schemas/PropertyApiName" - excludeRid: - description: | - A flag to exclude the retrieval of the `__rid` property. - Setting this to true may improve performance of this endpoint for object types in OSV2. - type: boolean - x-safety: safe - SearchObjectsResponseV2: - type: object + parameters: + properties: + userId: + type: string + x-safety: unsafe + required: + - userId + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + AggregationGroupCountExceededLimit: + description: | + The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by + adjusting your query to reduce the number of groups created by your aggregation. For instance: + - If you are using multiple `groupBy` clauses, try reducing the number of clauses. + - If you are using a `groupBy` clause with a high cardinality property, try filtering the data first + to reduce the number of groups. properties: - data: - items: - $ref: "#/components/schemas/OntologyObjectV2" - type: array - nextPageToken: - $ref: "#/components/schemas/PageToken" - totalCount: - $ref: "#/components/schemas/TotalCount" - required: - - totalCount - StreamTimeSeriesPointsRequest: - type: object + parameters: + properties: + groupsCount: + type: integer + x-safety: safe + groupsLimit: + type: integer + x-safety: safe + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + AggregationMemoryExceededLimit: + description: | + The amount of memory used in the request exceeded the limit. The number of groups in the aggregations grouping exceeded the allowed limit. This can typically be fixed by + adjusting your query to reduce the number of groups created by your aggregation. For instance: + - If you are using multiple `groupBy` clauses, try reducing the number of clauses. + - If you are using a `groupBy` clause with a high cardinality property, try filtering the data first + to reduce the number of groups. properties: - range: - $ref: "#/components/schemas/TimeRange" - StreamTimeSeriesPointsResponse: - type: object + parameters: + properties: + memoryUsedBytes: + type: string + x-safety: safe + memoryLimitBytes: + type: string + x-safety: safe + type: object + required: + - memoryUsedBytes + - memoryLimitBytes + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidParameterValue: + description: | + The value of the given parameter is invalid. See the documentation of `DataValue` for details on + how parameters are represented. properties: - data: - items: - $ref: "#/components/schemas/TimeSeriesPoint" - type: array - TimeRange: - description: An absolute or relative range for a time series query. - type: object + parameters: + properties: + parameterBaseType: + $ref: "#/components/schemas/ValueType" + parameterDataType: + $ref: "#/components/schemas/OntologyDataType" + parameterId: + $ref: "#/components/schemas/ParameterId" + parameterValue: + $ref: "#/components/schemas/DataValue" + required: + - parameterId + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - absolute: "#/components/schemas/AbsoluteTimeRange" - relative: "#/components/schemas/RelativeTimeRange" - oneOf: - - $ref: "#/components/schemas/AbsoluteTimeRange" - - $ref: "#/components/schemas/RelativeTimeRange" - TimeSeriesPoint: + InvalidQueryParameterValue: description: | - A time and value pair. - type: object + The value of the given parameter is invalid. See the documentation of `DataValue` for details on + how parameters are represented. properties: - time: - description: An ISO 8601 timestamp + parameters: + properties: + parameterDataType: + $ref: "#/components/schemas/QueryDataType" + parameterId: + $ref: "#/components/schemas/ParameterId" + parameterValue: + $ref: "#/components/schemas/DataValue" + required: + - parameterId + - parameterDataType + type: object + errorCode: + enum: + - INVALID_ARGUMENT type: string - format: date-time - x-safety: unsafe - value: - description: An object which is either an enum String or a double number. - x-safety: unsafe - required: - - time - - value - ValidateActionResponseV2: - type: object + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + InvalidFields: + description: | + The value of the given field does not match the expected pattern. For example, an Ontology object property `id` + should be written `properties.id`. properties: - result: - $ref: "#/components/schemas/ValidationResult" - submissionCriteria: - items: - $ref: "#/components/schemas/SubmissionCriteriaEvaluation" - type: array parameters: - additionalProperties: - $ref: "#/components/schemas/ParameterEvaluationResult" - x-mapKey: - $ref: "#/components/schemas/ParameterId" - required: - - result - PropertyV2: - description: Details about some property of an object. + properties: + properties: + items: + type: string + x-safety: unsafe + type: array + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + InvalidPropertyFilterValue: + description: | + The value of the given property filter is invalid. For instance, 2 is an invalid value for + `isNull` in `properties.address.isNull=2` because the `isNull` filter expects a value of boolean type. properties: - description: + parameters: + properties: + expectedType: + $ref: "#/components/schemas/ValueType" + propertyFilter: + $ref: "#/components/schemas/PropertyFilter" + propertyFilterValue: + $ref: "#/components/schemas/FilterValue" + property: + $ref: "#/components/schemas/PropertyApiName" + required: + - expectedType + - property + - propertyFilter + - propertyFilterValue + type: object + errorCode: + enum: + - INVALID_ARGUMENT type: string - x-safety: unsafe - displayName: - $ref: "#/components/schemas/DisplayName" - dataType: - $ref: "#/components/schemas/ObjectPropertyType" - required: - - dataType - type: object + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - OntologyObjectArrayType: - type: object + InvalidPropertyFiltersCombination: + description: The provided filters cannot be used together. properties: - subType: - $ref: "#/components/schemas/ObjectPropertyType" - required: - - subType - ObjectPropertyType: + parameters: + properties: + propertyFilters: + items: + $ref: "#/components/schemas/PropertyFilter" + type: array + property: + $ref: "#/components/schemas/PropertyApiName" + required: + - property + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + InvalidPropertyValue: description: | - A union of all the types supported by Ontology Object properties. - discriminator: - propertyName: type - mapping: - array: "#/components/schemas/OntologyObjectArrayType" - attachment: "#/components/schemas/AttachmentType" - boolean: "#/components/schemas/BooleanType" - byte: "#/components/schemas/ByteType" - date: "#/components/schemas/DateType" - decimal: "#/components/schemas/DecimalType" - double: "#/components/schemas/DoubleType" - float: "#/components/schemas/FloatType" - geopoint: "#/components/schemas/GeoPointType" - geoshape: "#/components/schemas/GeoShapeType" - integer: "#/components/schemas/IntegerType" - long: "#/components/schemas/LongType" - marking: "#/components/schemas/MarkingType" - short: "#/components/schemas/ShortType" - string: "#/components/schemas/StringType" - timestamp: "#/components/schemas/TimestampType" - timeseries: "#/components/schemas/TimeseriesType" - oneOf: - - $ref: "#/components/schemas/OntologyObjectArrayType" - - $ref: "#/components/schemas/AttachmentType" - - $ref: "#/components/schemas/BooleanType" - - $ref: "#/components/schemas/ByteType" - - $ref: "#/components/schemas/DateType" - - $ref: "#/components/schemas/DecimalType" - - $ref: "#/components/schemas/DoubleType" - - $ref: "#/components/schemas/FloatType" - - $ref: "#/components/schemas/GeoPointType" - - $ref: "#/components/schemas/GeoShapeType" - - $ref: "#/components/schemas/IntegerType" - - $ref: "#/components/schemas/LongType" - - $ref: "#/components/schemas/MarkingType" - - $ref: "#/components/schemas/ShortType" - - $ref: "#/components/schemas/StringType" - - $ref: "#/components/schemas/TimestampType" - - $ref: "#/components/schemas/TimeseriesType" - BlueprintIcon: - type: object + The value of the given property is invalid. See the documentation of `PropertyValue` for details on + how properties are represented. properties: - color: - description: A hexadecimal color code. + parameters: + properties: + propertyBaseType: + $ref: "#/components/schemas/ValueType" + property: + $ref: "#/components/schemas/PropertyApiName" + propertyValue: + $ref: "#/components/schemas/PropertyValue" + required: + - property + - propertyBaseType + - propertyValue + type: object + errorCode: + enum: + - INVALID_ARGUMENT type: string - x-safety: safe - name: - description: "The [name](https://blueprintjs.com/docs/#icons/icons-list) of the Blueprint icon. \nUsed to specify the Blueprint icon to represent the object type in a React app.\n" + errorName: type: string - x-safety: unsafe - required: - - color - - name - Icon: - description: A union currently only consisting of the BlueprintIcon (more icon types may be added in the future). - discriminator: - propertyName: type - mapping: - blueprint: "#/components/schemas/BlueprintIcon" - oneOf: - - $ref: "#/components/schemas/BlueprintIcon" - ObjectTypeV2: - description: Represents an object type in the Ontology. + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + InvalidPropertyType: + description: | + The given property type is not of the expected type. properties: - apiName: - $ref: "#/components/schemas/ObjectTypeApiName" - displayName: - $ref: "#/components/schemas/DisplayName" - status: - $ref: "#/components/schemas/ReleaseStatus" - description: - description: The description of the object type. + parameters: + properties: + propertyBaseType: + $ref: "#/components/schemas/ValueType" + property: + $ref: "#/components/schemas/PropertyApiName" + required: + - property + - propertyBaseType + type: object + errorCode: + enum: + - INVALID_ARGUMENT type: string - x-safety: unsafe - pluralDisplayName: - description: The plural display name of the object type. + errorName: type: string - x-safety: unsafe - icon: - $ref: "#/components/schemas/Icon" - primaryKey: - $ref: "#/components/schemas/PropertyApiName" - properties: - description: A map of the properties of the object type. - additionalProperties: - $ref: "#/components/schemas/PropertyV2" - x-mapKey: - $ref: "#/components/schemas/PropertyApiName" - rid: - $ref: "#/components/schemas/ObjectTypeRid" - titleProperty: - $ref: "#/components/schemas/PropertyApiName" - visibility: - $ref: "#/components/schemas/ObjectTypeVisibility" - required: - - apiName - - status - - rid - - primaryKey - - titleProperty - - displayName - - pluralDisplayName - - icon - type: object + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ListObjectTypesV2Response: + InvalidSortOrder: + description: | + The requested sort order of one or more properties is invalid. Valid sort orders are 'asc' or 'desc'. Sort + order can also be omitted, and defaults to 'asc'. properties: - nextPageToken: - $ref: "#/components/schemas/PageToken" - data: - description: The list of object types in the current page. - items: - $ref: "#/components/schemas/ObjectTypeV2" - type: array - type: object + parameters: + properties: + invalidSortOrder: + type: string + x-safety: unsafe + required: + - invalidSortOrder + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ListOntologiesV2Response: + InvalidSortType: + description: The requested sort type of one or more clauses is invalid. Valid sort types are 'p' or 'properties'. properties: - data: - description: The list of Ontologies the user has access to. - items: - $ref: "#/components/schemas/OntologyV2" - type: array - type: object + parameters: + properties: + invalidSortType: + type: string + x-safety: safe + required: + - invalidSortType + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ObjectTypeInterfaceImplementation: + LinkTypeNotFound: + description: "The link type is not found, or the user does not have access to it." properties: - properties: - additionalProperties: - $ref: "#/components/schemas/PropertyApiName" - x-mapKey: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - type: object + parameters: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + linkType: + $ref: "#/components/schemas/LinkTypeApiName" + required: + - linkType + - objectType + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - ObjectTypeFullMetadata: + LinkedObjectNotFound: + description: "The linked object with the given primary key is not found, or the user does not have access to it." properties: - objectType: - $ref: "#/components/schemas/ObjectTypeV2" - linkTypes: - type: array - items: - $ref: "#/components/schemas/LinkTypeSideV2" - implementsInterfaces: - description: A list of interfaces that this object type implements. - type: array - items: - $ref: "#/components/schemas/InterfaceTypeApiName" - implementsInterfaces2: - description: A list of interfaces that this object type implements and how it implements them. - additionalProperties: - $ref: "#/components/schemas/ObjectTypeInterfaceImplementation" - x-mapKey: - $ref: "#/components/schemas/InterfaceTypeApiName" - x-safety: unsafe - sharedPropertyTypeMapping: - description: "A map from shared property type API name to backing local property API name for the shared property types \npresent on this object type.\n" - additionalProperties: - $ref: "#/components/schemas/PropertyApiName" - x-mapKey: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - type: object + parameters: + properties: + linkType: + $ref: "#/components/schemas/LinkTypeApiName" + linkedObjectType: + $ref: "#/components/schemas/ObjectTypeApiName" + linkedObjectPrimaryKey: + additionalProperties: + $ref: "#/components/schemas/PrimaryKeyValue" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + required: + - linkType + - linkedObjectType + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - required: - - objectType - InterfaceTypeApiName: + MalformedPropertyFilters: description: | - The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface - type, use the `List interface types` endpoint or check the **Ontology Manager**. - type: string - x-namespace: Ontologies - x-safety: unsafe - InterfaceTypeRid: - description: "The unique resource identifier of an interface, useful for interacting with other Foundry APIs." - format: rid - type: string + At least one of requested filters are malformed. Please look at the documentation of `PropertyFilter`. + properties: + parameters: + properties: + malformedPropertyFilter: + type: string + x-safety: unsafe + required: + - malformedPropertyFilter + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - x-safety: safe - InterfaceLinkTypeRid: + MissingParameter: description: | - The unique resource identifier of an interface link type, useful for interacting with other Foundry APIs. - format: rid - type: string + Required parameters are missing. Please look at the `parameters` field to see which required parameters are + missing from the request. + properties: + parameters: + properties: + parameters: + items: + $ref: "#/components/schemas/ParameterId" + type: array + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - x-safety: safe - InterfaceLinkTypeApiName: - description: A string indicating the API name to use for the interface link. - type: string + MultiplePropertyValuesNotSupported: + description: | + One of the requested property filters does not support multiple values. Please include only a single value for + it. + properties: + parameters: + properties: + propertyFilter: + $ref: "#/components/schemas/PropertyFilter" + property: + $ref: "#/components/schemas/PropertyApiName" + required: + - property + - propertyFilter + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - x-safety: unsafe - LinkedInterfaceTypeApiName: - description: A reference to the linked interface type. - type: object + ObjectNotFound: + description: "The requested object is not found, or the client token does not have access to it." properties: - apiName: - $ref: "#/components/schemas/InterfaceTypeApiName" - required: - - apiName - LinkedObjectTypeApiName: - description: A reference to the linked object type. - type: object + parameters: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + primaryKey: + additionalProperties: + $ref: "#/components/schemas/PrimaryKeyValue" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + ObjectTypeNotFound: + description: "The requested object type is not found, or the client token does not have access to it." properties: - apiName: - $ref: "#/components/schemas/ObjectTypeApiName" - required: - - apiName - InterfaceLinkTypeLinkedEntityApiName: - description: A reference to the linked entity. This can either be an object or an interface type. - discriminator: - propertyName: type - mapping: - interfaceTypeApiName: "#/components/schemas/LinkedInterfaceTypeApiName" - objectTypeApiName: "#/components/schemas/LinkedObjectTypeApiName" - oneOf: - - $ref: "#/components/schemas/LinkedInterfaceTypeApiName" - - $ref: "#/components/schemas/LinkedObjectTypeApiName" - InterfaceLinkTypeCardinality: - description: | - The cardinality of the link in the given direction. Cardinality can be "ONE", meaning an object can - link to zero or one other objects, or "MANY", meaning an object can link to any number of other objects. - enum: - - ONE - - MANY - InterfaceLinkType: - description: | - A link type constraint defined at the interface level where the implementation of the links is provided - by the implementing object types. - type: object + parameters: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + objectTypeRid: + $ref: "#/components/schemas/ObjectTypeRid" + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + UnsupportedObjectSet: + description: The requested object set is not supported. properties: - rid: - $ref: "#/components/schemas/InterfaceLinkTypeRid" - apiName: - $ref: "#/components/schemas/InterfaceLinkTypeApiName" - displayName: - $ref: "#/components/schemas/DisplayName" - description: - description: The description of the interface link type. + parameters: + type: object + errorCode: + enum: + - INVALID_ARGUMENT type: string - x-safety: unsafe - linkedEntityApiName: - $ref: "#/components/schemas/InterfaceLinkTypeLinkedEntityApiName" - cardinality: - $ref: "#/components/schemas/InterfaceLinkTypeCardinality" - required: - description: | - Whether each implementing object type must declare at least one implementation of this link. - type: boolean - x-safety: safe - required: - - rid - - apiName - - displayName - - linkedEntityApiName - - cardinality - - required - InterfaceType: - type: object + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - description: Represents an interface type in the Ontology. + ObjectsExceededLimit: + description: | + There are more objects, but they cannot be returned by this API. Only 10,000 objects are available through this + API for a given request. properties: - rid: - $ref: "#/components/schemas/InterfaceTypeRid" - apiName: - $ref: "#/components/schemas/InterfaceTypeApiName" - displayName: - $ref: "#/components/schemas/DisplayName" - description: - description: The description of the interface. + parameters: + type: object + errorCode: + enum: + - INVALID_ARGUMENT type: string - x-safety: unsafe - properties: - description: "A map from a shared property type API name to the corresponding shared property type. The map describes the \nset of properties the interface has. A shared property type must be unique across all of the properties.\n" - additionalProperties: - $ref: "#/components/schemas/SharedPropertyType" - x-mapKey: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - extendsInterfaces: - description: "A list of interface API names that this interface extends. An interface can extend other interfaces to \ninherit their properties.\n" - type: array - items: - $ref: "#/components/schemas/InterfaceTypeApiName" - links: - description: | - A map from an interface link type API name to the corresponding interface link type. The map describes the - set of link types the interface has. - additionalProperties: - $ref: "#/components/schemas/InterfaceLinkType" - x-mapKey: - $ref: "#/components/schemas/InterfaceLinkTypeApiName" - required: - - rid - - apiName - - displayName - InterfaceTypeNotFound: - description: "The requested interface type is not found, or the client token does not have access to it." + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + OntologyEditsExceededLimit: + description: | + The number of edits to the Ontology exceeded the allowed limit. + This may happen because of the request or because the Action is modifying too many objects. + Please change the size of your request or contact the Ontology administrator. properties: parameters: properties: - apiName: - $ref: "#/components/schemas/InterfaceTypeApiName" - rid: - $ref: "#/components/schemas/InterfaceTypeRid" + editsCount: + type: integer + x-safety: unsafe + editsLimit: + type: integer + x-safety: unsafe + required: + - editsCount + - editsLimit type: object errorCode: enum: - - NOT_FOUND + - INVALID_ARGUMENT type: string errorName: type: string @@ -6340,15 +6479,15 @@ components: type: string x-type: error x-namespace: Ontologies - SharedPropertyTypeNotFound: - description: "The requested shared property type is not found, or the client token does not have access to it." + OntologyNotFound: + description: "The requested Ontology is not found, or the client token does not have access to it." properties: parameters: properties: + ontologyRid: + $ref: "#/components/schemas/OntologyRid" apiName: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - rid: - $ref: "#/components/schemas/SharedPropertyTypeRid" + $ref: "#/components/schemas/OntologyApiName" type: object errorCode: enum: @@ -6360,20 +6499,43 @@ components: type: string x-type: error x-namespace: Ontologies - PropertiesHaveDifferentIds: + OntologySyncing: description: | - Properties used in ordering must have the same ids. Temporary restriction imposed due to OSS limitations. + The requested object type has been changed in the **Ontology Manager** and changes are currently being applied. Wait a + few seconds and try again. properties: parameters: properties: - properties: - items: - $ref: "#/components/schemas/SharedPropertyTypeApiName" + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - objectType + type: object + errorCode: + enum: + - CONFLICT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + OntologySyncingObjectTypes: + description: | + One or more requested object types have been changed in the **Ontology Manager** and changes are currently being + applied. Wait a few seconds and try again. + properties: + parameters: + properties: + objectTypes: type: array + items: + $ref: "#/components/schemas/ObjectTypeApiName" type: object errorCode: enum: - - INVALID_ARGUMENT + - CONFLICT type: string errorName: type: string @@ -6381,23 +6543,43 @@ components: type: string x-type: error x-namespace: Ontologies - SharedPropertiesNotFound: - description: The requested shared property types are not present on every object type. + ObjectTypeNotSynced: + description: | + The requested object type is not synced into the ontology. Please reach out to your Ontology + Administrator to re-index the object type in Ontology Management Application. + properties: + parameters: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + required: + - objectType + type: object + errorCode: + enum: + - CONFLICT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + ObjectTypesNotSynced: + description: | + One or more of the requested object types are not synced into the ontology. Please reach out to your Ontology + Administrator to re-index the object type(s) in Ontology Management Application. properties: parameters: properties: - objectType: + objectTypes: type: array items: $ref: "#/components/schemas/ObjectTypeApiName" - missingSharedProperties: - type: array - items: - $ref: "#/components/schemas/SharedPropertyTypeApiName" type: object errorCode: enum: - - NOT_FOUND + - CONFLICT type: string errorName: type: string @@ -6405,658 +6587,687 @@ components: type: string x-type: error x-namespace: Ontologies - SharedPropertyTypeApiName: - description: | - The name of the shared property type in the API in lowerCamelCase format. To find the API name for your - shared property type, use the `List shared property types` endpoint or check the **Ontology Manager**. - type: string - x-namespace: Ontologies - x-safety: unsafe - SharedPropertyTypeRid: + ParameterTypeNotSupported: description: | - The unique resource identifier of an shared property type, useful for interacting with other Foundry APIs. - format: rid - type: string - x-namespace: Ontologies - x-safety: safe - SharedPropertyType: - type: object - x-namespace: Ontologies - description: A property type that can be shared across object types. + The type of the requested parameter is not currently supported by this API. If you need support for this, + please reach out to Palantir Support. properties: - rid: - $ref: "#/components/schemas/SharedPropertyTypeRid" - apiName: - $ref: "#/components/schemas/SharedPropertyTypeApiName" - displayName: - $ref: "#/components/schemas/DisplayName" - description: + parameters: + properties: + parameterId: + $ref: "#/components/schemas/ParameterId" + parameterBaseType: + $ref: "#/components/schemas/ValueType" + required: + - parameterBaseType + - parameterId + type: object + errorCode: + enum: + - INVALID_ARGUMENT type: string - description: A short text that describes the SharedPropertyType. - x-safety: unsafe - dataType: - $ref: "#/components/schemas/ObjectPropertyType" - required: - - rid - - apiName - - displayName - - dataType - AggregateObjectsRequestV2: - type: object - x-namespace: Ontologies - properties: - aggregation: - items: - $ref: "#/components/schemas/AggregationV2" - type: array - where: - $ref: "#/components/schemas/SearchJsonQueryV2" - groupBy: - items: - $ref: "#/components/schemas/AggregationGroupByV2" - type: array - accuracy: - $ref: "#/components/schemas/AggregationAccuracyRequest" - AggregationV2: - description: Specifies an aggregation function. - type: object - x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - max: "#/components/schemas/MaxAggregationV2" - min: "#/components/schemas/MinAggregationV2" - avg: "#/components/schemas/AvgAggregationV2" - sum: "#/components/schemas/SumAggregationV2" - count: "#/components/schemas/CountAggregationV2" - approximateDistinct: "#/components/schemas/ApproximateDistinctAggregationV2" - approximatePercentile: "#/components/schemas/ApproximatePercentileAggregationV2" - exactDistinct: "#/components/schemas/ExactDistinctAggregationV2" - oneOf: - - $ref: "#/components/schemas/MaxAggregationV2" - - $ref: "#/components/schemas/MinAggregationV2" - - $ref: "#/components/schemas/AvgAggregationV2" - - $ref: "#/components/schemas/SumAggregationV2" - - $ref: "#/components/schemas/CountAggregationV2" - - $ref: "#/components/schemas/ApproximateDistinctAggregationV2" - - $ref: "#/components/schemas/ApproximatePercentileAggregationV2" - - $ref: "#/components/schemas/ExactDistinctAggregationV2" - MaxAggregationV2: - description: Computes the maximum value for the provided field. - type: object - x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - name: - $ref: "#/components/schemas/AggregationMetricName" - direction: - $ref: "#/components/schemas/OrderByDirection" - required: - - field - MinAggregationV2: - description: Computes the minimum value for the provided field. - type: object - x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - name: - $ref: "#/components/schemas/AggregationMetricName" - direction: - $ref: "#/components/schemas/OrderByDirection" - required: - - field - AvgAggregationV2: - description: Computes the average value for the provided field. - type: object - x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - name: - $ref: "#/components/schemas/AggregationMetricName" - direction: - $ref: "#/components/schemas/OrderByDirection" - required: - - field - SumAggregationV2: - description: Computes the sum of values for the provided field. - type: object - x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - name: - $ref: "#/components/schemas/AggregationMetricName" - direction: - $ref: "#/components/schemas/OrderByDirection" - required: - - field - CountAggregationV2: - description: Computes the total count of objects. - type: object - x-namespace: Ontologies - properties: - name: - $ref: "#/components/schemas/AggregationMetricName" - direction: - $ref: "#/components/schemas/OrderByDirection" - ApproximateDistinctAggregationV2: - description: Computes an approximate number of distinct values for the provided field. - type: object - x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - name: - $ref: "#/components/schemas/AggregationMetricName" - direction: - $ref: "#/components/schemas/OrderByDirection" - required: - - field - ExactDistinctAggregationV2: - description: Computes an exact number of distinct values for the provided field. May be slower than an approximate distinct aggregation. Requires Object Storage V2. - type: object - x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - name: - $ref: "#/components/schemas/AggregationMetricName" - direction: - $ref: "#/components/schemas/OrderByDirection" - required: - - field - ApproximatePercentileAggregationV2: - description: Computes the approximate percentile value for the provided field. Requires Object Storage V2. - type: object - x-namespace: Ontologies - properties: - field: - $ref: "#/components/schemas/PropertyApiName" - name: - $ref: "#/components/schemas/AggregationMetricName" - approximatePercentile: - type: number - format: double - x-safety: safe - direction: - $ref: "#/components/schemas/OrderByDirection" - required: - - field - - approximatePercentile - OrderByDirection: - x-namespace: Ontologies - enum: - - ASC - - DESC - AggregationGroupByV2: - description: Specifies a grouping for aggregation results. - type: object - x-namespace: Ontologies - discriminator: - propertyName: type - mapping: - fixedWidth: "#/components/schemas/AggregationFixedWidthGroupingV2" - ranges: "#/components/schemas/AggregationRangesGroupingV2" - exact: "#/components/schemas/AggregationExactGroupingV2" - duration: "#/components/schemas/AggregationDurationGroupingV2" - oneOf: - - $ref: "#/components/schemas/AggregationFixedWidthGroupingV2" - - $ref: "#/components/schemas/AggregationRangesGroupingV2" - - $ref: "#/components/schemas/AggregationExactGroupingV2" - - $ref: "#/components/schemas/AggregationDurationGroupingV2" - AggregationAccuracyRequest: - x-namespace: Ontologies - enum: - - REQUIRE_ACCURATE - - ALLOW_APPROXIMATE - AggregationAccuracy: - x-namespace: Ontologies - enum: - - ACCURATE - - APPROXIMATE - AggregateObjectsResponseV2: - properties: - excludedItems: - type: integer - x-safety: unsafe - accuracy: - $ref: "#/components/schemas/AggregationAccuracy" - data: - items: - $ref: "#/components/schemas/AggregateObjectsResponseItemV2" - type: array - type: object - required: - - accuracy - x-namespace: Ontologies - AggregateObjectsResponseItemV2: - type: object + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ParametersNotFound: + description: | + The provided parameter ID was not found for the action. Please look at the `configuredParameterIds` field + to see which ones are available. properties: - group: - additionalProperties: - $ref: "#/components/schemas/AggregationGroupValueV2" - x-mapKey: - $ref: "#/components/schemas/AggregationGroupKeyV2" - metrics: - items: - $ref: "#/components/schemas/AggregationMetricResultV2" - type: array - AggregationMetricResultV2: - type: object + parameters: + properties: + actionType: + $ref: "#/components/schemas/ActionTypeApiName" + unknownParameterIds: + items: + $ref: "#/components/schemas/ParameterId" + type: array + configuredParameterIds: + items: + $ref: "#/components/schemas/ParameterId" + type: array + required: + - actionType + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + PropertiesNotFound: + description: The requested properties are not found on the object type. properties: - name: + parameters: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + properties: + items: + $ref: "#/components/schemas/PropertyApiName" + type: array + required: + - objectType + type: object + errorCode: + enum: + - NOT_FOUND type: string - x-safety: unsafe - value: - description: | - The value of the metric. This will be a double in the case of - a numeric metric, or a date string in the case of a date metric. - x-safety: unsafe - required: - - name - AggregationGroupKeyV2: - type: string - x-namespace: Ontologies - x-safety: unsafe - AggregationGroupValueV2: - x-safety: unsafe + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - AggregationExactGroupingV2: - description: Divides objects into groups according to an exact value. - type: object + PropertiesNotSortable: + description: | + Results could not be ordered by the requested properties. Please mark the properties as *Searchable* and + *Sortable* in the **Ontology Manager** to enable their use in `orderBy` parameters. There may be a short delay + between the time a property is set to *Searchable* and *Sortable* and when it can be used. + properties: + parameters: + properties: + properties: + items: + $ref: "#/components/schemas/PropertyApiName" + type: array + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ParameterObjectNotFound: + description: | + The parameter object reference or parameter default value is not found, or the client token does not have access to it. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - maxGroupCount: - type: integer - x-safety: safe - required: - - field - AggregationFixedWidthGroupingV2: - description: Divides objects into groups with the specified width. - type: object + parameters: + type: object + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + primaryKey: + additionalProperties: + $ref: "#/components/schemas/PrimaryKeyValue" + x-mapKey: + $ref: "#/components/schemas/PropertyApiName" + required: + - objectType + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + ParameterObjectSetRidNotFound: + description: | + The parameter object set RID is not found, or the client token does not have access to it. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - fixedWidth: - type: integer - x-safety: safe - required: - - field - - fixedWidth - AggregationRangeV2: - description: Specifies a range from an inclusive start value to an exclusive end value. - type: object + parameters: + type: object + properties: + objectSetRid: + type: string + format: rid + x-safety: safe + required: + - objectSetRid + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + PropertiesNotSearchable: + description: | + Search is not enabled on the specified properties. Please mark the properties as *Searchable* + in the **Ontology Manager** to enable search on them. There may be a short delay + between the time a property is marked *Searchable* and when it can be used. properties: - startValue: - description: Inclusive start. - x-safety: unsafe - endValue: - description: Exclusive end. - x-safety: unsafe - required: - - startValue - - endValue - AggregationRangesGroupingV2: - description: Divides objects into groups according to specified ranges. - type: object + parameters: + properties: + propertyApiNames: + items: + $ref: "#/components/schemas/PropertyApiName" + type: array + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + PropertiesNotFilterable: + description: | + Results could not be filtered by the requested properties. Please mark the properties as *Searchable* and + *Selectable* in the **Ontology Manager** to be able to filter on those properties. There may be a short delay + between the time a property is marked *Searchable* and *Selectable* and when it can be used. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - ranges: - items: - $ref: "#/components/schemas/AggregationRangeV2" - type: array - required: - - field - AggregationDurationGroupingV2: + parameters: + properties: + properties: + items: + $ref: "#/components/schemas/PropertyApiName" + type: array + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + PropertyApiNameNotFound: description: | - Divides objects into groups according to an interval. Note that this grouping applies only on date and timestamp types. - When grouping by `YEARS`, `QUARTERS`, `MONTHS`, or `WEEKS`, the `value` must be set to `1`. - type: object + A property that was required to have an API name, such as a primary key, is missing one. You can set an API + name for it using the **Ontology Manager**. + properties: + parameters: + properties: + propertyId: + $ref: "#/components/schemas/PropertyId" + propertyBaseType: + $ref: "#/components/schemas/ValueType" + required: + - propertyBaseType + - propertyId + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies + PropertyBaseTypeNotSupported: + description: | + The type of the requested property is not currently supported by this API. If you need support for this, + please reach out to Palantir Support. properties: - field: - $ref: "#/components/schemas/PropertyApiName" - value: - type: integer - x-safety: unsafe - unit: - $ref: "#/components/schemas/TimeUnit" - required: - - field - - value - - unit - AggregationObjectTypeGrouping: - description: "Divides objects into groups based on their object type. This grouping is only useful when aggregating across \nmultiple object types, such as when aggregating over an interface type.\n" - type: object + parameters: + properties: + objectType: + $ref: "#/components/schemas/ObjectTypeApiName" + property: + $ref: "#/components/schemas/PropertyApiName" + propertyBaseType: + $ref: "#/components/schemas/ValueType" + required: + - objectType + - property + - propertyBaseType + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error x-namespace: Ontologies - properties: {} - GeoJsonObject: + PropertyFiltersNotSupported: description: | - GeoJSon object - - The coordinate reference system for all GeoJSON coordinates is a - geographic coordinate reference system, using the World Geodetic System - 1984 (WGS 84) datum, with longitude and latitude units of decimal - degrees. - This is equivalent to the coordinate reference system identified by the - Open Geospatial Consortium (OGC) URN - An OPTIONAL third-position element SHALL be the height in meters above - or below the WGS 84 reference ellipsoid. - In the absence of elevation values, applications sensitive to height or - depth SHOULD interpret positions as being at local ground or sea level. - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3 - discriminator: - propertyName: type - mapping: - Feature: "#/components/schemas/Feature" - FeatureCollection: "#/components/schemas/FeatureCollection" - Point: "#/components/schemas/GeoPoint" - MultiPoint: "#/components/schemas/MultiPoint" - LineString: "#/components/schemas/LineString" - MultiLineString: "#/components/schemas/MultiLineString" - Polygon: "#/components/schemas/Polygon" - MultiPolygon: "#/components/schemas/MultiPolygon" - GeometryCollection: "#/components/schemas/GeometryCollection" - oneOf: - - $ref: "#/components/schemas/Feature" - - $ref: "#/components/schemas/FeatureCollection" - - $ref: "#/components/schemas/GeoPoint" - - $ref: "#/components/schemas/MultiPoint" - - $ref: "#/components/schemas/LineString" - - $ref: "#/components/schemas/MultiLineString" - - $ref: "#/components/schemas/Polygon" - - $ref: "#/components/schemas/MultiPolygon" - - $ref: "#/components/schemas/GeometryCollection" - type: object + At least one of the requested property filters are not supported. See the documentation of `PropertyFilter` for + a list of supported property filters. properties: - type: - type: string + parameters: + properties: + propertyFilters: + items: + $ref: "#/components/schemas/PropertyFilter" + type: array + property: + $ref: "#/components/schemas/PropertyApiName" + required: + - property + type: object + errorCode: enum: - - Feature - - FeatureCollection - - Point - - MultiPoint - - LineString - - MultiLineString - - Polygon - - MultiPolygon - - GeometryCollection - Geometry: - nullable: true - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1 - description: Abstract type for all GeoJSon object except Feature and FeatureCollection - discriminator: - propertyName: type - mapping: - Point: "#/components/schemas/GeoPoint" - MultiPoint: "#/components/schemas/MultiPoint" - LineString: "#/components/schemas/LineString" - MultiLineString: "#/components/schemas/MultiLineString" - Polygon: "#/components/schemas/Polygon" - MultiPolygon: "#/components/schemas/MultiPolygon" - GeometryCollection: "#/components/schemas/GeometryCollection" - oneOf: - - $ref: "#/components/schemas/GeoPoint" - - $ref: "#/components/schemas/MultiPoint" - - $ref: "#/components/schemas/LineString" - - $ref: "#/components/schemas/MultiLineString" - - $ref: "#/components/schemas/Polygon" - - $ref: "#/components/schemas/MultiPolygon" - - $ref: "#/components/schemas/GeometryCollection" - FeaturePropertyKey: - type: string - x-safety: unsafe - FeatureCollectionTypes: - discriminator: - propertyName: type - mapping: - Feature: "#/components/schemas/Feature" - oneOf: - - $ref: "#/components/schemas/Feature" - Feature: - type: object - description: GeoJSon 'Feature' object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.2 - properties: - geometry: - $ref: "#/components/schemas/Geometry" - properties: - description: | - A `Feature` object has a member with the name "properties". The - value of the properties member is an object (any JSON object or a - JSON null value). - additionalProperties: - x-safety: unsafe - x-mapKey: - $ref: "#/components/schemas/FeaturePropertyKey" - id: - description: | - If a `Feature` has a commonly used identifier, that identifier - SHOULD be included as a member of the Feature object with the name - "id", and the value of this member is either a JSON string or - number. - x-safety: unsafe - bbox: - $ref: "#/components/schemas/BBox" - FeatureCollection: - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.3 - description: GeoJSon 'FeatureCollection' object - type: object - properties: - features: - type: array - items: - $ref: "#/components/schemas/FeatureCollectionTypes" - bbox: - $ref: "#/components/schemas/BBox" - GeoPoint: - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.2 - type: object - properties: - coordinates: - $ref: "#/components/schemas/Position" - bbox: - $ref: "#/components/schemas/BBox" - required: - - coordinates - MultiPoint: - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.3 - type: object - properties: - coordinates: - type: array - items: - $ref: "#/components/schemas/Position" - bbox: - $ref: "#/components/schemas/BBox" - LineString: - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.4 - type: object - properties: - coordinates: - $ref: "#/components/schemas/LineStringCoordinates" - bbox: - $ref: "#/components/schemas/BBox" - MultiLineString: - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.4 - type: object + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + PropertyTypesSearchNotSupported: + description: | + The search on the property types are not supported. See the `Search Objects` documentation for + a list of supported search queries on different property types. properties: - coordinates: - type: array - items: - $ref: "#/components/schemas/LineStringCoordinates" - bbox: - $ref: "#/components/schemas/BBox" - Polygon: - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.6 - type: object + parameters: + properties: + parameters: + additionalProperties: + type: array + items: + $ref: "#/components/schemas/PropertyApiName" + x-mapKey: + $ref: "#/components/schemas/PropertyFilter" + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + InvalidRangeQuery: + description: | + The specified query range filter is invalid. properties: - coordinates: - type: array - items: - $ref: "#/components/schemas/LinearRing" - bbox: - $ref: "#/components/schemas/BBox" - MultiPolygon: - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.7 - type: object + parameters: + properties: + lt: + description: Less than + x-safety: unsafe + gt: + description: Greater than + x-safety: unsafe + lte: + description: Less than or equal + x-safety: unsafe + gte: + description: Greater than or equal + x-safety: unsafe + field: + type: string + x-safety: unsafe + required: + - field + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + QueryNotFound: + description: "The query is not found, or the user does not have access to it." properties: - coordinates: - type: array - items: - type: array - items: - $ref: "#/components/schemas/LinearRing" - bbox: - $ref: "#/components/schemas/BBox" - LineStringCoordinates: - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.4 - description: | - GeoJSon fundamental geometry construct, array of two or more positions. - type: array - items: - $ref: "#/components/schemas/Position" - minItems: 2 - LinearRing: - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.6 - description: | - A linear ring is a closed LineString with four or more positions. - - The first and last positions are equivalent, and they MUST contain - identical values; their representation SHOULD also be identical. - - A linear ring is the boundary of a surface or the boundary of a hole in - a surface. - - A linear ring MUST follow the right-hand rule with respect to the area - it bounds, i.e., exterior rings are counterclockwise, and holes are - clockwise. - type: array - items: - $ref: "#/components/schemas/Position" - minItems: 4 - GeometryCollection: - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.8 + parameters: + properties: + query: + $ref: "#/components/schemas/QueryApiName" + required: + - query + type: object + errorCode: + enum: + - NOT_FOUND + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + UnknownParameter: description: | - GeoJSon geometry collection - - GeometryCollections composed of a single part or a number of parts of a - single type SHOULD be avoided when that single part or a single object - of multipart type (MultiPoint, MultiLineString, or MultiPolygon) could - be used instead. - type: object + The provided parameters were not found. Please look at the `knownParameters` field + to see which ones are available. properties: - geometries: - type: array - items: - $ref: "#/components/schemas/Geometry" - minItems: 0 - bbox: - $ref: "#/components/schemas/BBox" - Position: - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.1 + parameters: + properties: + unknownParameters: + items: + $ref: "#/components/schemas/ParameterId" + type: array + expectedParameters: + items: + $ref: "#/components/schemas/ParameterId" + type: array + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + QueryEncounteredUserFacingError: description: | - GeoJSon fundamental geometry construct. - - A position is an array of numbers. There MUST be two or more elements. - The first two elements are longitude and latitude, precisely in that order and using decimal numbers. - Altitude or elevation MAY be included as an optional third element. - - Implementations SHOULD NOT extend positions beyond three elements - because the semantics of extra elements are unspecified and ambiguous. - Historically, some implementations have used a fourth element to carry - a linear referencing measure (sometimes denoted as "M") or a numerical - timestamp, but in most situations a parser will not be able to properly - interpret these values. The interpretation and meaning of additional - elements is beyond the scope of this specification, and additional - elements MAY be ignored by parsers. - type: array - items: - $ref: "#/components/schemas/Coordinate" - minItems: 2 - maxItems: 3 - BBox: - externalDocs: - url: https://datatracker.ietf.org/doc/html/rfc7946#section-5 + The authored `Query` failed to execute because of a user induced error. The message argument + is meant to be displayed to the user. + properties: + parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + message: + type: string + x-safety: unsafe + required: + - functionRid + - functionVersion + - message + type: object + errorCode: + enum: + - CONFLICT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + QueryRuntimeError: description: | - A GeoJSON object MAY have a member named "bbox" to include - information on the coordinate range for its Geometries, Features, or - FeatureCollections. The value of the bbox member MUST be an array of - length 2*n where n is the number of dimensions represented in the - contained geometries, with all axes of the most southwesterly point - followed by all axes of the more northeasterly point. The axes order - of a bbox follows the axes order of geometries. - type: array - items: - $ref: "#/components/schemas/Coordinate" - Coordinate: - type: number - format: double + The authored `Query` failed to execute because of a runtime error. + properties: + parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + message: + type: string + x-safety: unsafe + stacktrace: + type: string + x-safety: unsafe + parameters: + additionalProperties: + type: string + x-safety: unsafe + x-mapKey: + $ref: "#/components/schemas/QueryRuntimeErrorParameter" + required: + - functionRid + - functionVersion + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Ontologies + QueryRuntimeErrorParameter: + type: string + x-namespace: Ontologies x-safety: unsafe - InvalidApplyActionOptionCombination: - description: The given options are individually valid but cannot be used in the given combination. + QueryTimeExceededLimit: + description: | + Time limits were exceeded for the `Query` execution. properties: parameters: properties: - invalidCombination: - $ref: "#/components/schemas/ApplyActionRequestOptions" + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + required: + - functionRid + - functionVersion type: object errorCode: enum: - - INVALID_ARGUMENT + - TIMEOUT type: string errorName: type: string errorInstanceId: type: string x-type: error - ActionContainsDuplicateEdits: - description: The given action request has multiple edits on the same object. + x-namespace: Ontologies + QueryMemoryExceededLimit: + description: | + Memory limits were exceeded for the `Query` execution. properties: parameters: + properties: + functionRid: + $ref: "#/components/schemas/FunctionRid" + functionVersion: + $ref: "#/components/schemas/FunctionVersion" + required: + - functionRid + - functionVersion type: object errorCode: enum: - - CONFLICT + - TIMEOUT type: string errorName: type: string errorInstanceId: type: string x-type: error - ActionEditsReadOnlyEntity: - description: The given action request performs edits on a type that is read-only or does not allow edits. + x-namespace: Ontologies + ResourcePath: + description: | + A path in the Foundry file tree. + type: string + x-safety: unsafe + x-namespace: Datasets + DatasetName: + type: string + x-safety: unsafe + x-namespace: Datasets + DatasetRid: + description: | + The Resource Identifier (RID) of a Dataset. Example: `ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da`. + format: rid + type: string + x-safety: safe + x-namespace: Datasets + Dataset: + properties: + rid: + $ref: "#/components/schemas/DatasetRid" + name: + $ref: "#/components/schemas/DatasetName" + parentFolderRid: + $ref: "#/components/schemas/FolderRid" + required: + - rid + - name + - parentFolderRid + type: object + x-namespace: Datasets + CreateDatasetRequest: + properties: + name: + $ref: "#/components/schemas/DatasetName" + parentFolderRid: + $ref: "#/components/schemas/FolderRid" + required: + - name + - parentFolderRid + type: object + x-namespace: Datasets + TableExportFormat: + description: | + Format for tabular dataset export. + enum: + - ARROW + - CSV + x-namespace: Datasets + BranchId: + description: | + The identifier (name) of a Branch. Example: `master`. + type: string + x-safety: unsafe + x-namespace: Datasets + Branch: + description: | + A Branch of a Dataset. + properties: + branchId: + $ref: "#/components/schemas/BranchId" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + required: + - branchId + type: object + x-namespace: Datasets + CreateBranchRequest: + properties: + branchId: + $ref: "#/components/schemas/BranchId" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + required: + - branchId + type: object + x-namespace: Datasets + ListBranchesResponse: + properties: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + description: The list of branches in the current page. + items: + $ref: "#/components/schemas/Branch" + type: array + type: object + x-namespace: Datasets + TransactionRid: + description: | + The Resource Identifier (RID) of a Transaction. Example: `ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4`. + format: rid + type: string + x-safety: safe + x-namespace: Datasets + TransactionType: + description: | + The type of a Transaction. + enum: + - APPEND + - UPDATE + - SNAPSHOT + - DELETE + x-namespace: Datasets + TransactionStatus: + description: | + The status of a Transaction. + enum: + - ABORTED + - COMMITTED + - OPEN + x-namespace: Datasets + CreateTransactionRequest: + properties: + transactionType: + $ref: "#/components/schemas/TransactionType" + type: object + x-namespace: Datasets + Transaction: + description: | + An operation that modifies the files within a dataset. + properties: + rid: + $ref: "#/components/schemas/TransactionRid" + transactionType: + $ref: "#/components/schemas/TransactionType" + status: + $ref: "#/components/schemas/TransactionStatus" + createdTime: + type: string + format: date-time + description: "The timestamp when the transaction was created, in ISO 8601 timestamp format." + x-safety: unsafe + closedTime: + type: string + format: date-time + description: "The timestamp when the transaction was closed, in ISO 8601 timestamp format." + x-safety: unsafe + required: + - rid + - transactionType + - status + - createdTime + type: object + x-namespace: Datasets + File: + properties: + path: + $ref: "#/components/schemas/FilePath" + transactionRid: + $ref: "#/components/schemas/TransactionRid" + sizeBytes: + type: string + format: long + x-safety: safe + updatedTime: + type: string + format: date-time + x-safety: unsafe + required: + - path + - transactionRid + - updatedTime + type: object + x-namespace: Datasets + ListFilesResponse: + description: A page of Files and an optional page token that can be used to retrieve the next page. + properties: + nextPageToken: + $ref: "#/components/schemas/PageToken" + data: + items: + $ref: "#/components/schemas/File" + type: array + type: object + x-namespace: Datasets + ApiFeaturePreviewUsageOnly: + description: | + This feature is only supported in preview mode. Please use `preview=true` in the query + parameters to call this endpoint. properties: parameters: type: object - properties: - entityTypeRid: - $ref: "#/components/schemas/ObjectTypeRid" errorCode: enum: - INVALID_ARGUMENT @@ -7066,114 +7277,123 @@ components: errorInstanceId: type: string x-type: error - ObjectSetNotFound: - description: "The requested object set is not found, or the client token does not have access to it." + x-namespace: Core + ApiUsageDenied: + description: You are not allowed to use Palantir APIs. properties: parameters: - properties: - objectSetRid: - $ref: "#/components/schemas/ObjectSetRid" - required: - - objectSetRid type: object errorCode: enum: - - NOT_FOUND + - PERMISSION_DENIED type: string errorName: type: string errorInstanceId: type: string x-type: error - x-namespace: Ontologies - MarketplaceInstallationNotFound: - description: | - The given marketplace installation could not be found or the user does not have access to it. + x-namespace: Core + InvalidPageSize: + description: The provided page size was zero or negative. Page sizes must be greater than zero. properties: parameters: properties: - artifactRepository: - $ref: "#/components/schemas/ArtifactRepositoryRid" - packageName: - $ref: "#/components/schemas/SdkPackageName" + pageSize: + $ref: "#/components/schemas/PageSize" required: - - artifactRepository - - packageName + - pageSize type: object errorCode: enum: - - NOT_FOUND + - INVALID_ARGUMENT type: string errorName: type: string errorInstanceId: type: string x-type: error - MarketplaceObjectMappingNotFound: - description: The given object could not be mapped to a Marketplace installation. + x-namespace: Core + InvalidPageToken: + description: The provided page token could not be used to retrieve the next page of results. properties: parameters: properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - artifactRepository: - $ref: "#/components/schemas/ArtifactRepositoryRid" - packageName: - $ref: "#/components/schemas/SdkPackageName" + pageToken: + $ref: "#/components/schemas/PageToken" required: - - objectType - - artifactRepository - - packageName + - pageToken + type: object + errorCode: + enum: + - INVALID_ARGUMENT + type: string + errorName: + type: string + errorInstanceId: + type: string + x-type: error + x-namespace: Core + InvalidParameterCombination: + description: The given parameters are individually valid but cannot be used in the given combination. + properties: + parameters: + properties: + validCombinations: + type: array + items: + type: array + items: + type: string + x-safety: safe + providedParameters: + type: array + items: + type: string + x-safety: safe type: object errorCode: enum: - - NOT_FOUND + - INVALID_ARGUMENT type: string errorName: type: string errorInstanceId: type: string x-type: error - MarketplaceActionMappingNotFound: - description: The given action could not be mapped to a Marketplace installation. + x-namespace: Core + ResourceNameAlreadyExists: + description: The provided resource name is already in use by another resource in the same folder. properties: parameters: properties: - actionType: - $ref: "#/components/schemas/ActionTypeApiName" - artifactRepository: - $ref: "#/components/schemas/ArtifactRepositoryRid" - packageName: - $ref: "#/components/schemas/SdkPackageName" + parentFolderRid: + $ref: "#/components/schemas/FolderRid" + resourceName: + type: string + x-safety: unsafe required: - - actionType - - artifactRepository - - packageName + - parentFolderRid + - resourceName type: object errorCode: enum: - - NOT_FOUND + - CONFLICT type: string errorName: type: string errorInstanceId: type: string x-type: error - MarketplaceQueryMappingNotFound: - description: The given query could not be mapped to a Marketplace installation. + x-namespace: Core + FolderNotFound: + description: "The requested folder could not be found, or the client token does not have access to it." properties: parameters: properties: - queryType: - $ref: "#/components/schemas/QueryApiName" - artifactRepository: - $ref: "#/components/schemas/ArtifactRepositoryRid" - packageName: - $ref: "#/components/schemas/SdkPackageName" + folderRid: + $ref: "#/components/schemas/FolderRid" required: - - queryType - - artifactRepository - - packageName + - folderRid type: object errorCode: enum: @@ -7184,41 +7404,37 @@ components: errorInstanceId: type: string x-type: error - MarketplaceLinkMappingNotFound: - description: The given link could not be mapped to a Marketplace installation. + x-namespace: Core + MissingPostBody: + description: "A post body is required for this endpoint, but was not found in the request." properties: parameters: - properties: - linkType: - $ref: "#/components/schemas/LinkTypeApiName" - artifactRepository: - $ref: "#/components/schemas/ArtifactRepositoryRid" - packageName: - $ref: "#/components/schemas/SdkPackageName" - required: - - linkType - - artifactRepository - - packageName type: object errorCode: enum: - - NOT_FOUND + - INVALID_ARGUMENT type: string errorName: type: string errorInstanceId: type: string x-type: error - OntologyApiNameNotUnique: - description: The given Ontology API name is not unique. Use the Ontology RID in place of the Ontology API name. + x-namespace: Core + UnknownDistanceUnit: + description: An unknown distance unit was provided. properties: parameters: - properties: - ontologyApiName: - $ref: "#/components/schemas/OntologyApiName" type: object + properties: + unknownUnit: + type: string + x-safety: unsafe + knownUnits: + type: array + items: + $ref: "#/components/schemas/DistanceUnit" required: - - ontologyApiName + - unknownUnit errorCode: enum: - INVALID_ARGUMENT @@ -7228,325 +7444,261 @@ components: errorInstanceId: type: string x-type: error - RequestId: + x-namespace: Core + ContentLength: type: string - format: uuid - description: Unique request id - x-namespace: Ontologies + format: long x-safety: safe - SubscriptionId: + x-namespace: Core + ContentType: + type: string + x-safety: safe + x-namespace: Core + Duration: + type: string + description: An ISO 8601 formatted duration. + x-safety: unsafe + x-namespace: Core + PageSize: + description: The page size to use for the endpoint. + type: integer + x-safety: safe + x-namespace: Core + PageToken: + description: | + The page token indicates where to start paging. This should be omitted from the first page's request. + To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response + and populate the next request's `pageToken` field with it. + type: string + x-safety: unsafe + x-namespace: Core + TotalCount: + description: | + The total number of items across all pages. + type: string + format: long + x-safety: safe + x-namespace: Core + PreviewMode: + description: Enables the use of preview functionality. + type: boolean + x-safety: safe + x-namespace: Core + SizeBytes: + description: The size of the file or attachment in bytes. type: string + format: long + x-safety: safe + x-namespace: Core + UserId: + description: | + A Foundry User ID. format: uuid - description: A unique identifier used to associate subscription requests with responses. - x-namespace: Ontologies + type: string x-safety: safe - ObjectSetStreamSubscribeRequest: - type: object - properties: - objectSet: - $ref: "#/components/schemas/ObjectSet" - propertySet: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - referenceSet: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - required: - - objectSet - x-namespace: Ontologies - ObjectSetStreamSubscribeRequests: - type: object - description: "The list of object sets that should be subscribed to. A client can stop subscribing to an object set \nby removing the request from subsequent ObjectSetStreamSubscribeRequests.\n" - properties: - id: - description: "A randomly generated RequestId used to associate a ObjectSetStreamSubscribeRequest with a subsequent \nObjectSetSubscribeResponses. Each RequestId should be unique.\n" - $ref: "#/components/schemas/RequestId" - requests: - type: array - items: - $ref: "#/components/schemas/ObjectSetStreamSubscribeRequest" - required: - - id - x-namespace: Ontologies - StreamMessage: - type: object - discriminator: - propertyName: type - mapping: - subscribeResponses: "#/components/schemas/ObjectSetSubscribeResponses" - objectSetChanged: "#/components/schemas/ObjectSetUpdates" - refreshObjectSet: "#/components/schemas/RefreshObjectSet" - subscriptionClosed: "#/components/schemas/SubscriptionClosed" - oneOf: - - $ref: "#/components/schemas/ObjectSetSubscribeResponses" - - $ref: "#/components/schemas/ObjectSetUpdates" - - $ref: "#/components/schemas/RefreshObjectSet" - - $ref: "#/components/schemas/SubscriptionClosed" - x-namespace: Ontologies - ObjectSetSubscribeResponses: - type: object + x-namespace: Core + CreatedTime: description: | - Returns a response for every request in the same order. Duplicate requests will be assigned the same SubscriberId. - properties: - responses: - type: array - items: - $ref: "#/components/schemas/ObjectSetSubscribeResponse" - id: - $ref: "#/components/schemas/RequestId" - required: - - id - x-namespace: Ontologies - ObjectSetSubscribeResponse: - type: object - discriminator: - propertyName: type - mapping: - success: "#/components/schemas/SubscriptionSuccess" - error: "#/components/schemas/SubscriptionError" - qos: "#/components/schemas/QosError" - oneOf: - - $ref: "#/components/schemas/SubscriptionSuccess" - - $ref: "#/components/schemas/SubscriptionError" - - $ref: "#/components/schemas/QosError" - x-namespace: Ontologies - SubscriptionSuccess: - type: object - properties: - id: - $ref: "#/components/schemas/SubscriptionId" - required: - - id - x-namespace: Ontologies - SubscriptionError: - type: object - properties: - errors: - type: array - items: - $ref: "#/components/schemas/Error" - x-namespace: Ontologies - QosError: - type: object + The time at which the resource was created. + type: string + x-safety: safe + x-namespace: Core + UpdatedTime: + description: | + The time at which the resource was most recently updated. + type: string + x-safety: safe + x-namespace: Core + FolderRid: + type: string + format: rid + x-safety: safe + x-namespace: Core + FilePath: + description: | + The path to a File within Foundry. Examples: `my-file.txt`, `path/to/my-file.jpg`, `dataframe.snappy.parquet`. + type: string + x-safety: unsafe + x-namespace: Core + Filename: + description: | + The name of a File within Foundry. Examples: `my-file.txt`, `my-file.jpg`, `dataframe.snappy.parquet`. + type: string + x-safety: unsafe + x-namespace: Core + ArchiveFileFormat: + description: | + The format of an archive file. + enum: + - ZIP + x-namespace: Core + DisplayName: + type: string + description: The display name of the entity. + x-safety: unsafe + x-namespace: Core + MediaType: description: | - An error indicating that the subscribe request should be attempted on a different node. - x-namespace: Ontologies - ErrorName: + The [media type](https://www.iana.org/assignments/media-types/media-types.xhtml) of the file or attachment. + Examples: `application/json`, `application/pdf`, `application/octet-stream`, `image/jpeg` type: string x-safety: safe - x-namespace: Ontologies - Arg: + x-namespace: Core + ReleaseStatus: + enum: + - ACTIVE + - EXPERIMENTAL + - DEPRECATED + description: The release status of the entity. + x-namespace: Core + TimeUnit: + enum: + - MILLISECONDS + - SECONDS + - MINUTES + - HOURS + - DAYS + - WEEKS + - MONTHS + - YEARS + - QUARTERS + x-namespace: Core + Distance: type: object + description: A measurement of distance. properties: - name: - type: string - x-safety: safe value: - type: string + type: number + format: double x-safety: unsafe + unit: + $ref: "#/components/schemas/DistanceUnit" required: - - name - value - x-namespace: Ontologies - Error: - type: object - properties: - error: - $ref: "#/components/schemas/ErrorName" - args: - type: array - items: - $ref: "#/components/schemas/Arg" - required: - - error - x-namespace: Ontologies - ReasonType: - description: | - Represents the reason a subscription was closed. + - unit + x-namespace: Core + DistanceUnit: enum: - - USER_CLOSED - - CHANNEL_CLOSED - x-namespace: Ontologies - Reason: + - MILLIMETERS + - CENTIMETERS + - METERS + - KILOMETERS + - INCHES + - FEET + - YARDS + - MILES + - NAUTICAL_MILES + x-namespace: Core + AnyType: type: object - properties: - reason: - $ref: "#/components/schemas/ReasonType" - required: - - reason - x-namespace: Ontologies - SubscriptionClosureCause: + x-namespace: Core + AttachmentType: type: object - discriminator: - propertyName: type - mapping: - error: "#/components/schemas/Error" - reason: "#/components/schemas/Reason" - oneOf: - - $ref: "#/components/schemas/Error" - - $ref: "#/components/schemas/Reason" - x-namespace: Ontologies - RefreshObjectSet: + x-namespace: Core + BinaryType: type: object - description: | - The list of updated Foundry Objects cannot be provided. The object set must be refreshed using Object Set Service. - properties: - id: - $ref: "#/components/schemas/SubscriptionId" - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - required: - - id - - objectType - x-namespace: Ontologies - SubscriptionClosed: + x-namespace: Core + BooleanType: type: object - description: | - The subscription has been closed due to an irrecoverable error during its lifecycle. - properties: - id: - $ref: "#/components/schemas/SubscriptionId" - cause: - $ref: "#/components/schemas/SubscriptionClosureCause" - required: - - id - - cause - x-namespace: Ontologies - ObjectSetUpdates: + x-namespace: Core + ByteType: type: object - properties: - id: - $ref: "#/components/schemas/SubscriptionId" - updates: - type: array - items: - $ref: "#/components/schemas/ObjectSetUpdate" - required: - - id - x-namespace: Ontologies - ObjectSetUpdate: + x-namespace: Core + DateType: type: object - discriminator: - propertyName: type - mapping: - object: "#/components/schemas/ObjectUpdate" - reference: "#/components/schemas/ReferenceUpdate" - oneOf: - - $ref: "#/components/schemas/ObjectUpdate" - - $ref: "#/components/schemas/ReferenceUpdate" - x-namespace: Ontologies - ObjectState: - description: "Represents the state of the object within the object set. ADDED_OR_UPDATED indicates that the object was \nadded to the set or the object has updated and was previously in the set. REMOVED indicates that the object \nwas removed from the set due to the object being deleted or the object no longer meets the object set \ndefinition.\n" - enum: - - ADDED_OR_UPDATED - - REMOVED - x-namespace: Ontologies - ObjectUpdate: + x-namespace: Core + DecimalType: type: object properties: - object: - $ref: "#/components/schemas/OntologyObjectV2" - state: - $ref: "#/components/schemas/ObjectState" - required: - - object - - state - x-namespace: Ontologies - ObjectPrimaryKey: + precision: + type: integer + x-safety: safe + scale: + type: integer + x-safety: safe + x-namespace: Core + DoubleType: type: object - additionalProperties: - $ref: "#/components/schemas/PropertyValue" - x-mapKey: - $ref: "#/components/schemas/PropertyApiName" - x-namespace: Ontologies - ReferenceUpdate: + x-namespace: Core + FilesystemResource: type: object - description: | - The updated data value associated with an object instance's external reference. The object instance - is uniquely identified by an object type and a primary key. Note that the value of the property - field returns a dereferenced value rather than the reference itself. - properties: - objectType: - $ref: "#/components/schemas/ObjectTypeApiName" - primaryKey: - $ref: "#/components/schemas/ObjectPrimaryKey" - description: The ObjectPrimaryKey of the object instance supplying the reference property. - property: - $ref: "#/components/schemas/PropertyApiName" - description: The PropertyApiName on the object type that corresponds to the reference property - value: - $ref: "#/components/schemas/ReferenceValue" - required: - - objectType - - primaryKey - - property - - value - x-namespace: Ontologies - ReferenceValue: + x-namespace: Core + FloatType: type: object - description: Resolved data values pointed to by a reference. + x-namespace: Core + GeoShapeType: + type: object + x-namespace: Core + GeoPointType: + type: object + x-namespace: Core + IntegerType: + type: object + x-namespace: Core + LocalFilePath: + type: object + x-namespace: Core + LongType: + type: object + x-namespace: Core + MarkingType: + type: object + x-namespace: Core + ShortType: + type: object + x-namespace: Core + StringType: + type: object + x-namespace: Core + TimeSeriesItemType: + description: | + A union of the types supported by time series properties. discriminator: propertyName: type mapping: - geotimeSeriesValue: "#/components/schemas/GeotimeSeriesValue" + double: "#/components/schemas/DoubleType" + string: "#/components/schemas/StringType" oneOf: - - $ref: "#/components/schemas/GeotimeSeriesValue" - x-namespace: Ontologies - GeotimeSeriesValue: + - $ref: "#/components/schemas/DoubleType" + - $ref: "#/components/schemas/StringType" + x-namespace: Core + TimeseriesType: type: object - description: The underlying data values pointed to by a GeotimeSeriesReference. properties: - position: - $ref: "#/components/schemas/Position" - timestamp: - type: string - format: date-time - x-safety: unsafe + itemType: + $ref: "#/components/schemas/TimeSeriesItemType" required: - - position - - timestamp - x-namespace: Ontologies -paths: - /v2/operations/{operationId}: - get: + - itemType + x-namespace: Core + TimestampType: + type: object + x-namespace: Core + StructFieldName: description: | - Get an asynchronous operation by its ID. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getOperation - x-operationVerb: get - x-releaseStage: PRIVATE_BETA - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: - - description: "The unique Resource Identifier (RID) of the operation. \nThis is the id returned in the response of the invoking operation.\n" - in: path - name: operationId - required: true - schema: + The name of a field in a `Struct`. + type: string + x-safety: unsafe + x-namespace: Core + NullType: + type: object + x-namespace: Core + UnsupportedType: + type: object + properties: + unsupportedType: type: string - format: rid x-safety: safe - example: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - responses: - "200": - content: - application/json: - schema: - x-type: - type: asyncOperationCollection - description: Success response. - /api/v1/ontologies: + required: + - unsupportedType + x-namespace: Core +paths: + /api/v2/ontologies: get: description: | Lists the Ontologies visible to the current user. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listOntologies + operationId: listOntologiesV2 x-operationVerb: list x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE @@ -7559,7 +7711,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ListOntologiesResponse" + $ref: "#/components/schemas/ListOntologiesV2Response" example: data: - apiName: default-ontology @@ -7571,13 +7723,13 @@ paths: description: The ontology shared with our suppliers rid: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 description: Success response. - /api/v1/ontologies/{ontologyRid}: + /api/v2/ontologies/{ontology}: get: description: | Gets a specific ontology with the given Ontology RID. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getOntology + operationId: getOntologyV2 x-operationVerb: get x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE @@ -7587,39 +7739,76 @@ paths: - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir responses: "200": content: application/json: schema: - $ref: "#/components/schemas/Ontology" + $ref: "#/components/schemas/OntologyV2" example: apiName: default-ontology displayName: Ontology description: The default ontology rid: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 description: Success response. - /api/v1/ontologies/{ontologyRid}/objectTypes: + /api/v2/ontologies/{ontology}/fullMetadata: get: description: | - Lists the object types for the given Ontology. + Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces. + operationId: getOntologyFullMetadata + x-operationVerb: getFullMetadata + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: PRIVATE_BETA + security: + - OAuth2: + - api:ontologies-read + - BearerAuth: [] + parameters: + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. + in: path + name: ontology + required: true + schema: + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/OntologyFullMetadata" + description: Success response. + /api/v2/ontologies/{ontology}/objects/{objectType}: + get: + description: | + Lists the objects for the given Ontology and object type. - Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are - more results available, at least one result will be present in the - response. + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listObjectTypes + operationId: listObjectsV2 x-operationVerb: list - x-auditCategory: ontologyMetaDataLoad + x-auditCategory: ontologyDataLoad x-releaseStage: STABLE security: - OAuth2: @@ -7627,16 +7816,25 @@ paths: - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The desired size of the page to be returned. Defaults to 500. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. + in: path + name: objectType + required: true + schema: + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query name: pageSize @@ -7648,70 +7846,171 @@ paths: required: false schema: $ref: "#/components/schemas/PageToken" + - description: | + The properties of the object type that should be included in the response. Omit this parameter to get all + the properties. + in: query + name: select + schema: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" + - in: query + name: orderBy + required: false + schema: + $ref: "#/components/schemas/OrderBy" + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + - description: "A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n" + in: query + name: excludeRid + schema: + type: boolean + x-safety: safe responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListObjectTypesResponse" + $ref: "#/components/schemas/ListObjectsResponseV2" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - apiName: employee - description: A full-time or part-time employee of our firm - primaryKey: - - employeeId - properties: - employeeId: - baseType: Integer - fullName: - baseType: String - office: - description: The unique ID of the employee's primary assigned office - baseType: String - startDate: - description: "The date the employee was hired (most recently, if they were re-hired)" - baseType: Date - rid: ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44 - - apiName: office - description: A physical location (not including rented co-working spaces) - primaryKey: - - officeId - properties: - officeId: - baseType: String - address: - description: The office's physical address (not necessarily shipping address) - baseType: String - capacity: - description: The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher) - baseType: Integer - rid: ri.ontology.main.object-type.9a0e4409-9b50-499f-a637-a3b8334060d9 + - __rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 + __primaryKey: 50030 + __apiName: Employee + id: 50030 + firstName: John + lastName: Doe + - __rid: ri.phonograph2-objects.main.object.dcd887d1-c757-4d7a-8619-71e6ec2c25ab + __primaryKey: 20090 + __apiName: Employee + id: 20090 + firstName: John + lastName: Haymore + description: Success response. + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}: + get: + description: | + Gets a specific object with the given primary key. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getObjectV2 + x-operationVerb: get + x-auditCategory: ontologyDataLoad + x-releaseStage: STABLE + security: + - OAuth2: + - api:ontologies-read + - BearerAuth: [] + parameters: + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. + in: path + name: ontology + required: true + schema: + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. + in: path + name: objectType + required: true + schema: + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The primary key of the requested object. To look up the expected primary key for your object type, use the + `Get object type` endpoint or the **Ontology Manager**. + in: path + name: primaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The properties of the object type that should be included in the response. Omit this parameter to get all + the properties. + in: query + name: select + schema: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + - description: "A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n" + in: query + name: excludeRid + schema: + type: boolean + x-safety: safe + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/OntologyObjectV2" + example: + __rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 + __primaryKey: 50030 + __apiName: Employee + id: 50030 + firstName: John + lastName: Doe description: Success response. - /api/v1/ontologies/{ontologyRid}/objectTypes/{objectType}: - get: + /api/v2/ontologies/{ontology}/objects/{objectType}/count: + post: description: | - Gets a specific object type with the given API name. + Returns a count of the objects of the given object type. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getObjectType - x-operationVerb: get - x-auditCategory: ontologyMetaDataLoad - x-releaseStage: STABLE + operationId: countObjects + x-operationVerb: count + x-auditCategory: ontologyDataSearch + x-releaseStage: PRIVATE_BETA security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. @@ -7721,42 +8020,35 @@ paths: schema: $ref: "#/components/schemas/ObjectTypeApiName" example: employee + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ObjectType" + $ref: "#/components/schemas/CountObjectsResponseV2" example: - apiName: employee - description: A full-time or part-time employee of our firm - primaryKey: - - employeeId - properties: - employeeId: - baseType: Integer - fullName: - baseType: String - office: - description: The unique ID of the employee's primary assigned office - baseType: String - startDate: - description: "The date the employee was hired (most recently, if they were re-hired)" - baseType: Date - rid: ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04 + count: 100 description: Success response. - /api/v1/ontologies/{ontologyRid}/actionTypes: - get: - description: | - Lists the action types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listActionTypes - x-operationVerb: list - x-auditCategory: ontologyMetaDataLoad + /api/v2/ontologies/{ontology}/objects/{objectType}/search: + post: + description: "Search for objects in the specified ontology and object type. The request body is used\nto filter objects based on the specified query. The supported queries are:\n\n| Query type | Description | Supported Types |\n|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------|\n| lt | The provided property is less than the provided value. | number, string, date, timestamp |\n| gt | The provided property is greater than the provided value. | number, string, date, timestamp |\n| lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp |\n| gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp |\n| eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp |\n| isNull | The provided property is (or is not) null. | all |\n| contains | The provided property contains the provided value. | array |\n| not | The sub-query does not match. | N/A (applied on a query) |\n| and | All the sub-queries match. | N/A (applied on queries) |\n| or | At least one of the sub-queries match. | N/A (applied on queries) |\n| startsWith | The provided property starts with the provided value. | string |\n| containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string |\n| containsAllTermsInOrder | The provided property contains the provided value as a substring. | string |\n| containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string |\n| containsAllTerms | The provided property contains all the terms separated by whitespace. | string | \n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" + operationId: searchObjectsV2 + x-operationVerb: search + x-auditCategory: ontologyDataSearch x-releaseStage: STABLE security: - OAuth2: @@ -7764,68 +8056,72 @@ paths: - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The desired size of the page to be returned. Defaults to 500. - See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. + in: path + name: objectType + required: true + schema: + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The repository associated with a marketplace installation. in: query - name: pageSize + name: artifactRepository required: false schema: - $ref: "#/components/schemas/PageSize" - - in: query - name: pageToken + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName required: false schema: - $ref: "#/components/schemas/PageToken" + $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SearchObjectsRequestV2" + example: + where: + type: eq + field: age + value: 21 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListActionTypesResponse" + $ref: "#/components/schemas/SearchObjectsResponseV2" example: - nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - apiName: promote-employee - description: Update an employee's title and compensation - parameters: - employeeId: - baseType: Integer - newTitle: - baseType: String - newCompensation: - baseType: Decimal - rid: ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167 - - apiName: move-office - description: Update an office's physical location - parameters: - officeId: - baseType: String - newAddress: - description: The office's new physical address (not necessarily shipping address) - baseType: String - newCapacity: - description: The maximum seated-at-desk capacity of the new office (maximum fire-safe capacity may be higher) - baseType: Integer - rid: ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2 + - __rid: ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb + __primaryKey: 1000 + __apiName: Employee + employeeId: 1000 + lastName: smith + firstName: john + age: 21 description: Success response. - /api/v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName}: - get: + /api/v2/ontologies/{ontology}/objects/{objectType}/aggregate: + post: description: | - Gets a specific action type with the given API name. + Perform functions on object fields in the specified ontology and object type. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getActionType - x-operationVerb: get - x-auditCategory: ontologyMetaDataLoad + operationId: aggregateObjectsV2 + x-operationVerb: aggregate + x-auditCategory: ontologyDataSearch x-releaseStage: STABLE security: - OAuth2: @@ -7833,90 +8129,112 @@ paths: - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the action type. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - - description: | - The name of the action type in the API. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: The type of the object to aggregate on. in: path - name: actionTypeApiName + name: objectType required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: promote-employee + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/AggregateObjectsRequestV2" + example: + aggregation: + - type: min + field: properties.tenure + name: min_tenure + - type: avg + field: properties.tenure + name: avg_tenure + query: + not: + field: name + eq: john + groupBy: + - field: startDate + type: range + ranges: + - startValue: 2020-01-01 + endValue: 2020-06-01 + - field: city + type: exact responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ActionType" - example: - data: - apiName: promote-employee - description: Update an employee's title and compensation - parameters: - employeeId: - baseType: Integer - newTitle: - baseType: String - newCompensation: - baseType: Decimal - rid: ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167 + $ref: "#/components/schemas/AggregateObjectsResponseV2" + example: + data: + - metrics: + - name: min_tenure + value: 1 + - name: avg_tenure + value: 3 + group: + startDate: + startValue: 2020-01-01 + endValue: 2020-06-01 + city: New York City + - metrics: + - name: min_tenure + value: 2 + - name: avg_tenure + value: 3 + group: + startDate: + startValue: 2020-01-01 + endValue: 2020-06-01 + city: San Francisco description: Success response. - /api/v1/ontologies/{ontologyRid}/objects/{objectType}: + /api/v2/ontologies/{ontology}/interfaceTypes: get: - description: | - Lists the objects for the given Ontology and object type. - - This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listObjects + description: ":::callout{theme=warning title=Warning}\n This endpoint is in preview and may be modified or removed at any time.\n To use this endpoint, add `preview=true` to the request query parameters.\n:::\n\nLists the interface types for the given Ontology.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response. \n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" + operationId: listInterfaceTypes x-operationVerb: list - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: PRIVATE_BETA security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. - in: path - name: ontologyRid - required: true - schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: objectType + name: ontology required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The desired size of the page to be returned. Defaults to 1,000. + The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query name: pageSize @@ -7929,569 +8247,519 @@ paths: schema: $ref: "#/components/schemas/PageToken" - description: | - The properties of the object type that should be included in the response. Omit this parameter to get all - the properties. + A boolean flag that, when set to true, enables the use of beta features in preview mode. in: query - name: properties - schema: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - - in: query - name: orderBy + name: preview required: false schema: - $ref: "#/components/schemas/OrderBy" + $ref: "#/components/schemas/PreviewMode" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListObjectsResponse" + $ref: "#/components/schemas/ListInterfaceTypesResponse" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 - properties: - id: 50030 - firstName: John - lastName: Doe - - rid: ri.phonograph2-objects.main.object.dcd887d1-c757-4d7a-8619-71e6ec2c25ab + - apiName: Athlete + displayName: Athlete + description: Good at sportsball properties: - id: 20090 - firstName: John - lastName: Haymore + name: + rid: com.palantir.property.d1abdbfe-0ce2-4fff-b0af-af21002c314b + apiName: name + displayName: Name + dataType: string + extendsInterfaces: + - Human + rid: ri.ontology.main.interface.bea1af8c-7d5c-4ec9-b845-8eeed6d77482 description: Success response. - /api/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}: + /api/v2/ontologies/{ontology}/interfaceTypes/{interfaceType}: get: description: | - Gets a specific object with the given primary key. + :::callout{theme=warning title=Warning} + This endpoint is in preview and may be modified or removed at any time. + To use this endpoint, add `preview=true` to the request query parameters. + ::: + + Gets a specific object type with the given API name. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getObject + operationId: getInterfaceType x-operationVerb: get - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: PRIVATE_BETA security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. - in: path - name: ontologyRid - required: true - schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: objectType + name: ontology required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The primary key of the requested object. To look up the expected primary key for your object type, use the - `Get object type` endpoint or the **Ontology Manager**. + The API name of the interface type. To find the API name, use the **List interface types** endpoint or + check the **Ontology Manager**. in: path - name: primaryKey + name: interfaceType required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 + $ref: "#/components/schemas/InterfaceTypeApiName" + example: Employee - description: | - The properties of the object type that should be included in the response. Omit this parameter to get all - the properties. + A boolean flag that, when set to true, enables the use of beta features in preview mode. in: query - name: properties + name: preview + required: false schema: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" + $ref: "#/components/schemas/PreviewMode" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/OntologyObject" + $ref: "#/components/schemas/InterfaceType" example: - rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 + apiName: Athlete + displayName: Athlete + description: Good at sportsball properties: - id: 50030 - firstName: John - lastName: Doe + name: + rid: com.palantir.property.d1abdbfe-0ce2-4fff-b0af-af21002c314b + apiName: name + displayName: Name + dataType: string + extendsInterfaces: + - Human + rid: ri.ontology.main.interface.bea1af8c-7d5c-4ec9-b845-8eeed6d77482 description: Success response. - /api/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}: - get: - description: | - Lists the linked objects for a specific object and the given link type. - - This endpoint supports filtering objects. - See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listLinkedObjects - x-operationVerb: listLinkedObjects - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE + /api/v2/ontologies/{ontology}/interfaces/{interfaceType}/search: + post: + description: ":::callout{theme=warning title=Warning}\n This endpoint is in preview and may be modified or removed at any time.\n To use this endpoint, add `preview=true` to the request query parameters.\n:::\n\nSearch for objects in the specified ontology and interface type. Any properties specified in the \"where\" or \n\"orderBy\" parameters must be shared property type API names defined on the interface. The following search \nqueries are supported:\n\n| Query type | Description | Supported Types |\n|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------|\n| lt | The provided property is less than the provided value. | number, string, date, timestamp |\n| gt | The provided property is greater than the provided value. | number, string, date, timestamp |\n| lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp |\n| gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp |\n| eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp |\n| isNull | The provided property is (or is not) null. | all |\n| contains | The provided property contains the provided value. | array |\n| not | The sub-query does not match. | N/A (applied on a query) |\n| and | All the sub-queries match. | N/A (applied on queries) |\n| or | At least one of the sub-queries match. | N/A (applied on queries) |\n| startsWith | The provided property starts with the provided value. | string |\n| containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string |\n| containsAllTermsInOrder | The provided property contains the provided value as a substring. | string |\n| containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string |\n| containsAllTerms | The provided property contains all the terms separated by whitespace. | string | \n\nAttempting to use an unsupported query will result in a validation error. Third-party applications using this \nendpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" + operationId: searchObjectsForInterface + x-operationVerb: search + x-auditCategory: ontologyDataSearch + x-releaseStage: PRIVATE_BETA security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. - in: path - name: ontologyRid - required: true - schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - - description: | - The API name of the object from which the links originate. To find the API name, use the **List object types** endpoint or + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object from which the links originate. To look up the expected primary key for your - object type, use the `Get object type` endpoint or the **Ontology Manager**. - in: path - name: primaryKey + name: ontology required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the link that exists between the object and the requested objects. - To find the API name for your link type, check the **Ontology Manager**. + The API name of the interface type. To find the API name, use the **List interface types** endpoint or + check the **Ontology Manager**. in: path - name: linkType + name: interfaceType required: true schema: - $ref: "#/components/schemas/LinkTypeApiName" - example: directReport - - description: | - The desired size of the page to be returned. Defaults to 1,000. - See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - in: query - name: pageSize - required: false - schema: - $ref: "#/components/schemas/PageSize" - - in: query - name: pageToken - required: false - schema: - $ref: "#/components/schemas/PageToken" + $ref: "#/components/schemas/InterfaceTypeApiName" + example: Employee - description: | - The properties of the object type that should be included in the response. Omit this parameter to get all - the properties. + A boolean flag that, when set to true, enables the use of beta features in preview mode. in: query - name: properties - schema: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - - in: query - name: orderBy + name: preview required: false schema: - $ref: "#/components/schemas/OrderBy" + $ref: "#/components/schemas/PreviewMode" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SearchObjectsForInterfaceRequest" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListLinkedObjectsResponse" + $ref: "#/components/schemas/SearchObjectsResponseV2" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - rid: ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136 - properties: - id: 80060 - firstName: Anna - lastName: Smith - - rid: ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136 - properties: - id: 51060 - firstName: James - lastName: Matthews + - __rid: ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb + __primaryKey: 1000 + __apiName: Employee + employeeId: 1000 + lastName: smith + firstName: john + age: 21 description: Success response. - /api/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}: - get: - description: | - Get a specific linked object that originates from another object. If there is no link between the two objects, - LinkedObjectNotFound is thrown. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getLinkedObject - x-operationVerb: getLinkedObject - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE + /api/v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate: + post: + description: ":::callout{theme=warning title=Warning}\n This endpoint is in preview and may be modified or removed at any time.\n To use this endpoint, add `preview=true` to the request query parameters.\n:::\n\nPerform functions on object fields in the specified ontology and of the specified interface type. Any \nproperties specified in the query must be shared property type API names defined on the interface.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" + operationId: aggregateObjectsForInterface + x-operationVerb: aggregate + x-auditCategory: ontologyDataSearch + x-releaseStage: PRIVATE_BETA security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. - in: path - name: ontologyRid - required: true - schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - - description: "The API name of the object from which the links originate. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**." - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object from which the link originates. To look up the expected primary key for your - object type, use the `Get object type` endpoint or the **Ontology Manager**. - in: path - name: primaryKey - required: true - schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 - - description: | - The API name of the link that exists between the object and the requested objects. - To find the API name for your link type, check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: linkType + name: ontology required: true schema: - $ref: "#/components/schemas/LinkTypeApiName" - example: directReport + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The primary key of the requested linked object. To look up the expected primary key for your object type, - use the `Get object type` endpoint (passing the linked object type) or the **Ontology Manager**. + The API name of the interface type. To find the API name, use the **List interface types** endpoint or + check the **Ontology Manager**. in: path - name: linkedObjectPrimaryKey + name: interfaceType required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 80060 + $ref: "#/components/schemas/InterfaceTypeApiName" + example: Employee - description: | - The properties of the object type that should be included in the response. Omit this parameter to get all - the properties. + A boolean flag that, when set to true, enables the use of beta features in preview mode. in: query - name: properties + name: preview + required: false schema: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" + $ref: "#/components/schemas/PreviewMode" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/AggregateObjectsRequestV2" + example: + aggregation: + - type: min + field: properties.tenure + name: min_tenure + - type: avg + field: properties.tenure + name: avg_tenure + query: + not: + field: name + eq: john + groupBy: + - field: startDate + type: range + ranges: + - startValue: 2020-01-01 + endValue: 2020-06-01 + - field: city + type: exact responses: "200": content: application/json: schema: - $ref: "#/components/schemas/OntologyObject" + $ref: "#/components/schemas/AggregateObjectsResponseV2" example: - rid: ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136 - properties: - id: 80060 - firstName: Anna - lastName: Smith + data: + - metrics: + - name: min_tenure + value: 1 + - name: avg_tenure + value: 3 + group: + startDate: + startValue: 2020-01-01 + endValue: 2020-06-01 + city: New York City + - metrics: + - name: min_tenure + value: 2 + - name: avg_tenure + value: 3 + group: + startDate: + startValue: 2020-01-01 + endValue: 2020-06-01 + city: San Francisco description: Success response. - /api/v1/ontologies/{ontologyRid}/actions/{actionType}/apply: - post: - description: | - Applies an action using the given parameters. Changes to the Ontology are eventually consistent and may take - some time to be visible. - - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by - this endpoint. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read api:ontologies-write`. - operationId: applyAction - x-operationVerb: apply - x-auditCategory: ontologyDataTransform + /api/v2/ontologies/{ontology}/queryTypes: + get: + description: "Lists the query types for the given Ontology. \n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response. \n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" + operationId: listQueryTypesV2 + x-operationVerb: list + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - - api:ontologies-write - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the action to apply. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. - in: path - name: actionType - required: true + The desired size of the page to be returned. Defaults to 100. + See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + in: query + name: pageSize + required: false schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ApplyActionRequest" - example: - parameters: - id: 80060 - newName: Anna Smith-Doe + $ref: "#/components/schemas/PageSize" + - in: query + name: pageToken + required: false + schema: + $ref: "#/components/schemas/PageToken" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ApplyActionResponse" - example: {} + $ref: "#/components/schemas/ListQueryTypesResponseV2" + example: + nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv + data: + - apiName: getEmployeesInCity + displayName: Get Employees in City + description: Gets all employees in a given city + parameters: + city: + dataType: + type: string + description: The city to search for employees in + required: true + output: + dataType: + type: array + required: true + subType: + type: object + objectApiName: Employee + required: true + rid: ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b + version: 1.1.3-rc1 + - apiName: getAverageTenureOfEmployees + displayName: Get Average Tenure + description: Gets the average tenure of all employees + parameters: + employees: + dataType: + type: string + description: An object set of the employees to calculate the average tenure of + required: true + useMedian: + dataType: + type: boolean + description: "An optional flag to use the median instead of the mean, defaults to false" + required: false + output: + dataType: + type: double + required: true + rid: ri.function-registry.main.function.9549c29d3-e92f-64a1-beeb-af817819a400 + version: 2.1.1 description: Success response. - /api/v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch: - post: + /api/v2/ontologies/{ontology}/queryTypes/{queryApiName}: + get: description: | - Applies multiple actions (of the same Action Type) using the given parameters. - Changes to the Ontology are eventually consistent and may take some time to be visible. - - Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not - call Functions may receive a higher limit. - - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) and - [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. + Gets a specific query type with the given API name. - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read api:ontologies-write`. - operationId: applyActionBatch - x-operationVerb: applyBatch - x-auditCategory: ontologyDataTransform + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getQueryTypeV2 + x-operationVerb: get + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - - api:ontologies-write - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the action to apply. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. + The API name of the query type. To find the API name, use the **List query types** endpoint or + check the **Ontology Manager**. in: path - name: actionType + name: queryApiName required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/BatchApplyActionRequest" - example: - requests: - - parameters: - id: 80060 - newName: Anna Smith-Doe - - parameters: - id: 80061 - newName: Joe Bloggs + $ref: "#/components/schemas/QueryApiName" + example: getEmployeesInCity responses: "200": content: application/json: schema: - $ref: "#/components/schemas/BatchApplyActionResponse" - example: {} + $ref: "#/components/schemas/QueryTypeV2" + example: + apiName: getEmployeesInCity + displayName: Get Employees in City + description: Gets all employees in a given city + parameters: + city: + dataType: + type: string + description: The city to search for employees in + required: true + output: + dataType: + type: array + subType: + type: object + objectApiName: Employee + required: true + rid: ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b + version: 1.1.3-rc1 description: Success response. - /api/v1/ontologies/{ontologyRid}/actions/{actionType}/applyAsync: + /api/v2/ontologies/{ontology}/queries/{queryApiName}/execute: post: - description: | - Applies an action asynchronously using the given parameters. Changes to the Ontology are eventually consistent - and may take some time to be visible. - - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently - supported by this endpoint. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read api:ontologies-write`. - operationId: applyActionAsync - x-operationVerb: applyAsync - x-auditCategory: ontologyDataTransform - x-releaseStage: PRIVATE_BETA + description: "Executes a Query using the given parameters.\n\nOptional parameters do not need to be supplied.\n\nThird-party applications using this endpoint via OAuth2 must request the \nfollowing operation scopes: `api:ontologies-read`.\n" + operationId: executeQueryV2 + x-operationVerb: execute + x-auditCategory: ontologyDataLoad + x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - - api:ontologies-write - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the action to apply. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. + The API name of the Query to execute. in: path - name: actionType + name: queryApiName required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee + $ref: "#/components/schemas/QueryApiName" + example: getEmployeesInCity - description: | - Represents a boolean value that restricts an endpoint to preview mode when set to true. + The repository associated with a marketplace installation. in: query - name: preview + name: artifactRepository required: false schema: - $ref: "#/components/schemas/PreviewMode" - example: true + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" requestBody: content: application/json: schema: - $ref: "#/components/schemas/AsyncApplyActionRequest" + $ref: "#/components/schemas/ExecuteQueryRequest" example: parameters: - id: 80060 - newName: Anna Smith-Doe + city: New York responses: - "202": + "200": content: application/json: schema: - $ref: "#/components/schemas/AsyncActionOperation" + $ref: "#/components/schemas/ExecuteQueryResponse" example: - data: - - id: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - operationType: applyActionAsync - status: RUNNING - stage: RUNNING_SUBMISSION_CHECKS + value: + - EMP546 + - EMP609 + - EMP989 description: Success response. - /api/v1/ontologies/{ontologyRid}/actions/{actionType}/applyAsync/{actionRid}: + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}: get: - operationId: getAsyncActionStatus - x-operationVerb: getOperationStatus - x-auditCategory: ontologyMetaDataLoad - x-releaseStage: PRIVATE_BETA + description: | + Lists the linked objects for a specific object and the given link type. + + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listLinkedObjectsV2 + x-operationVerb: listLinkedObjects + x-auditCategory: ontologyDataLoad + x-releaseStage: STABLE security: - - BearerAuth: + - OAuth2: - api:ontologies-read - - api:ontologies-write + - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the action to apply. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. in: path - name: actionType - required: true - schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee - - in: path - name: actionRid + name: objectType required: true schema: - $ref: "#/components/schemas/ActionRid" + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee - description: | - Represents a boolean value that restricts an endpoint to preview mode when set to true. - in: query - name: preview - required: false + The primary key of the object from which the links originate. To look up the expected primary key for your + object type, use the `Get object type` endpoint or the **Ontology Manager**. + in: path + name: primaryKey + required: true schema: - $ref: "#/components/schemas/PreviewMode" - example: true - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/AsyncActionOperation" - example: - id: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - operationType: applyActionAsync - status: SUCCESSFUL - result: - type: success - description: Success response - /api/v1/ontologies/{ontologyRid}/queryTypes: - get: - description: | - Lists the query types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listQueryTypes - x-operationVerb: list - x-auditCategory: ontologyMetaDataLoad - x-releaseStage: STABLE - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 - description: | - The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the link that exists between the object and the requested objects. + To find the API name for your link type, check the **Ontology Manager**. in: path - name: ontologyRid + name: linkType required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/LinkTypeApiName" + example: directReport - description: | - The desired size of the page to be returned. Defaults to 100. + The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query name: pageSize @@ -8503,51 +8771,73 @@ paths: required: false schema: $ref: "#/components/schemas/PageToken" + - description: | + The properties of the object type that should be included in the response. Omit this parameter to get all + the properties. + in: query + name: select + schema: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" + - in: query + name: orderBy + required: false + schema: + $ref: "#/components/schemas/OrderBy" + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + - description: "A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n" + in: query + name: excludeRid + schema: + type: boolean + x-safety: safe responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListQueryTypesResponse" + $ref: "#/components/schemas/ListLinkedObjectsResponseV2" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - apiName: getEmployeesInCity - displayName: Get Employees in City - description: Gets all employees in a given city - parameters: - city: - baseType: String - description: The city to search for employees in - required: true - output: Array> - rid: ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b - version: 1.1.3-rc1 - - apiName: getAverageTenureOfEmployees - displayName: Get Average Tenure - description: Gets the average tenure of all employees - parameters: - employees: - baseType: String - description: An object set of the employees to calculate the average tenure of - required: true - useMedian: - baseType: Boolean - description: "An optional flag to use the median instead of the mean, defaults to false" - required: false - output: Double - rid: ri.function-registry.main.function.9549c29d3-e92f-64a1-beeb-af817819a400 - version: 2.1.1 + - __rid: ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136 + __primaryKey: 80060 + __apiName: Employee + id: 80060 + firstName: Anna + lastName: Smith + - __rid: ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136 + __primaryKey: 51060 + __apiName: Employee + id: 51060 + firstName: James + lastName: Matthews description: Success response. - /api/v1/ontologies/{ontologyRid}/queryTypes/{queryApiName}: + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}: get: description: | - Gets a specific query type with the given API name. + Get a specific linked object that originates from another object. + + If there is no link between the two objects, `LinkedObjectNotFound` is thrown. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getQueryType - x-operationVerb: get - x-auditCategory: ontologyMetaDataLoad + operationId: getLinkedObjectV2 + x-operationVerb: getLinkedObject + x-auditCategory: ontologyDataLoad x-releaseStage: STABLE security: - OAuth2: @@ -8555,181 +8845,181 @@ paths: - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the query type. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the query type. To find the API name, use the **List query types** endpoint or + The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. in: path - name: queryApiName + name: objectType required: true schema: - $ref: "#/components/schemas/QueryApiName" - example: getEmployeesInCity - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/QueryType" - example: - apiName: getEmployeesInCity - displayName: Get Employees in City - description: Gets all employees in a given city - parameters: - city: - baseType: String - description: The city to search for employees in - required: true - output: Array> - rid: ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b - version: 1.1.3-rc1 - description: Success response. - /api/v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute: - post: - description: | - Executes a Query using the given parameters. Optional parameters do not need to be supplied. - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: executeQuery - x-operationVerb: execute - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee - description: | - The unique Resource Identifier (RID) of the Ontology that contains the Query. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The primary key of the object from which the links originate. To look up the expected primary key for your + object type, use the `Get object type` endpoint or the **Ontology Manager**. in: path - name: ontologyRid + name: primaryKey required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 - description: | - The API name of the Query to execute. + The API name of the link that exists between the object and the requested objects. + To find the API name for your link type, check the **Ontology Manager**. in: path - name: queryApiName + name: linkType required: true schema: - $ref: "#/components/schemas/QueryApiName" - example: getEmployeesInCity - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ExecuteQueryRequest" - example: - parameters: - city: New York + $ref: "#/components/schemas/LinkTypeApiName" + example: directReport + - description: | + The primary key of the requested linked object. To look up the expected primary key for your object type, + use the `Get object type` endpoint (passing the linked object type) or the **Ontology Manager**. + in: path + name: linkedObjectPrimaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 80060 + - description: | + The properties of the object type that should be included in the response. Omit this parameter to get all + the properties. + in: query + name: select + schema: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + - description: "A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n" + in: query + name: excludeRid + schema: + type: boolean + x-safety: safe responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ExecuteQueryResponse" + $ref: "#/components/schemas/OntologyObjectV2" example: - value: - - EMP546 - - EMP609 - - EMP989 + __rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 + __primaryKey: 50030 + __apiName: Employee + id: 50030 + firstName: John + lastName: Doe description: Success response. - /api/v1/ontologies/{ontologyRid}/objects/{objectType}/search: - post: + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}: + get: description: | - Search for objects in the specified ontology and object type. The request body is used - to filter objects based on the specified query. The supported queries are: - - | Query type | Description | Supported Types | - |----------|-----------------------------------------------------------------------------------|---------------------------------| - | lt | The provided property is less than the provided value. | number, string, date, timestamp | - | gt | The provided property is greater than the provided value. | number, string, date, timestamp | - | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp | - | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp | - | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp | - | isNull | The provided property is (or is not) null. | all | - | contains | The provided property contains the provided value. | array | - | not | The sub-query does not match. | N/A (applied on a query) | - | and | All the sub-queries match. | N/A (applied on queries) | - | or | At least one of the sub-queries match. | N/A (applied on queries) | - | prefix | The provided property starts with the provided value. | string | - | phrase | The provided property contains the provided value as a substring. | string | - | anyTerm | The provided property contains at least one of the terms separated by whitespace. | string | - | allTerms | The provided property contains all the terms separated by whitespace. | string | | - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: searchObjects - x-operationVerb: search - x-auditCategory: ontologyDataSearch + Get the metadata of attachments parented to the given object. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: listPropertyAttachments + x-operationVerb: getAttachment + x-auditCategory: metaDataAccess x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - - description: The unique Resource Identifier (RID) of the Ontology that contains the objects. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - - description: The type of the requested objects. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. in: path name: objectType required: true schema: $ref: "#/components/schemas/ObjectTypeApiName" example: employee - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SearchObjectsRequest" - example: - query: - not: - field: properties.age - eq: 21 + - description: | + The primary key of the object containing the attachment. + in: path + name: primaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The API name of the attachment property. To find the API name for your attachment, + check the **Ontology Manager** or use the **Get object type** endpoint. + in: path + name: property + required: true + schema: + $ref: "#/components/schemas/PropertyApiName" + example: performance + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/SearchObjectsResponse" + $ref: "#/components/schemas/AttachmentMetadataResponse" example: - data: - - properties: - lastName: smith - firstName: john - age: 21 - rid: ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb + type: single + rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + filename: My Image.jpeg + sizeBytes: 393469 + mediaType: image/jpeg description: Success response. - /api/v1/ontologies/{ontologyRid}/actions/{actionType}/validate: - post: + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}: + get: description: | - Validates if an action can be run with the given set of parameters. - The response contains the evaluation of parameters and **submission criteria** - that determine if the request is `VALID` or `INVALID`. - For performance reasons, validations will not consider existing objects or other data in Foundry. - For example, the uniqueness of a primary key or the existence of a user ID will not be checked. - Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by - this endpoint. Unspecified parameters will be given a default value of `null`. + Get the metadata of a particular attachment in an attachment list. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read`. - operationId: validateAction - x-operationVerb: validate - x-auditCategory: ontologyLogicAccess + operationId: getAttachmentPropertyByRidV2 + x-operationVerb: getAttachmentByRid + x-auditCategory: metaDataAccess x-releaseStage: STABLE security: - OAuth2: @@ -8737,198 +9027,157 @@ paths: - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager**. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the action to validate. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. in: path - name: actionType + name: objectType required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ValidateActionRequest" - example: - parameters: - id: 2 - firstName: Chuck - lastName: Jones - age: 17 - date: 2021-05-01 - numbers: - - 1 - - 2 - - 3 - hasObjectSet: true - objectSet: ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623 - reference: Chuck - percentage: 41.3 - differentObjectId: 2 + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The primary key of the object containing the attachment. + in: path + name: primaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The API name of the attachment property. To find the API name for your attachment, + check the **Ontology Manager** or use the **Get object type** endpoint. + in: path + name: property + required: true + schema: + $ref: "#/components/schemas/PropertyApiName" + example: performance + - description: The RID of the attachment. + name: attachmentRid + in: path + required: true + schema: + $ref: "#/components/schemas/AttachmentRid" + example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" responses: "200": content: - application/json: - schema: - $ref: "#/components/schemas/ValidateActionResponse" - example: - result: INVALID - submissionCriteria: - - configuredFailureMessage: First name can not match the first name of the referenced object. - result: INVALID - parameters: - age: - result: INVALID - evaluatedConstraints: - - type: range - gte: 18 - required: true - id: - result: VALID - evaluatedConstraints: [] - required: true - date: - result: VALID - evaluatedConstraints: [] - required: true - lastName: - result: VALID - evaluatedConstraints: - - type: oneOf - options: - - displayName: Doe - value: Doe - - displayName: Smith - value: Smith - - displayName: Adams - value: Adams - - displayName: Jones - value: Jones - otherValuesAllowed: true - required: true - numbers: - result: VALID - evaluatedConstraints: - - type: arraySize - lte: 4 - gte: 2 - required: true - differentObjectId: - result: VALID - evaluatedConstraints: - - type: objectPropertyValue - required: false - firstName: - result: VALID - evaluatedConstraints: [] - required: true - reference: - result: VALID - evaluatedConstraints: - - type: objectQueryResult - required: false - percentage: - result: VALID - evaluatedConstraints: - - type: range - lt: 100 - gte: 0 - required: true - objectSet: - result: VALID - evaluatedConstraints: [] - required: true - attachment: - result: VALID - evaluatedConstraints: [] - required: false - hasObjectSet: - result: VALID - evaluatedConstraints: [] - required: false - multipleAttachments: - result: VALID - evaluatedConstraints: - - type: arraySize - gte: 0 - required: false + application/json: + schema: + $ref: "#/components/schemas/AttachmentV2" + example: + rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + filename: My Image.jpeg + sizeBytes: 393469 + mediaType: image/jpeg description: Success response. - /api/v1/attachments/upload: - post: + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content: + get: description: | - Upload an attachment to use in an action. Any attachment which has not been linked to an object via - an action within one hour after upload will be removed. - Previously mapped attachments which are not connected to any object anymore are also removed on - a biweekly basis. - The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. + Get the content of an attachment. Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-write`. - operationId: uploadAttachment - x-operationVerb: upload - x-auditCategory: dataCreate + following operation scopes: `api:ontologies-read`. + operationId: getAttachmentPropertyContentV2 + x-operationVerb: readAttachment + x-auditCategory: dataExport x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-write + - api:ontologies-read - BearerAuth: [] parameters: - - description: The size in bytes of the file content being uploaded. - in: header - name: Content-Length + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. + in: path + name: ontology required: true schema: - $ref: "#/components/schemas/ContentLength" - - description: The media type of the file being uploaded. - in: header - name: Content-Type + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. + in: path + name: objectType required: true schema: - $ref: "#/components/schemas/ContentType" - - description: The name of the file being uploaded. - in: query - name: filename + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The primary key of the object containing the attachment. + in: path + name: primaryKey required: true schema: - $ref: "#/components/schemas/Filename" - example: My Image.jpeg - requestBody: - content: - '*/*': - schema: - format: binary - type: string + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The API name of the attachment property. To find the API name for your attachment, + check the **Ontology Manager** or use the **Get object type** endpoint. + in: path + name: property + required: true + schema: + $ref: "#/components/schemas/PropertyApiName" + example: performance + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" responses: "200": content: - application/json: + '*/*': schema: - $ref: "#/components/schemas/Attachment" - example: - rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - filename: My Image.jpeg - sizeBytes: 393469 - mediaType: image/jpeg + format: binary + type: string description: Success response. - /api/v1/attachments/{attachmentRid}/content: + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content: get: description: | - Get the content of an attachment. + Get the content of an attachment by its RID. + + The RID must exist in the attachment array of the property. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read`. - operationId: getAttachmentContent - x-operationVerb: read + operationId: getAttachmentPropertyContentByRidV2 + x-operationVerb: readAttachmentByRid x-auditCategory: dataExport x-releaseStage: STABLE security: @@ -8936,13 +9185,62 @@ paths: - api:ontologies-read - BearerAuth: [] parameters: - - description: The RID of the attachment. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. + in: path + name: ontology + required: true + schema: + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. + in: path + name: objectType + required: true + schema: + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The primary key of the object containing the attachment. + in: path + name: primaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The API name of the attachment property. To find the API name for your attachment, + check the **Ontology Manager** or use the **Get object type** endpoint. in: path + name: property + required: true + schema: + $ref: "#/components/schemas/PropertyApiName" + example: performance + - description: The RID of the attachment. name: attachmentRid + in: path required: true schema: $ref: "#/components/schemas/AttachmentRid" example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" responses: "200": content: @@ -8951,748 +9249,1052 @@ paths: format: binary type: string description: Success response. - /api/v1/attachments/{attachmentRid}: + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint: get: description: | - Get the metadata of an attachment. + Get the first point of a time series property. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read`. - operationId: getAttachment - x-operationVerb: get - x-auditCategory: metaDataAccess + operationId: getFirstPoint + x-operationVerb: getFirstPoint + x-auditCategory: ontologyDataLoad x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - - description: The RID of the attachment. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. + in: path + name: ontology + required: true + schema: + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. + in: path + name: objectType + required: true + schema: + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The primary key of the object with the time series property. + in: path + name: primaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The API name of the time series property. To find the API name for your time series property, + check the **Ontology Manager** or use the **Get object type** endpoint. + in: path + name: property + required: true + schema: + $ref: "#/components/schemas/PropertyApiName" + example: performance + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/TimeSeriesPoint" + description: Success response. + "204": + description: No Content + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint: + get: + description: | + Get the last point of a time series property. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: getLastPoint + x-operationVerb: getLastPoint + x-auditCategory: ontologyDataLoad + x-releaseStage: STABLE + security: + - OAuth2: + - api:ontologies-read + - BearerAuth: [] + parameters: + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. + in: path + name: ontology + required: true + schema: + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. in: path - name: attachmentRid + name: objectType required: true schema: - $ref: "#/components/schemas/AttachmentRid" - example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The primary key of the object with the time series property. + in: path + name: primaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The API name of the time series property. To find the API name for your time series property, + check the **Ontology Manager** or use the **Get object type** endpoint. + in: path + name: property + required: true + schema: + $ref: "#/components/schemas/PropertyApiName" + example: performance + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/Attachment" - example: - rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - filename: My Image.jpeg - sizeBytes: 393469 - mediaType: image/jpeg + $ref: "#/components/schemas/TimeSeriesPoint" description: Success response. - /api/v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate: + "204": + description: No Content + /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints: post: description: | - Perform functions on object fields in the specified ontology and object type. + Stream all of the points of a time series property. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: aggregateObjects - x-operationVerb: aggregate - x-auditCategory: ontologyDataSearch + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: streamPoints + x-operationVerb: streamPoints + x-auditCategory: ontologyDataLoad x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - - description: The unique Resource Identifier (RID) of the Ontology that contains the objects. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - - description: The type of the object to aggregate on. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. in: path name: objectType required: true schema: $ref: "#/components/schemas/ObjectTypeApiName" example: employee + - description: | + The primary key of the object with the time series property. + in: path + name: primaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The API name of the time series property. To find the API name for your time series property, + check the **Ontology Manager** or use the **Get object type** endpoint. + in: path + name: property + required: true + schema: + $ref: "#/components/schemas/PropertyApiName" + example: null + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" requestBody: content: application/json: schema: - $ref: "#/components/schemas/AggregateObjectsRequest" + $ref: "#/components/schemas/StreamTimeSeriesPointsRequest" example: - aggregation: - - type: min - field: properties.tenure - name: min_tenure - - type: avg - field: properties.tenure - name: avg_tenure - query: - not: - field: properties.name - eq: john - groupBy: - - field: properties.startDate - type: range - ranges: - - gte: 2020-01-01 - lt: 2020-06-01 - - field: properties.city - type: exact + range: + type: relative + startTime: + when: BEFORE + value: 5 + unit: MONTHS + endTime: + when: BEFORE + value: 1 + unit: MONTHS responses: "200": content: - application/json: + '*/*': schema: - $ref: "#/components/schemas/AggregateObjectsResponse" + format: binary + type: string example: data: - - metrics: - - name: min_tenure - value: 1 - - name: avg_tenure - value: 3 - group: - properties.startDate: - gte: 2020-01-01 - lt: 2020-06-01 - properties.city: New York City - - metrics: - - name: min_tenure - value: 2 - - name: avg_tenure - value: 3 - group: - properties.startDate: - gte: 2020-01-01 - lt: 2020-06-01 - properties.city: San Francisco + - time: 2020-03-06T12:00:00Z + value: 48.5 + - time: 2020-03-06T13:00:00Z + value: 75.01 + - time: 2020-03-06T14:00:00Z + value: 31.33 description: Success response. - /api/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes: - get: - description: | - List the outgoing links for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: listOutgoingLinkTypes - x-operationVerb: listOutgoingLinkTypes - x-auditCategory: ontologyMetaDataLoad + /api/v2/ontologies/{ontology}/actions/{action}/apply: + post: + description: "Applies an action using the given parameters. \n\nChanges to the Ontology are eventually consistent and may take some time to be visible.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint.\n\nThird-party applications using this endpoint via OAuth2 must request the\nfollowing operation scopes: `api:ontologies-read api:ontologies-write`.\n" + operationId: applyActionV2 + x-operationVerb: apply + x-auditCategory: ontologyDataTransform x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read + - api:ontologies-write - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager** application. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager** application. + The API name of the action to apply. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. in: path - name: objectType + name: action required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: Flight - - description: The desired size of the page to be returned. + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee + - description: | + The repository associated with a marketplace installation. in: query - name: pageSize + name: artifactRepository required: false schema: - $ref: "#/components/schemas/PageSize" - - in: query - name: pageToken + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName required: false schema: - $ref: "#/components/schemas/PageToken" + $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ApplyActionRequestV2" + example: + parameters: + id: 80060 + newName: Anna Smith-Doe responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListOutgoingLinkTypesResponse" + $ref: "#/components/schemas/SyncApplyActionResponseV2" example: - nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv - data: - - apiName: originAirport - objectTypeApiName: Airport - cardinality: ONE - foreignKeyPropertyApiName: originAirportId + validation: + result: VALID + parameters: + id: + evaluatedConstraints: [] + result: VALID + required: true + newName: + evaluatedConstraints: [] + result: VALID + required: true description: Success response. - /api/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}: - get: + /api/v2/ontologies/{ontology}/actions/{action}/applyBatch: + post: description: | - Get an outgoing link for an object type. + Applies multiple actions (of the same Action Type) using the given parameters. + Changes to the Ontology are eventually consistent and may take some time to be visible. + + Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not + call Functions may receive a higher limit. + + Note that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: getOutgoingLinkType - x-operationVerb: getOutgoingLinkType - x-auditCategory: ontologyMetaDataLoad + following operation scopes: `api:ontologies-read api:ontologies-write`. + operationId: applyActionBatchV2 + x-operationVerb: applyBatch + x-auditCategory: ontologyDataTransform x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read + - api:ontologies-write - BearerAuth: [] parameters: - description: | - The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the - **List ontologies** endpoint or check the **Ontology Manager** application. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: ontologyRid + name: ontology required: true schema: - $ref: "#/components/schemas/OntologyRid" - example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager** application. + The API name of the action to apply. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. in: path - name: objectType + name: action required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: Employee + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee - description: | - The API name of the outgoing link. - To find the API name for your link type, check the **Ontology Manager**. - in: path - name: linkType - required: true + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false schema: - $ref: "#/components/schemas/LinkTypeApiName" - example: directReport + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/BatchApplyActionRequestV2" + example: + requests: + - parameters: + id: 80060 + newName: Anna Smith-Doe + - parameters: + id: 80061 + newName: Joe Bloggs responses: "200": content: application/json: schema: - $ref: "#/components/schemas/LinkTypeSide" - example: - apiName: directReport - objectTypeApiName: Employee - cardinality: MANY + $ref: "#/components/schemas/BatchApplyActionResponseV2" + example: {} description: Success response. - /api/v1/datasets: + /api/v2/ontologies/{ontology}/actions/{action}/applyAsync: post: - description: | - Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - operationId: createDataset - x-operationVerb: create - x-auditCategory: metaDataCreate - x-releaseStage: STABLE + description: "Applies an action using the given parameters. \n\nChanges to the Ontology are eventually consistent and may take some time to be visible.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint.\n\nThird-party applications using this endpoint via OAuth2 must request the\nfollowing operation scopes: `api:ontologies-read api:ontologies-write`.\n" + operationId: applyActionAsyncV2 + x-operationVerb: applyAsync + x-auditCategory: ontologyDataTransform + x-releaseStage: PRIVATE_BETA security: - OAuth2: - - api:datasets-write + - api:ontologies-read + - api:ontologies-write - BearerAuth: [] + parameters: + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. + in: path + name: ontology + required: true + schema: + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the action to apply. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. + in: path + name: action + required: true + schema: + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" requestBody: content: application/json: schema: - $ref: "#/components/schemas/CreateDatasetRequest" + $ref: "#/components/schemas/AsyncApplyActionRequestV2" example: - name: My Dataset - parentFolderRid: ri.foundry.main.folder.bfe58487-4c56-4c58-aba7-25defd6163c4 + parameters: + id: 80060 + newName: Anna Smith-Doe responses: "200": content: application/json: schema: - $ref: "#/components/schemas/Dataset" + $ref: "#/components/schemas/AsyncApplyActionResponseV2" example: - rid: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - path: /Empyrean Airlines/My Important Project/My Dataset - description: "" - /api/v1/datasets/{datasetRid}: - get: - description: | - Gets the Dataset with the given DatasetRid. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - operationId: getDataset - x-operationVerb: get - x-auditCategory: metaDataAccess - x-releaseStage: STABLE + operationId: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + description: Success response. + /api/v2/ontologies/{ontology}/objectSets/createTemporary: + post: + description: "Creates a temporary `ObjectSet` from the given definition. \n\nThird-party applications using this endpoint via OAuth2 must request the\nfollowing operation scopes: `api:ontologies-read api:ontologies-write`.\n" + operationId: createTemporaryObjectSetV2 + x-operationVerb: createTemporary + x-auditCategory: ontologyLogicCreate + x-releaseStage: PRIVATE_BETA security: - OAuth2: - - api:datasets-read + - api:ontologies-read + - api:ontologies-write - BearerAuth: [] parameters: - - in: path - name: datasetRid + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. + in: path + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/CreateTemporaryObjectSetRequestV2" + example: + objectSet: + type: base + objectType: Employee responses: "200": + description: Success response. content: application/json: schema: - $ref: "#/components/schemas/Dataset" + $ref: "#/components/schemas/CreateTemporaryObjectSetResponseV2" example: - rid: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - name: My Dataset - parentFolderRid: ri.foundry.main.folder.bfe58487-4c56-4c58-aba7-25defd6163c4 - description: "" - /api/v1/datasets/{datasetRid}/readTable: + objectSetRid: ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053 + /api/v2/ontologies/{ontology}/objectSets/{objectSetRid}: get: - description: | - Gets the content of a dataset as a table in the specified format. - - This endpoint currently does not support views (Virtual datasets composed of other datasets). - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - operationId: readTable - x-operationVerb: read - x-auditCategory: dataExport - x-releaseStage: STABLE - security: - - OAuth2: - - api:datasets-read - - BearerAuth: [] + description: "Gets the definition of the `ObjectSet` with the given RID. \n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" + operationId: getObjectSetV2 + x-operationVerb: get + x-auditCategory: ontologyLogicAccess + x-releaseStage: PRIVATE_BETA parameters: - description: | - The RID of the Dataset. + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - - description: The identifier (name) of the Branch. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - description: The Resource Identifier (RID) of the start Transaction. - in: query - name: startTransactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" - - description: The Resource Identifier (RID) of the end Transaction. - in: query - name: endTransactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The export format. Must be `ARROW` or `CSV`. - in: query - name: format + The RID of the object set. + in: path + name: objectSetRid required: true schema: - $ref: "#/components/schemas/TableExportFormat" - example: CSV - - description: | - A subset of the dataset columns to include in the result. Defaults to all columns. - in: query - name: columns - required: false - schema: - type: array - items: - type: string - x-safety: unsafe - - description: | - A limit on the number of rows to return. Note that row ordering is non-deterministic. - in: query - name: rowLimit - required: false - schema: - type: integer - x-safety: unsafe + $ref: "#/components/schemas/ObjectSetRid" + example: ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053 responses: "200": + description: Success response. content: - '*/*': + application/json: schema: - format: binary - type: string - description: The content stream. - /api/v1/datasets/{datasetRid}/branches: + $ref: "#/components/schemas/ObjectSet" + example: + data: + objectSet: + type: base + objectType: Employee + /api/v2/ontologies/{ontology}/objectSets/loadObjects: post: description: | - Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. + Load the ontology objects present in the `ObjectSet` from the provided object set definition. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - operationId: createBranch - x-operationVerb: create - x-auditCategory: metaDataCreate + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: loadObjectSetV2 + x-operationVerb: load + x-auditCategory: ontologyDataLoad x-releaseStage: STABLE security: - OAuth2: - - api:datasets-write + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset on which to create the Branch. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The repository associated with a marketplace installation. + in: query + name: artifactRepository + required: false + schema: + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName + required: false + schema: + $ref: "#/components/schemas/SdkPackageName" requestBody: content: application/json: schema: - $ref: "#/components/schemas/CreateBranchRequest" + $ref: "#/components/schemas/LoadObjectSetRequestV2" example: - branchId: my-branch + objectSet: + type: base + objectType: Employee + pageSize: 10000 + nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv responses: "200": content: application/json: schema: - $ref: "#/components/schemas/Branch" + $ref: "#/components/schemas/LoadObjectSetResponseV2" example: - branchId: my-branch - description: "" - get: - description: | - Lists the Branches of a Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - operationId: listBranches - x-operationVerb: list - x-auditCategory: metaDataAccess + data: + - __rid: ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851 + __primaryKey: 50030 + __apiName: Employee + employeeId: 50030 + firstName: John + lastName: Smith + age: 21 + - __rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 + __primaryKey: 20090 + __apiName: Employee + employeeId: 20090 + firstName: John + lastName: Haymore + age: 27 + description: Success response. + /api/v2/ontologies/{ontology}/objectSets/aggregate: + post: + description: "Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition. \n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" + operationId: aggregateObjectSetV2 + x-operationVerb: aggregate + x-auditCategory: ontologyDataSearch x-releaseStage: STABLE security: - OAuth2: - - api:datasets-read + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset on which to list Branches. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The desired size of the page to be returned. Defaults to 1,000. - See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + The repository associated with a marketplace installation. in: query - name: pageSize + name: artifactRepository required: false schema: - $ref: "#/components/schemas/PageSize" - - in: query - name: pageToken + $ref: "#/components/schemas/ArtifactRepositoryRid" + - description: | + The package name of the generated SDK. + in: query + name: packageName required: false schema: - $ref: "#/components/schemas/PageToken" + $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/AggregateObjectSetRequestV2" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListBranchesResponse" + $ref: "#/components/schemas/AggregateObjectsResponseV2" example: - nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - branchId: master - transactionRid: ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4 - - branchId: test-v2 - transactionRid: ri.foundry.main.transaction.fc9feb4b-34e4-4bfd-9e4f-b6425fbea85f - - branchId: my-branch - description: "" - /api/v1/datasets/{datasetRid}/branches/{branchId}: + - metrics: + - name: min_tenure + value: 1 + - name: avg_tenure + value: 3 + group: + startDate: + startValue: 2020-01-01 + endValue: 2020-06-01 + city: New York City + - metrics: + - name: min_tenure + value: 2 + - name: avg_tenure + value: 3 + group: + startDate: + startValue: 2020-01-01 + endValue: 2020-06-01 + city: San Francisco + description: Success response. + /api/v2/ontologies/{ontology}/objectTypes: get: description: | - Get a Branch of a Dataset. + Lists the object types for the given Ontology. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - operationId: getBranch - x-operationVerb: get - x-auditCategory: metaDataAccess + Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are + more results available, at least one result will be present in the + response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listObjectTypesV2 + x-operationVerb: list + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - - api:datasets-read + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset that contains the Branch. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: The identifier (name) of the Branch. - in: path - name: branchId - required: true + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The desired size of the page to be returned. Defaults to 500. + See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + in: query + name: pageSize + required: false schema: - $ref: "#/components/schemas/BranchId" - example: master + $ref: "#/components/schemas/PageSize" + - in: query + name: pageToken + required: false + schema: + $ref: "#/components/schemas/PageToken" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/Branch" + $ref: "#/components/schemas/ListObjectTypesV2Response" example: - branchId: master - transactionRid: ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4 - description: "" - delete: + nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv + data: + - apiName: employee + description: A full-time or part-time employee of our firm + displayName: Employee + status: ACTIVE + primaryKey: employeeId + properties: + employeeId: + dataType: + type: integer + fullName: + dataType: + type: string + office: + description: The unique ID of the employee's primary assigned office + dataType: + type: string + startDate: + description: "The date the employee was hired (most recently, if they were re-hired)" + dataType: + type: date + rid: ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44 + - apiName: office + description: A physical location (not including rented co-working spaces) + displayName: Office + status: ACTIVE + primaryKey: officeId + properties: + officeId: + dataType: + type: string + address: + description: The office's physical address (not necessarily shipping address) + dataType: + type: string + capacity: + description: The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher) + dataType: + type: integer + rid: ri.ontology.main.object-type.9a0e4409-9b50-499f-a637-a3b8334060d9 + description: Success response. + /api/v2/ontologies/{ontology}/objectTypes/{objectType}: + get: description: | - Deletes the Branch with the given BranchId. + Gets a specific object type with the given API name. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - operationId: deleteBranch - x-operationVerb: delete - x-auditCategory: metaDataDelete + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getObjectTypeV2 + x-operationVerb: get + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - - api:datasets-write + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset that contains the Branch. - in: path - name: datasetRid - required: true - schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: The identifier (name) of the Branch. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: branchId + name: ontology required: true schema: - $ref: "#/components/schemas/BranchId" - example: my-branch - responses: - "204": - description: Branch deleted. - /api/v1/datasets/{datasetRid}/transactions: - post: - description: | - Creates a Transaction on a Branch of a Dataset. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - operationId: createTransaction - x-operationVerb: create - x-auditCategory: metaDataCreate - x-releaseStage: STABLE - security: - - OAuth2: - - api:datasets-write - - BearerAuth: [] - parameters: - - description: The Resource Identifier (RID) of the Dataset on which to create the Transaction. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: objectType required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: | - The identifier (name) of the Branch on which to create the Transaction. Defaults to `master` for most enrollments. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/CreateTransactionRequest" - example: - transactionType: SNAPSHOT + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee responses: "200": content: application/json: schema: - $ref: "#/components/schemas/Transaction" + $ref: "#/components/schemas/ObjectTypeV2" example: - rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 - transactionType: SNAPSHOT - status: OPEN - createdTime: 2022-10-10T12:23:11.152Z - description: "" - /api/v1/datasets/{datasetRid}/transactions/{transactionRid}: + apiName: employee + description: A full-time or part-time employee of our firm + displayName: Employee + status: ACTIVE + primaryKey: employeeId + properties: + employeeId: + dataType: + type: integer + fullName: + dataType: + type: string + office: + description: The unique ID of the employee's primary assigned office + dataType: + type: string + startDate: + description: "The date the employee was hired (most recently, if they were re-hired)" + dataType: + type: date + rid: ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04 + description: Success response. + /api/v2/ontologies/{ontology}/objectTypes/{objectType}/fullMetadata: get: description: | - Gets a Transaction of a Dataset. + Gets the full metadata for a specific object type with the given API name. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. - operationId: getTransaction - x-operationVerb: get - x-auditCategory: metaDataAccess - x-releaseStage: STABLE + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getObjectTypeFullMetadata + x-operationVerb: getFullMetadata + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: PRIVATE_BETA security: - OAuth2: - - api:datasets-read + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset that contains the Transaction. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: The Resource Identifier (RID) of the Transaction. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager**. in: path - name: transactionRid + name: objectType required: true schema: - $ref: "#/components/schemas/TransactionRid" - example: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + A boolean flag that, when set to true, enables the use of beta features in preview mode. + in: query + name: preview + required: false + schema: + $ref: "#/components/schemas/PreviewMode" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/Transaction" - example: - rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 - transactionType: SNAPSHOT - status: OPEN - createdTime: 2022-10-10T12:20:15.166Z - description: "" - /api/v1/datasets/{datasetRid}/transactions/{transactionRid}/commit: - post: + $ref: "#/components/schemas/ObjectTypeFullMetadata" + description: Success response. + /api/v2/ontologies/{ontology}/actionTypes: + get: description: | - Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is - updated to point to the Transaction. + Lists the action types for the given Ontology. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - operationId: commitTransaction - x-operationVerb: commit - x-auditCategory: metaDataUpdate + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listActionTypesV2 + x-operationVerb: list + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - - api:datasets-write + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset that contains the Transaction. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: The Resource Identifier (RID) of the Transaction. - in: path - name: transactionRid - required: true + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The desired size of the page to be returned. Defaults to 500. + See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + in: query + name: pageSize + required: false schema: - $ref: "#/components/schemas/TransactionRid" - example: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 + $ref: "#/components/schemas/PageSize" + - in: query + name: pageToken + required: false + schema: + $ref: "#/components/schemas/PageToken" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/Transaction" + $ref: "#/components/schemas/ListActionTypesResponseV2" example: - rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 - transactionType: SNAPSHOT - status: COMMITTED - createdTime: 2022-10-10T12:20:15.166Z - closedTime: 2022-10-10T12:23:11.152Z - description: "" - /api/v1/datasets/{datasetRid}/transactions/{transactionRid}/abort: - post: + nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv + data: + - apiName: promote-employee + description: Update an employee's title and compensation + parameters: + employeeId: + dataType: + type: integer + newTitle: + dataType: + type: string + newCompensation: + dataType: + type: double + rid: ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167 + - apiName: move-office + description: Update an office's physical location + parameters: + officeId: + dataType: + type: string + newAddress: + description: The office's new physical address (not necessarily shipping address) + dataType: + type: string + newCapacity: + description: The maximum seated-at-desk capacity of the new office (maximum fire-safe capacity may be higher) + dataType: + type: integer + rid: ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2 + description: Success response. + /api/v2/ontologies/{ontology}/actionTypes/{actionType}: + get: description: | - Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is - not updated. + Gets a specific action type with the given API name. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. - operationId: abortTransaction - x-operationVerb: abort - x-auditCategory: metaDataUpdate + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getActionTypeV2 + x-operationVerb: get + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - - api:datasets-write + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset that contains the Transaction. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: The Resource Identifier (RID) of the Transaction. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The name of the action type in the API. in: path - name: transactionRid + name: actionType required: true schema: - $ref: "#/components/schemas/TransactionRid" - example: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 + $ref: "#/components/schemas/ActionTypeApiName" + example: promote-employee responses: "200": content: application/json: schema: - $ref: "#/components/schemas/Transaction" + $ref: "#/components/schemas/ActionTypeV2" example: - rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 - transactionType: SNAPSHOT - status: ABORTED - createdTime: 2022-10-10T12:20:15.166Z - closedTime: 2022-10-10T12:23:11.152Z - description: "" - /api/v1/datasets/{datasetRid}/files: + data: + apiName: promote-employee + description: Update an employee's title and compensation + parameters: + employeeId: + dataType: + type: integer + newTitle: + dataType: + type: string + newCompensation: + dataType: + type: double + rid: ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167 + description: Success response. + /api/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes: get: - description: "Lists Files contained in a Dataset. By default files are listed on the latest view of the default \nbranch - `master` for most enrollments.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\n\nTo **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most\nrecent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the \nbranch if there are no snapshot transactions.\n\nTo **list files on the resolved view of a transaction** specify the Transaction's resource identifier\nas `endTransactionRid`. This will include the most recent version of all files since the latest snapshot\ntransaction, or the earliest ancestor transaction if there are no snapshot transactions.\n\nTo **list files on the resolved view of a range of transactions** specify the the start transaction's resource\nidentifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This\nwill include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`.\nNote that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when \nthe start and end transactions do not belong to the same root-to-leaf path.\n\nTo **list files on a specific transaction** specify the Transaction's resource identifier as both the \n`startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that\nTransaction.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\n" - operationId: listFiles - x-operationVerb: list - x-auditCategory: metaDataAccess + description: | + List the outgoing links for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: listOutgoingLinkTypesV2 + x-operationVerb: listOutgoingLinkTypes + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - - api:datasets-read + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset on which to list Files. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid + name: ontology required: true schema: - $ref: "#/components/schemas/DatasetRid" - - description: The identifier (name) of the Branch on which to list Files. Defaults to `master` for most enrollments. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - description: The Resource Identifier (RID) of the start Transaction. - in: query - name: startTransactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" - - description: The Resource Identifier (RID) of the end Transaction. - in: query - name: endTransactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir - description: | - The desired size of the page to be returned. Defaults to 1,000. - See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager** application. + in: path + name: objectType + required: true + schema: + $ref: "#/components/schemas/ObjectTypeApiName" + example: Flight + - description: The desired size of the page to be returned. in: query name: pageSize required: false @@ -9708,223 +10310,149 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ListFilesResponse" + $ref: "#/components/schemas/ListOutgoingLinkTypesResponseV2" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - path: q3-data/my-file.csv - transactionRid: ri.foundry.main.transaction.bf9515c2-02d4-4703-8f84-c3b3c190254d - sizeBytes: 74930 - updatedTime: 2022-10-10T16:44:55.192Z - - path: q2-data/my-file.csv - transactionRid: ri.foundry.main.transaction.d8db1cfc-9f8b-4bad-9d8c-00bd818a37c5 - sizeBytes: 47819 - updatedTime: 2022-07-12T10:12:50.919Z - - path: q2-data/my-other-file.csv - transactionRid: ri.foundry.main.transaction.d8db1cfc-9f8b-4bad-9d8c-00bd818a37c5 - sizeBytes: 55320 - updatedTime: 2022-07-12T10:12:46.112Z - description: "" - /api/v1/datasets/{datasetRid}/files:upload: - post: - description: "Uploads a File to an existing Dataset.\nThe body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\n\nBy default the file is uploaded to a new transaction on the default branch - `master` for most enrollments.\nIf the file already exists only the most recent version will be visible in the updated view.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. \n\nTo **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will \nbe created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this\ndefault specify `transactionType` in addition to `branchId`. \nSee [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch.\n\nTo **upload a file on a manually opened transaction** specify the Transaction's resource identifier as\n`transactionRid`. This is useful for uploading multiple files in a single transaction. \nSee [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.\n" - operationId: uploadFile - x-operationVerb: upload - x-auditCategory: dataCreate + - apiName: originAirport + objectTypeApiName: Airport + cardinality: ONE + foreignKeyPropertyApiName: originAirportId + description: Success response. + /api/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}: + get: + description: | + Get an outgoing link for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: getOutgoingLinkTypeV2 + x-operationVerb: getOutgoingLinkType + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - - api:datasets-write + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset on which to upload the File. + - description: | + The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + check the **Ontology Manager**. in: path - name: datasetRid - required: true - schema: - $ref: "#/components/schemas/DatasetRid" - - description: The File's path within the Dataset. - in: query - name: filePath + name: ontology required: true schema: - $ref: "#/components/schemas/FilePath" - example: q3-data%2fmy-file.csv - - description: The identifier (name) of the Branch on which to upload the File. Defaults to `master` for most enrollments. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - description: The type of the Transaction to create when using branchId. Defaults to `UPDATE`. - in: query - name: transactionType - required: false - schema: - $ref: "#/components/schemas/TransactionType" - - description: The Resource Identifier (RID) of the open Transaction on which to upload the File. - in: query - name: transactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" - requestBody: - content: - '*/*': - schema: - format: binary - type: string - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/File" - example: - path: q3-data/my-file.csv - transactionRid: ri.foundry.main.transaction.bf9515c2-02d4-4703-8f84-c3b3c190254d - sizeBytes: 74930 - updatedTime: 2022-10-10T16:44:55.192Z - description: "" - /api/v1/datasets/{datasetRid}/files/{filePath}: - get: - description: "Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest\nview of the default branch - `master` for most enrollments.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. \n\nTo **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will \nretrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest\nancestor transaction of the branch if there are no snapshot transactions.\n\nTo **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier\nas `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot\ntransaction, or the earliest ancestor transaction if there are no snapshot transactions.\n\nTo **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's\nresource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.\nThis will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the \n`endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path.\n\nTo **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the \n`startTransactionRid` and `endTransactionRid`.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\n" - operationId: getFileMetadata - x-operationVerb: get - x-auditCategory: metaDataAccess - x-releaseStage: STABLE - security: - - OAuth2: - - api:datasets-read - - BearerAuth: [] - parameters: - - description: The Resource Identifier (RID) of the Dataset that contains the File. + $ref: "#/components/schemas/OntologyIdentifier" + example: palantir + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager** application. in: path - name: datasetRid + name: objectType required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: The File's path within the Dataset. + $ref: "#/components/schemas/ObjectTypeApiName" + example: Employee + - description: | + The API name of the outgoing link. + To find the API name for your link type, check the **Ontology Manager**. in: path - name: filePath + name: linkType required: true schema: - $ref: "#/components/schemas/FilePath" - example: q3-data%2fmy-file.csv - - description: The identifier (name) of the Branch that contains the File. Defaults to `master` for most enrollments. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - description: The Resource Identifier (RID) of the start Transaction. - in: query - name: startTransactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" - - description: The Resource Identifier (RID) of the end Transaction. - in: query - name: endTransactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" + $ref: "#/components/schemas/LinkTypeApiName" + example: directReport responses: "200": content: application/json: schema: - $ref: "#/components/schemas/File" + $ref: "#/components/schemas/LinkTypeSideV2" example: - path: q3-data/my-file.csv - transactionRid: ri.foundry.main.transaction.bf9515c2-02d4-4703-8f84-c3b3c190254d - sizeBytes: 74930 - updatedTime: 2022-10-10T16:44:55.192Z - description: "" - delete: - description: "Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default \nbranch - `master` for most enrollments. The file will still be visible on historical views.\n\n#### Advanced Usage\n \nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\n\nTo **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction \nwill be created and committed on this branch.\n\nTo **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier \nas `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a\nsingle transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to \nopen a transaction.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.\n" - operationId: deleteFile - x-operationVerb: delete - x-auditCategory: dataDelete + apiName: directReport + objectTypeApiName: Employee + cardinality: MANY + description: Success response. + /api/v2/ontologies/attachments/upload: + post: + description: | + Upload an attachment to use in an action. Any attachment which has not been linked to an object via + an action within one hour after upload will be removed. + Previously mapped attachments which are not connected to any object anymore are also removed on + a biweekly basis. + The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-write`. + operationId: uploadAttachmentV2 + x-operationVerb: upload + x-auditCategory: dataCreate x-releaseStage: STABLE security: - OAuth2: - - api:datasets-write + - api:ontologies-write - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset on which to delete the File. - in: path - name: datasetRid + - description: The size in bytes of the file content being uploaded. + in: header + name: Content-Length required: true schema: - $ref: "#/components/schemas/DatasetRid" - example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - - description: The File path within the Dataset. - in: path - name: filePath + $ref: "#/components/schemas/ContentLength" + - description: The media type of the file being uploaded. + in: header + name: Content-Type required: true schema: - $ref: "#/components/schemas/FilePath" - example: q3-data%2fmy-file.csv - - description: The identifier (name) of the Branch on which to delete the File. Defaults to `master` for most enrollments. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - description: The Resource Identifier (RID) of the open delete Transaction on which to delete the File. + $ref: "#/components/schemas/ContentType" + - description: The name of the file being uploaded. in: query - name: transactionRid - required: false + name: filename + required: true schema: - $ref: "#/components/schemas/TransactionRid" + $ref: "#/components/schemas/Filename" + example: My Image.jpeg + requestBody: + content: + '*/*': + schema: + format: binary + type: string responses: - "204": - description: File deleted. - /api/v1/datasets/{datasetRid}/files/{filePath}/content: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/AttachmentV2" + example: + rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + filename: My Image.jpeg + sizeBytes: 393469 + mediaType: image/jpeg + description: Success response. + /api/v2/ontologies/attachments/{attachmentRid}/content: get: - description: "Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest\nview of the default branch - `master` for most enrollments.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. \n\nTo **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will \nretrieve the content for the most recent version of the file since the latest snapshot transaction, or the\nearliest ancestor transaction of the branch if there are no snapshot transactions.\n\nTo **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier\nas `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest\nsnapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions.\n\nTo **get a file's content from the resolved view of a range of transactions** specify the the start transaction's\nresource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.\nThis will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the \n`endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior\nis undefined when the start and end transactions do not belong to the same root-to-leaf path.\n\nTo **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the \n`startTransactionRid` and `endTransactionRid`.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\n" - operationId: getFileContent + description: | + Get the content of an attachment. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: getAttachmentContentV2 x-operationVerb: read x-auditCategory: dataExport x-releaseStage: STABLE security: - OAuth2: - - api:datasets-read + - api:ontologies-read - BearerAuth: [] parameters: - - description: The Resource Identifier (RID) of the Dataset that contains the File. - in: path - name: datasetRid - required: true - schema: - $ref: "#/components/schemas/DatasetRid" - - description: The File's path within the Dataset. + - description: The RID of the attachment. in: path - name: filePath + name: attachmentRid required: true schema: - $ref: "#/components/schemas/FilePath" - example: q3-data%2fmy-file.csv - - description: The identifier (name) of the Branch that contains the File. Defaults to `master` for most enrollments. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - description: The Resource Identifier (RID) of the start Transaction. - in: query - name: startTransactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" - - description: The Resource Identifier (RID) of the end Transaction. - in: query - name: endTransactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" + $ref: "#/components/schemas/AttachmentRid" + example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f responses: "200": content: @@ -9932,151 +10460,80 @@ paths: schema: format: binary type: string - description: "" - /api/v1/datasets/{datasetRid}/schema: - put: - description: | - Puts a Schema on an existing Dataset and Branch. - operationId: putSchema - x-operationVerb: replaceSchema - x-auditCategory: metaDataUpdate - x-releaseStage: PRIVATE_BETA - security: - - OAuth2: - - api:datasets-write - - BearerAuth: [] - parameters: - - description: | - The RID of the Dataset on which to put the Schema. - in: path - name: datasetRid - required: true - schema: - $ref: "#/components/schemas/DatasetRid" - - description: | - The ID of the Branch on which to put the Schema. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - in: query - name: preview - required: false - schema: - $ref: "#/components/schemas/PreviewMode" - example: true - requestBody: - content: - application/json: - schema: - type: object - x-type: - type: external - java: com.palantir.foundry.schemas.api.types.FoundrySchema - responses: - "204": - description: "" + description: Success response. + /api/v2/ontologies/attachments/{attachmentRid}: get: description: | - Retrieves the Schema for a Dataset and Branch, if it exists. - operationId: getSchema - x-operationVerb: getSchema + Get the metadata of an attachment. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: getAttachmentV2 + x-operationVerb: get x-auditCategory: metaDataAccess - x-releaseStage: PRIVATE_BETA + x-releaseStage: STABLE security: - OAuth2: - - api:datasets-read + - api:ontologies-read - BearerAuth: [] parameters: - - description: | - The RID of the Dataset. + - description: The RID of the attachment. in: path - name: datasetRid + name: attachmentRid required: true schema: - $ref: "#/components/schemas/DatasetRid" - - description: | - The ID of the Branch. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - description: | - The TransactionRid that contains the Schema. - in: query - name: transactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" - - in: query - name: preview - required: false - schema: - $ref: "#/components/schemas/PreviewMode" - example: true + $ref: "#/components/schemas/AttachmentRid" + example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f responses: "200": content: application/json: schema: - type: object - x-type: - type: external - java: com.palantir.foundry.schemas.api.types.FoundrySchema - description: "" - "204": - description: no schema - delete: + $ref: "#/components/schemas/AttachmentV2" + example: + rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + filename: My Image.jpeg + sizeBytes: 393469 + mediaType: image/jpeg + description: Success response. + /v2/operations/{operationId}: + get: description: | - Deletes the Schema from a Dataset and Branch. - operationId: deleteSchema - x-operationVerb: deleteSchema - x-auditCategory: metaDataDelete + Get an asynchronous operation by its ID. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getOperation + x-operationVerb: get x-releaseStage: PRIVATE_BETA security: - OAuth2: - - api:datasets-write + - api:ontologies-read - BearerAuth: [] parameters: - - description: | - The RID of the Dataset on which to delete the schema. + - description: "The unique Resource Identifier (RID) of the operation. \nThis is the id returned in the response of the invoking operation.\n" in: path - name: datasetRid + name: operationId required: true schema: - $ref: "#/components/schemas/DatasetRid" - - description: | - The ID of the Branch on which to delete the schema. - in: query - name: branchId - required: false - schema: - $ref: "#/components/schemas/BranchId" - - description: | - The RID of the Transaction on which to delete the schema. - in: query - name: transactionRid - required: false - schema: - $ref: "#/components/schemas/TransactionRid" - - in: query - name: preview - required: false - schema: - $ref: "#/components/schemas/PreviewMode" - example: true + type: string + format: rid + x-safety: safe + example: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 responses: - "204": - description: Schema deleted. - /api/v2/ontologies: + "200": + content: + application/json: + schema: + x-type: + type: asyncOperationCollection + description: Success response. + /api/v1/ontologies: get: description: | Lists the Ontologies visible to the current user. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listOntologiesV2 + operationId: listOntologies x-operationVerb: list x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE @@ -10089,7 +10546,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ListOntologiesV2Response" + $ref: "#/components/schemas/ListOntologiesResponse" example: data: - apiName: default-ontology @@ -10101,13 +10558,13 @@ paths: description: The ontology shared with our suppliers rid: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 description: Success response. - /api/v2/ontologies/{ontology}: + /api/v1/ontologies/{ontologyRid}: get: description: | Gets a specific ontology with the given Ontology RID. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getOntologyV2 + operationId: getOntology x-operationVerb: get x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE @@ -10117,76 +10574,39 @@ paths: - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/OntologyV2" + $ref: "#/components/schemas/Ontology" example: apiName: default-ontology displayName: Ontology description: The default ontology rid: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 description: Success response. - /api/v2/ontologies/{ontology}/fullMetadata: - get: - description: | - Get the full Ontology metadata. This includes the objects, links, actions, queries, and interfaces. - operationId: getOntologyFullMetadata - x-operationVerb: getFullMetadata - x-auditCategory: ontologyMetaDataLoad - x-releaseStage: PRIVATE_BETA - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/OntologyFullMetadata" - description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}: + /api/v1/ontologies/{ontologyRid}/objectTypes: get: description: | - Lists the objects for the given Ontology and object type. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. + Lists the object types for the given Ontology. - Note that null value properties will not be returned. + Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are + more results available, at least one result will be present in the + response. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listObjectsV2 + operationId: listObjectTypes x-operationVerb: list - x-auditCategory: ontologyDataLoad + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: @@ -10194,25 +10614,16 @@ paths: - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the object types. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: objectType + name: ontologyRid required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The desired size of the page to be returned. Defaults to 1,000. + The desired size of the page to be returned. Defaults to 500. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query name: pageSize @@ -10224,171 +10635,70 @@ paths: required: false schema: $ref: "#/components/schemas/PageToken" - - description: | - The properties of the object type that should be included in the response. Omit this parameter to get all - the properties. - in: query - name: select - schema: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - - in: query - name: orderBy - required: false - schema: - $ref: "#/components/schemas/OrderBy" - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" - - description: "A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n" - in: query - name: excludeRid - schema: - type: boolean - x-safety: safe responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListObjectsResponseV2" + $ref: "#/components/schemas/ListObjectTypesResponse" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - __rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 - __primaryKey: 50030 - __apiName: Employee - id: 50030 - firstName: John - lastName: Doe - - __rid: ri.phonograph2-objects.main.object.dcd887d1-c757-4d7a-8619-71e6ec2c25ab - __primaryKey: 20090 - __apiName: Employee - id: 20090 - firstName: John - lastName: Haymore - description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}: - get: - description: | - Gets a specific object with the given primary key. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getObjectV2 - x-operationVerb: get - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the requested object. To look up the expected primary key for your object type, use the - `Get object type` endpoint or the **Ontology Manager**. - in: path - name: primaryKey - required: true - schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 - - description: | - The properties of the object type that should be included in the response. Omit this parameter to get all - the properties. - in: query - name: select - schema: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" - - description: "A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n" - in: query - name: excludeRid - schema: - type: boolean - x-safety: safe - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/OntologyObjectV2" - example: - __rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 - __primaryKey: 50030 - __apiName: Employee - id: 50030 - firstName: John - lastName: Doe + - apiName: employee + description: A full-time or part-time employee of our firm + primaryKey: + - employeeId + properties: + employeeId: + baseType: Integer + fullName: + baseType: String + office: + description: The unique ID of the employee's primary assigned office + baseType: String + startDate: + description: "The date the employee was hired (most recently, if they were re-hired)" + baseType: Date + rid: ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44 + - apiName: office + description: A physical location (not including rented co-working spaces) + primaryKey: + - officeId + properties: + officeId: + baseType: String + address: + description: The office's physical address (not necessarily shipping address) + baseType: String + capacity: + description: The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher) + baseType: Integer + rid: ri.ontology.main.object-type.9a0e4409-9b50-499f-a637-a3b8334060d9 description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/count: - post: + /api/v1/ontologies/{ontologyRid}/objectTypes/{objectType}: + get: description: | - Returns a count of the objects of the given object type. + Gets a specific object type with the given API name. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: countObjects - x-operationVerb: count - x-auditCategory: ontologyDataSearch - x-releaseStage: PRIVATE_BETA + operationId: getObjectType + x-operationVerb: get + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. @@ -10398,35 +10708,42 @@ paths: schema: $ref: "#/components/schemas/ObjectTypeApiName" example: employee - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/CountObjectsResponseV2" + $ref: "#/components/schemas/ObjectType" example: - count: 100 + apiName: employee + description: A full-time or part-time employee of our firm + primaryKey: + - employeeId + properties: + employeeId: + baseType: Integer + fullName: + baseType: String + office: + description: The unique ID of the employee's primary assigned office + baseType: String + startDate: + description: "The date the employee was hired (most recently, if they were re-hired)" + baseType: Date + rid: ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04 description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/search: - post: - description: "Search for objects in the specified ontology and object type. The request body is used\nto filter objects based on the specified query. The supported queries are:\n\n| Query type | Description | Supported Types |\n|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------|\n| lt | The provided property is less than the provided value. | number, string, date, timestamp |\n| gt | The provided property is greater than the provided value. | number, string, date, timestamp |\n| lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp |\n| gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp |\n| eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp |\n| isNull | The provided property is (or is not) null. | all |\n| contains | The provided property contains the provided value. | array |\n| not | The sub-query does not match. | N/A (applied on a query) |\n| and | All the sub-queries match. | N/A (applied on queries) |\n| or | At least one of the sub-queries match. | N/A (applied on queries) |\n| startsWith | The provided property starts with the provided value. | string |\n| containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string |\n| containsAllTermsInOrder | The provided property contains the provided value as a substring. | string |\n| containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string |\n| containsAllTerms | The provided property contains all the terms separated by whitespace. | string | \n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" - operationId: searchObjectsV2 - x-operationVerb: search - x-auditCategory: ontologyDataSearch + /api/v1/ontologies/{ontologyRid}/actionTypes: + get: + description: | + Lists the action types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listActionTypes + x-operationVerb: list + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: @@ -10434,72 +10751,68 @@ paths: - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the action types. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: objectType + name: ontologyRid required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The repository associated with a marketplace installation. + The desired size of the page to be returned. Defaults to 500. + See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query - name: artifactRepository + name: pageSize required: false schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName + $ref: "#/components/schemas/PageSize" + - in: query + name: pageToken required: false schema: - $ref: "#/components/schemas/SdkPackageName" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SearchObjectsRequestV2" - example: - where: - type: eq - field: age - value: 21 + $ref: "#/components/schemas/PageToken" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/SearchObjectsResponseV2" + $ref: "#/components/schemas/ListActionTypesResponse" example: + nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - __rid: ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb - __primaryKey: 1000 - __apiName: Employee - employeeId: 1000 - lastName: smith - firstName: john - age: 21 + - apiName: promote-employee + description: Update an employee's title and compensation + parameters: + employeeId: + baseType: Integer + newTitle: + baseType: String + newCompensation: + baseType: Decimal + rid: ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167 + - apiName: move-office + description: Update an office's physical location + parameters: + officeId: + baseType: String + newAddress: + description: The office's new physical address (not necessarily shipping address) + baseType: String + newCapacity: + description: The maximum seated-at-desk capacity of the new office (maximum fire-safe capacity may be higher) + baseType: Integer + rid: ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2 description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/aggregate: - post: + /api/v1/ontologies/{ontologyRid}/actionTypes/{actionTypeApiName}: + get: description: | - Perform functions on object fields in the specified ontology and object type. + Gets a specific action type with the given API name. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: aggregateObjectsV2 - x-operationVerb: aggregate - x-auditCategory: ontologyDataSearch + operationId: getActionType + x-operationVerb: get + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: @@ -10507,112 +10820,90 @@ paths: - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: The type of the object to aggregate on. + The unique Resource Identifier (RID) of the Ontology that contains the action type. in: path - name: objectType + name: ontologyRid required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AggregateObjectsRequestV2" - example: - aggregation: - - type: min - field: properties.tenure - name: min_tenure - - type: avg - field: properties.tenure - name: avg_tenure - query: - not: - field: name - eq: john - groupBy: - - field: startDate - type: range - ranges: - - startValue: 2020-01-01 - endValue: 2020-06-01 - - field: city - type: exact - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/AggregateObjectsResponseV2" - example: - data: - - metrics: - - name: min_tenure - value: 1 - - name: avg_tenure - value: 3 - group: - startDate: - startValue: 2020-01-01 - endValue: 2020-06-01 - city: New York City - - metrics: - - name: min_tenure - value: 2 - - name: avg_tenure - value: 3 - group: - startDate: - startValue: 2020-01-01 - endValue: 2020-06-01 - city: San Francisco + The name of the action type in the API. + in: path + name: actionTypeApiName + required: true + schema: + $ref: "#/components/schemas/ActionTypeApiName" + example: promote-employee + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ActionType" + example: + data: + apiName: promote-employee + description: Update an employee's title and compensation + parameters: + employeeId: + baseType: Integer + newTitle: + baseType: String + newCompensation: + baseType: Decimal + rid: ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167 description: Success response. - /api/v2/ontologies/{ontology}/interfaceTypes: + /api/v1/ontologies/{ontologyRid}/objects/{objectType}: get: - description: ":::callout{theme=warning title=Warning}\n This endpoint is in preview and may be modified or removed at any time.\n To use this endpoint, add `preview=true` to the request query parameters.\n:::\n\nLists the interface types for the given Ontology.\n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response. \n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" - operationId: listInterfaceTypes + description: | + Lists the objects for the given Ontology and object type. + + This endpoint supports filtering objects. + See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. + + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listObjects x-operationVerb: list - x-auditCategory: ontologyMetaDataLoad - x-releaseStage: PRIVATE_BETA + x-auditCategory: ontologyDataLoad + x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or + The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. + in: path + name: ontologyRid + required: true + schema: + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + - description: | + The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: objectType required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee - description: | - The desired size of the page to be returned. Defaults to 500. + The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query name: pageSize @@ -10625,519 +10916,569 @@ paths: schema: $ref: "#/components/schemas/PageToken" - description: | - A boolean flag that, when set to true, enables the use of beta features in preview mode. + The properties of the object type that should be included in the response. Omit this parameter to get all + the properties. in: query - name: preview + name: properties + schema: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" + - in: query + name: orderBy required: false schema: - $ref: "#/components/schemas/PreviewMode" + $ref: "#/components/schemas/OrderBy" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListInterfaceTypesResponse" + $ref: "#/components/schemas/ListObjectsResponse" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - apiName: Athlete - displayName: Athlete - description: Good at sportsball + - rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 properties: - name: - rid: com.palantir.property.d1abdbfe-0ce2-4fff-b0af-af21002c314b - apiName: name - displayName: Name - dataType: string - extendsInterfaces: - - Human - rid: ri.ontology.main.interface.bea1af8c-7d5c-4ec9-b845-8eeed6d77482 + id: 50030 + firstName: John + lastName: Doe + - rid: ri.phonograph2-objects.main.object.dcd887d1-c757-4d7a-8619-71e6ec2c25ab + properties: + id: 20090 + firstName: John + lastName: Haymore description: Success response. - /api/v2/ontologies/{ontology}/interfaceTypes/{interfaceType}: + /api/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}: get: description: | - :::callout{theme=warning title=Warning} - This endpoint is in preview and may be modified or removed at any time. - To use this endpoint, add `preview=true` to the request query parameters. - ::: - - Gets a specific object type with the given API name. + Gets a specific object with the given primary key. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getInterfaceType + operationId: getObject x-operationVerb: get - x-auditCategory: ontologyMetaDataLoad - x-releaseStage: PRIVATE_BETA + x-auditCategory: ontologyDataLoad + x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the interface type. To find the API name, use the **List interface types** endpoint or + The API name of the object type. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. in: path - name: interfaceType + name: objectType required: true schema: - $ref: "#/components/schemas/InterfaceTypeApiName" - example: Employee + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee - description: | - A boolean flag that, when set to true, enables the use of beta features in preview mode. + The primary key of the requested object. To look up the expected primary key for your object type, use the + `Get object type` endpoint or the **Ontology Manager**. + in: path + name: primaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The properties of the object type that should be included in the response. Omit this parameter to get all + the properties. in: query - name: preview - required: false + name: properties schema: - $ref: "#/components/schemas/PreviewMode" + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/InterfaceType" + $ref: "#/components/schemas/OntologyObject" example: - apiName: Athlete - displayName: Athlete - description: Good at sportsball + rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 properties: - name: - rid: com.palantir.property.d1abdbfe-0ce2-4fff-b0af-af21002c314b - apiName: name - displayName: Name - dataType: string - extendsInterfaces: - - Human - rid: ri.ontology.main.interface.bea1af8c-7d5c-4ec9-b845-8eeed6d77482 + id: 50030 + firstName: John + lastName: Doe description: Success response. - /api/v2/ontologies/{ontology}/interfaces/{interfaceType}/search: - post: - description: ":::callout{theme=warning title=Warning}\n This endpoint is in preview and may be modified or removed at any time.\n To use this endpoint, add `preview=true` to the request query parameters.\n:::\n\nSearch for objects in the specified ontology and interface type. Any properties specified in the \"where\" or \n\"orderBy\" parameters must be shared property type API names defined on the interface. The following search \nqueries are supported:\n\n| Query type | Description | Supported Types |\n|-----------------------------------------|-------------------------------------------------------------------------------------------------------------------|---------------------------------|\n| lt | The provided property is less than the provided value. | number, string, date, timestamp |\n| gt | The provided property is greater than the provided value. | number, string, date, timestamp |\n| lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp |\n| gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp |\n| eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp |\n| isNull | The provided property is (or is not) null. | all |\n| contains | The provided property contains the provided value. | array |\n| not | The sub-query does not match. | N/A (applied on a query) |\n| and | All the sub-queries match. | N/A (applied on queries) |\n| or | At least one of the sub-queries match. | N/A (applied on queries) |\n| startsWith | The provided property starts with the provided value. | string |\n| containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string |\n| containsAllTermsInOrder | The provided property contains the provided value as a substring. | string |\n| containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string |\n| containsAllTerms | The provided property contains all the terms separated by whitespace. | string | \n\nAttempting to use an unsupported query will result in a validation error. Third-party applications using this \nendpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" - operationId: searchObjectsForInterface - x-operationVerb: search - x-auditCategory: ontologyDataSearch - x-releaseStage: PRIVATE_BETA + /api/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}: + get: + description: | + Lists the linked objects for a specific object and the given link type. + + This endpoint supports filtering objects. + See the [Filtering Objects documentation](/docs/foundry/api/ontology-resources/objects/object-basics/#filtering-objects) for details. + + Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or + repeated objects in the response pages. + + For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects + are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. + + Each page may be smaller or larger than the requested page size. However, it + is guaranteed that if there are more results available, at least one result will be present + in the response. + + Note that null value properties will not be returned. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listLinkedObjects + x-operationVerb: listLinkedObjects + x-auditCategory: ontologyDataLoad + x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the objects. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the interface type. To find the API name, use the **List interface types** endpoint or + The API name of the object from which the links originate. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**. in: path - name: interfaceType + name: objectType required: true schema: - $ref: "#/components/schemas/InterfaceTypeApiName" - example: Employee + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee + - description: | + The primary key of the object from which the links originate. To look up the expected primary key for your + object type, use the `Get object type` endpoint or the **Ontology Manager**. + in: path + name: primaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 + - description: | + The API name of the link that exists between the object and the requested objects. + To find the API name for your link type, check the **Ontology Manager**. + in: path + name: linkType + required: true + schema: + $ref: "#/components/schemas/LinkTypeApiName" + example: directReport + - description: | + The desired size of the page to be returned. Defaults to 1,000. + See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + in: query + name: pageSize + required: false + schema: + $ref: "#/components/schemas/PageSize" + - in: query + name: pageToken + required: false + schema: + $ref: "#/components/schemas/PageToken" - description: | - A boolean flag that, when set to true, enables the use of beta features in preview mode. + The properties of the object type that should be included in the response. Omit this parameter to get all + the properties. in: query - name: preview + name: properties + schema: + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" + - in: query + name: orderBy required: false schema: - $ref: "#/components/schemas/PreviewMode" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/SearchObjectsForInterfaceRequest" + $ref: "#/components/schemas/OrderBy" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/SearchObjectsResponseV2" + $ref: "#/components/schemas/ListLinkedObjectsResponse" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - __rid: ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb - __primaryKey: 1000 - __apiName: Employee - employeeId: 1000 - lastName: smith - firstName: john - age: 21 + - rid: ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136 + properties: + id: 80060 + firstName: Anna + lastName: Smith + - rid: ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136 + properties: + id: 51060 + firstName: James + lastName: Matthews description: Success response. - /api/v2/ontologies/{ontology}/interfaces/{interfaceType}/aggregate: - post: - description: ":::callout{theme=warning title=Warning}\n This endpoint is in preview and may be modified or removed at any time.\n To use this endpoint, add `preview=true` to the request query parameters.\n:::\n\nPerform functions on object fields in the specified ontology and of the specified interface type. Any \nproperties specified in the query must be shared property type API names defined on the interface.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" - operationId: aggregateObjectsForInterface - x-operationVerb: aggregate - x-auditCategory: ontologyDataSearch - x-releaseStage: PRIVATE_BETA + /api/v1/ontologies/{ontologyRid}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}: + get: + description: | + Get a specific linked object that originates from another object. If there is no link between the two objects, + LinkedObjectNotFound is thrown. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: getLinkedObject + x-operationVerb: getLinkedObject + x-auditCategory: ontologyDataLoad + x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the object. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + - description: "The API name of the object from which the links originate. To find the API name, use the **List object types** endpoint or check the **Ontology Manager**." + in: path + name: objectType + required: true + schema: + $ref: "#/components/schemas/ObjectTypeApiName" + example: employee - description: | - The API name of the interface type. To find the API name, use the **List interface types** endpoint or - check the **Ontology Manager**. + The primary key of the object from which the link originates. To look up the expected primary key for your + object type, use the `Get object type` endpoint or the **Ontology Manager**. in: path - name: interfaceType + name: primaryKey required: true schema: - $ref: "#/components/schemas/InterfaceTypeApiName" - example: Employee + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 50030 - description: | - A boolean flag that, when set to true, enables the use of beta features in preview mode. + The API name of the link that exists between the object and the requested objects. + To find the API name for your link type, check the **Ontology Manager**. + in: path + name: linkType + required: true + schema: + $ref: "#/components/schemas/LinkTypeApiName" + example: directReport + - description: | + The primary key of the requested linked object. To look up the expected primary key for your object type, + use the `Get object type` endpoint (passing the linked object type) or the **Ontology Manager**. + in: path + name: linkedObjectPrimaryKey + required: true + schema: + $ref: "#/components/schemas/PropertyValueEscapedString" + example: 80060 + - description: | + The properties of the object type that should be included in the response. Omit this parameter to get all + the properties. in: query - name: preview - required: false + name: properties schema: - $ref: "#/components/schemas/PreviewMode" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AggregateObjectsRequestV2" - example: - aggregation: - - type: min - field: properties.tenure - name: min_tenure - - type: avg - field: properties.tenure - name: avg_tenure - query: - not: - field: name - eq: john - groupBy: - - field: startDate - type: range - ranges: - - startValue: 2020-01-01 - endValue: 2020-06-01 - - field: city - type: exact + type: array + items: + $ref: "#/components/schemas/SelectedPropertyApiName" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/AggregateObjectsResponseV2" + $ref: "#/components/schemas/OntologyObject" example: - data: - - metrics: - - name: min_tenure - value: 1 - - name: avg_tenure - value: 3 - group: - startDate: - startValue: 2020-01-01 - endValue: 2020-06-01 - city: New York City - - metrics: - - name: min_tenure - value: 2 - - name: avg_tenure - value: 3 - group: - startDate: - startValue: 2020-01-01 - endValue: 2020-06-01 - city: San Francisco + rid: ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136 + properties: + id: 80060 + firstName: Anna + lastName: Smith description: Success response. - /api/v2/ontologies/{ontology}/queryTypes: - get: - description: "Lists the query types for the given Ontology. \n\nEach page may be smaller than the requested page size. However, it is guaranteed that if there are more\nresults available, at least one result will be present in the response. \n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" - operationId: listQueryTypesV2 - x-operationVerb: list - x-auditCategory: ontologyMetaDataLoad + /api/v1/ontologies/{ontologyRid}/actions/{actionType}/apply: + post: + description: | + Applies an action using the given parameters. Changes to the Ontology are eventually consistent and may take + some time to be visible. + + Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by + this endpoint. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read api:ontologies-write`. + operationId: applyAction + x-operationVerb: apply + x-auditCategory: ontologyDataTransform x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read + - api:ontologies-write - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The desired size of the page to be returned. Defaults to 100. - See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - in: query - name: pageSize - required: false - schema: - $ref: "#/components/schemas/PageSize" - - in: query - name: pageToken - required: false - schema: - $ref: "#/components/schemas/PageToken" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/ListQueryTypesResponseV2" - example: - nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv - data: - - apiName: getEmployeesInCity - displayName: Get Employees in City - description: Gets all employees in a given city - parameters: - city: - dataType: - type: string - description: The city to search for employees in - required: true - output: - dataType: - type: array - required: true - subType: - type: object - objectApiName: Employee - required: true - rid: ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b - version: 1.1.3-rc1 - - apiName: getAverageTenureOfEmployees - displayName: Get Average Tenure - description: Gets the average tenure of all employees - parameters: - employees: - dataType: - type: string - description: An object set of the employees to calculate the average tenure of - required: true - useMedian: - dataType: - type: boolean - description: "An optional flag to use the median instead of the mean, defaults to false" - required: false - output: - dataType: - type: double - required: true - rid: ri.function-registry.main.function.9549c29d3-e92f-64a1-beeb-af817819a400 - version: 2.1.1 + name: ontologyRid + required: true + schema: + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + - description: | + The API name of the action to apply. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. + in: path + name: actionType + required: true + schema: + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ApplyActionRequest" + example: + parameters: + id: 80060 + newName: Anna Smith-Doe + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/ApplyActionResponse" + example: {} description: Success response. - /api/v2/ontologies/{ontology}/queryTypes/{queryApiName}: - get: + /api/v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch: + post: description: | - Gets a specific query type with the given API name. + Applies multiple actions (of the same Action Type) using the given parameters. + Changes to the Ontology are eventually consistent and may take some time to be visible. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getQueryTypeV2 - x-operationVerb: get - x-auditCategory: ontologyMetaDataLoad + Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not + call Functions may receive a higher limit. + + Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) and + [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read api:ontologies-write`. + operationId: applyActionBatch + x-operationVerb: applyBatch + x-auditCategory: ontologyDataTransform x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read + - api:ontologies-write - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the query type. To find the API name, use the **List query types** endpoint or - check the **Ontology Manager**. + The API name of the action to apply. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. in: path - name: queryApiName + name: actionType required: true schema: - $ref: "#/components/schemas/QueryApiName" - example: getEmployeesInCity + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/BatchApplyActionRequest" + example: + requests: + - parameters: + id: 80060 + newName: Anna Smith-Doe + - parameters: + id: 80061 + newName: Joe Bloggs responses: "200": content: application/json: schema: - $ref: "#/components/schemas/QueryTypeV2" - example: - apiName: getEmployeesInCity - displayName: Get Employees in City - description: Gets all employees in a given city - parameters: - city: - dataType: - type: string - description: The city to search for employees in - required: true - output: - dataType: - type: array - subType: - type: object - objectApiName: Employee - required: true - rid: ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b - version: 1.1.3-rc1 + $ref: "#/components/schemas/BatchApplyActionResponse" + example: {} description: Success response. - /api/v2/ontologies/{ontology}/queries/{queryApiName}/execute: + /api/v1/ontologies/{ontologyRid}/actions/{actionType}/applyAsync: post: - description: "Executes a Query using the given parameters.\n\nOptional parameters do not need to be supplied.\n\nThird-party applications using this endpoint via OAuth2 must request the \nfollowing operation scopes: `api:ontologies-read`.\n" - operationId: executeQueryV2 - x-operationVerb: execute - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE + description: | + Applies an action asynchronously using the given parameters. Changes to the Ontology are eventually consistent + and may take some time to be visible. + + Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently + supported by this endpoint. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read api:ontologies-write`. + operationId: applyActionAsync + x-operationVerb: applyAsync + x-auditCategory: ontologyDataTransform + x-releaseStage: PRIVATE_BETA security: - OAuth2: - api:ontologies-read + - api:ontologies-write - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the Query to execute. + The API name of the action to apply. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. in: path - name: queryApiName + name: actionType required: true schema: - $ref: "#/components/schemas/QueryApiName" - example: getEmployeesInCity - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee - description: | - The package name of the generated SDK. + Represents a boolean value that restricts an endpoint to preview mode when set to true. in: query - name: packageName + name: preview required: false schema: - $ref: "#/components/schemas/SdkPackageName" + $ref: "#/components/schemas/PreviewMode" + example: true requestBody: content: application/json: schema: - $ref: "#/components/schemas/ExecuteQueryRequest" + $ref: "#/components/schemas/AsyncApplyActionRequest" example: parameters: - city: New York + id: 80060 + newName: Anna Smith-Doe responses: - "200": + "202": content: application/json: schema: - $ref: "#/components/schemas/ExecuteQueryResponse" + $ref: "#/components/schemas/AsyncActionOperation" example: - value: - - EMP546 - - EMP609 - - EMP989 + data: + - id: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + operationType: applyActionAsync + status: RUNNING + stage: RUNNING_SUBMISSION_CHECKS description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}: + /api/v1/ontologies/{ontologyRid}/actions/{actionType}/applyAsync/{actionRid}: get: - description: | - Lists the linked objects for a specific object and the given link type. - - Note that this endpoint does not guarantee consistency. Changes to the data could result in missing or - repeated objects in the response pages. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Each page may be smaller or larger than the requested page size. However, it - is guaranteed that if there are more results available, at least one result will be present - in the response. - - Note that null value properties will not be returned. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listLinkedObjectsV2 - x-operationVerb: listLinkedObjects - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE + operationId: getAsyncActionStatus + x-operationVerb: getOperationStatus + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: PRIVATE_BETA security: - - OAuth2: + - BearerAuth: - api:ontologies-read - - BearerAuth: [] + - api:ontologies-write parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. + The API name of the action to apply. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. in: path - name: objectType + name: actionType required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object from which the links originate. To look up the expected primary key for your - object type, use the `Get object type` endpoint or the **Ontology Manager**. - in: path - name: primaryKey + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee + - in: path + name: actionRid required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 + $ref: "#/components/schemas/ActionRid" + - description: | + Represents a boolean value that restricts an endpoint to preview mode when set to true. + in: query + name: preview + required: false + schema: + $ref: "#/components/schemas/PreviewMode" + example: true + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/AsyncActionOperation" + example: + id: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + operationType: applyActionAsync + status: SUCCESSFUL + result: + type: success + description: Success response + /api/v1/ontologies/{ontologyRid}/queryTypes: + get: + description: | + Lists the query types for the given Ontology. + + Each page may be smaller than the requested page size. However, it is guaranteed that if there are more + results available, at least one result will be present in the response. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: listQueryTypes + x-operationVerb: list + x-auditCategory: ontologyMetaDataLoad + x-releaseStage: STABLE + security: + - OAuth2: + - api:ontologies-read + - BearerAuth: [] + parameters: - description: | - The API name of the link that exists between the object and the requested objects. - To find the API name for your link type, check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the query types. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: linkType + name: ontologyRid required: true schema: - $ref: "#/components/schemas/LinkTypeApiName" - example: directReport + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The desired size of the page to be returned. Defaults to 1,000. + The desired size of the page to be returned. Defaults to 100. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query name: pageSize @@ -11149,73 +11490,51 @@ paths: required: false schema: $ref: "#/components/schemas/PageToken" - - description: | - The properties of the object type that should be included in the response. Omit this parameter to get all - the properties. - in: query - name: select - schema: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - - in: query - name: orderBy - required: false - schema: - $ref: "#/components/schemas/OrderBy" - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" - - description: "A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n" - in: query - name: excludeRid - schema: - type: boolean - x-safety: safe responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListLinkedObjectsResponseV2" + $ref: "#/components/schemas/ListQueryTypesResponse" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - __rid: ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136 - __primaryKey: 80060 - __apiName: Employee - id: 80060 - firstName: Anna - lastName: Smith - - __rid: ri.phonograph2-objects.main.object.74f00352-8f13-4764-89ea-28e13e086136 - __primaryKey: 51060 - __apiName: Employee - id: 51060 - firstName: James - lastName: Matthews + - apiName: getEmployeesInCity + displayName: Get Employees in City + description: Gets all employees in a given city + parameters: + city: + baseType: String + description: The city to search for employees in + required: true + output: Array> + rid: ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b + version: 1.1.3-rc1 + - apiName: getAverageTenureOfEmployees + displayName: Get Average Tenure + description: Gets the average tenure of all employees + parameters: + employees: + baseType: String + description: An object set of the employees to calculate the average tenure of + required: true + useMedian: + baseType: Boolean + description: "An optional flag to use the median instead of the mean, defaults to false" + required: false + output: Double + rid: ri.function-registry.main.function.9549c29d3-e92f-64a1-beeb-af817819a400 + version: 2.1.1 description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey}: + /api/v1/ontologies/{ontologyRid}/queryTypes/{queryApiName}: get: description: | - Get a specific linked object that originates from another object. - - If there is no link between the two objects, `LinkedObjectNotFound` is thrown. + Gets a specific query type with the given API name. Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getLinkedObjectV2 - x-operationVerb: getLinkedObject - x-auditCategory: ontologyDataLoad + operationId: getQueryType + x-operationVerb: get + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: @@ -11223,181 +11542,181 @@ paths: - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the query type. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or + The API name of the query type. To find the API name, use the **List query types** endpoint or check the **Ontology Manager**. in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object from which the links originate. To look up the expected primary key for your - object type, use the `Get object type` endpoint or the **Ontology Manager**. - in: path - name: primaryKey + name: queryApiName required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 + $ref: "#/components/schemas/QueryApiName" + example: getEmployeesInCity + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/QueryType" + example: + apiName: getEmployeesInCity + displayName: Get Employees in City + description: Gets all employees in a given city + parameters: + city: + baseType: String + description: The city to search for employees in + required: true + output: Array> + rid: ri.function-registry.main.function.f05481407-1d67-4120-83b4-e3fed5305a29b + version: 1.1.3-rc1 + description: Success response. + /api/v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute: + post: + description: | + Executes a Query using the given parameters. Optional parameters do not need to be supplied. + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: executeQuery + x-operationVerb: execute + x-auditCategory: ontologyDataLoad + x-releaseStage: STABLE + security: + - OAuth2: + - api:ontologies-read + - BearerAuth: [] + parameters: - description: | - The API name of the link that exists between the object and the requested objects. - To find the API name for your link type, check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the Query. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: linkType + name: ontologyRid required: true schema: - $ref: "#/components/schemas/LinkTypeApiName" - example: directReport + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The primary key of the requested linked object. To look up the expected primary key for your object type, - use the `Get object type` endpoint (passing the linked object type) or the **Ontology Manager**. + The API name of the Query to execute. in: path - name: linkedObjectPrimaryKey + name: queryApiName required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 80060 - - description: | - The properties of the object type that should be included in the response. Omit this parameter to get all - the properties. - in: query - name: select - schema: - type: array - items: - $ref: "#/components/schemas/SelectedPropertyApiName" - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" - - description: "A flag to exclude the retrieval of the `__rid` property. \nSetting this to true may improve performance of this endpoint for object types in OSV2.\n" - in: query - name: excludeRid - schema: - type: boolean - x-safety: safe + $ref: "#/components/schemas/QueryApiName" + example: getEmployeesInCity + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ExecuteQueryRequest" + example: + parameters: + city: New York responses: "200": content: application/json: schema: - $ref: "#/components/schemas/OntologyObjectV2" + $ref: "#/components/schemas/ExecuteQueryResponse" example: - __rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 - __primaryKey: 50030 - __apiName: Employee - id: 50030 - firstName: John - lastName: Doe + value: + - EMP546 + - EMP609 + - EMP989 description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}: - get: + /api/v1/ontologies/{ontologyRid}/objects/{objectType}/search: + post: description: | - Get the metadata of attachments parented to the given object. + Search for objects in the specified ontology and object type. The request body is used + to filter objects based on the specified query. The supported queries are: - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: listPropertyAttachments - x-operationVerb: getAttachment - x-auditCategory: metaDataAccess + | Query type | Description | Supported Types | + |----------|-----------------------------------------------------------------------------------|---------------------------------| + | lt | The provided property is less than the provided value. | number, string, date, timestamp | + | gt | The provided property is greater than the provided value. | number, string, date, timestamp | + | lte | The provided property is less than or equal to the provided value. | number, string, date, timestamp | + | gte | The provided property is greater than or equal to the provided value. | number, string, date, timestamp | + | eq | The provided property is exactly equal to the provided value. | number, string, date, timestamp | + | isNull | The provided property is (or is not) null. | all | + | contains | The provided property contains the provided value. | array | + | not | The sub-query does not match. | N/A (applied on a query) | + | and | All the sub-queries match. | N/A (applied on queries) | + | or | At least one of the sub-queries match. | N/A (applied on queries) | + | prefix | The provided property starts with the provided value. | string | + | phrase | The provided property contains the provided value as a substring. | string | + | anyTerm | The provided property contains at least one of the terms separated by whitespace. | string | + | allTerms | The provided property contains all the terms separated by whitespace. | string | | + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: searchObjects + x-operationVerb: search + x-auditCategory: ontologyDataSearch x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The unique Resource Identifier (RID) of the Ontology that contains the objects. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + - description: The type of the requested objects. in: path name: objectType required: true schema: $ref: "#/components/schemas/ObjectTypeApiName" example: employee - - description: | - The primary key of the object containing the attachment. - in: path - name: primaryKey - required: true - schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 - - description: | - The API name of the attachment property. To find the API name for your attachment, - check the **Ontology Manager** or use the **Get object type** endpoint. - in: path - name: property - required: true - schema: - $ref: "#/components/schemas/PropertyApiName" - example: performance - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/SearchObjectsRequest" + example: + query: + not: + field: properties.age + eq: 21 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/AttachmentMetadataResponse" + $ref: "#/components/schemas/SearchObjectsResponse" example: - type: single - rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - filename: My Image.jpeg - sizeBytes: 393469 - mediaType: image/jpeg + data: + - properties: + lastName: smith + firstName: john + age: 21 + rid: ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851ababb description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}: - get: + /api/v1/ontologies/{ontologyRid}/actions/{actionType}/validate: + post: description: | - Get the metadata of a particular attachment in an attachment list. + Validates if an action can be run with the given set of parameters. + The response contains the evaluation of parameters and **submission criteria** + that determine if the request is `VALID` or `INVALID`. + For performance reasons, validations will not consider existing objects or other data in Foundry. + For example, the uniqueness of a primary key or the existence of a user ID will not be checked. + Note that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by + this endpoint. Unspecified parameters will be given a default value of `null`. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read`. - operationId: getAttachmentPropertyByRidV2 - x-operationVerb: getAttachmentByRid - x-auditCategory: metaDataAccess + operationId: validateAction + x-operationVerb: validate + x-auditCategory: ontologyLogicAccess x-releaseStage: STABLE security: - OAuth2: @@ -11405,157 +11724,198 @@ paths: - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object containing the attachment. + The unique Resource Identifier (RID) of the Ontology that contains the action. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager**. in: path - name: primaryKey + name: ontologyRid required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the attachment property. To find the API name for your attachment, - check the **Ontology Manager** or use the **Get object type** endpoint. - in: path - name: property - required: true - schema: - $ref: "#/components/schemas/PropertyApiName" - example: performance - - description: The RID of the attachment. - name: attachmentRid + The API name of the action to validate. To find the API name for your action, use the **List action types** + endpoint or check the **Ontology Manager**. in: path + name: actionType required: true schema: - $ref: "#/components/schemas/AttachmentRid" - example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" + $ref: "#/components/schemas/ActionTypeApiName" + example: rename-employee + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/ValidateActionRequest" + example: + parameters: + id: 2 + firstName: Chuck + lastName: Jones + age: 17 + date: 2021-05-01 + numbers: + - 1 + - 2 + - 3 + hasObjectSet: true + objectSet: ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623 + reference: Chuck + percentage: 41.3 + differentObjectId: 2 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/AttachmentV2" + $ref: "#/components/schemas/ValidateActionResponse" example: - rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - filename: My Image.jpeg - sizeBytes: 393469 - mediaType: image/jpeg + result: INVALID + submissionCriteria: + - configuredFailureMessage: First name can not match the first name of the referenced object. + result: INVALID + parameters: + age: + result: INVALID + evaluatedConstraints: + - type: range + gte: 18 + required: true + id: + result: VALID + evaluatedConstraints: [] + required: true + date: + result: VALID + evaluatedConstraints: [] + required: true + lastName: + result: VALID + evaluatedConstraints: + - type: oneOf + options: + - displayName: Doe + value: Doe + - displayName: Smith + value: Smith + - displayName: Adams + value: Adams + - displayName: Jones + value: Jones + otherValuesAllowed: true + required: true + numbers: + result: VALID + evaluatedConstraints: + - type: arraySize + lte: 4 + gte: 2 + required: true + differentObjectId: + result: VALID + evaluatedConstraints: + - type: objectPropertyValue + required: false + firstName: + result: VALID + evaluatedConstraints: [] + required: true + reference: + result: VALID + evaluatedConstraints: + - type: objectQueryResult + required: false + percentage: + result: VALID + evaluatedConstraints: + - type: range + lt: 100 + gte: 0 + required: true + objectSet: + result: VALID + evaluatedConstraints: [] + required: true + attachment: + result: VALID + evaluatedConstraints: [] + required: false + hasObjectSet: + result: VALID + evaluatedConstraints: [] + required: false + multipleAttachments: + result: VALID + evaluatedConstraints: + - type: arraySize + gte: 0 + required: false description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content: - get: + /api/v1/attachments/upload: + post: description: | - Get the content of an attachment. + Upload an attachment to use in an action. Any attachment which has not been linked to an object via + an action within one hour after upload will be removed. + Previously mapped attachments which are not connected to any object anymore are also removed on + a biweekly basis. + The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: getAttachmentPropertyContentV2 - x-operationVerb: readAttachment - x-auditCategory: dataExport + following operation scopes: `api:ontologies-write`. + operationId: uploadAttachment + x-operationVerb: upload + x-auditCategory: dataCreate x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:ontologies-write - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object containing the attachment. - in: path - name: primaryKey + - description: The size in bytes of the file content being uploaded. + in: header + name: Content-Length required: true schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 - - description: | - The API name of the attachment property. To find the API name for your attachment, - check the **Ontology Manager** or use the **Get object type** endpoint. - in: path - name: property + $ref: "#/components/schemas/ContentLength" + - description: The media type of the file being uploaded. + in: header + name: Content-Type required: true schema: - $ref: "#/components/schemas/PropertyApiName" - example: performance - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. + $ref: "#/components/schemas/ContentType" + - description: The name of the file being uploaded. in: query - name: packageName - required: false + name: filename + required: true schema: - $ref: "#/components/schemas/SdkPackageName" + $ref: "#/components/schemas/Filename" + example: My Image.jpeg + requestBody: + content: + '*/*': + schema: + format: binary + type: string responses: "200": content: - '*/*': + application/json: schema: - format: binary - type: string + $ref: "#/components/schemas/Attachment" + example: + rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + filename: My Image.jpeg + sizeBytes: 393469 + mediaType: image/jpeg description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content: + /api/v1/attachments/{attachmentRid}/content: get: description: | - Get the content of an attachment by its RID. - - The RID must exist in the attachment array of the property. + Get the content of an attachment. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read`. - operationId: getAttachmentPropertyContentByRidV2 - x-operationVerb: readAttachmentByRid + operationId: getAttachmentContent + x-operationVerb: read x-auditCategory: dataExport x-releaseStage: STABLE security: @@ -11563,62 +11923,13 @@ paths: - api:ontologies-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object containing the attachment. - in: path - name: primaryKey - required: true - schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 - - description: | - The API name of the attachment property. To find the API name for your attachment, - check the **Ontology Manager** or use the **Get object type** endpoint. - in: path - name: property - required: true - schema: - $ref: "#/components/schemas/PropertyApiName" - example: performance - description: The RID of the attachment. - name: attachmentRid in: path + name: attachmentRid required: true schema: $ref: "#/components/schemas/AttachmentRid" example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" responses: "200": content: @@ -11627,914 +11938,747 @@ paths: format: binary type: string description: Success response. - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint: - get: - description: | - Get the first point of a time series property. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: getFirstPoint - x-operationVerb: getFirstPoint - x-auditCategory: ontologyDataLoad - x-releaseStage: STABLE - security: - - OAuth2: - - api:ontologies-read - - BearerAuth: [] - parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object with the time series property. - in: path - name: primaryKey - required: true - schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 - - description: | - The API name of the time series property. To find the API name for your time series property, - check the **Ontology Manager** or use the **Get object type** endpoint. - in: path - name: property - required: true - schema: - $ref: "#/components/schemas/PropertyApiName" - example: performance - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" - responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/TimeSeriesPoint" - description: Success response. - "204": - description: No Content - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint: + /api/v1/attachments/{attachmentRid}: get: description: | - Get the last point of a time series property. + Get the metadata of an attachment. Third-party applications using this endpoint via OAuth2 must request the following operation scopes: `api:ontologies-read`. - operationId: getLastPoint - x-operationVerb: getLastPoint - x-auditCategory: ontologyDataLoad + operationId: getAttachment + x-operationVerb: get + x-auditCategory: metaDataAccess x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. - in: path - name: ontology - required: true - schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. - in: path - name: objectType - required: true - schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - The primary key of the object with the time series property. - in: path - name: primaryKey - required: true - schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 - - description: | - The API name of the time series property. To find the API name for your time series property, - check the **Ontology Manager** or use the **Get object type** endpoint. + - description: The RID of the attachment. in: path - name: property + name: attachmentRid required: true schema: - $ref: "#/components/schemas/PropertyApiName" - example: performance - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" + $ref: "#/components/schemas/AttachmentRid" + example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f responses: "200": content: application/json: schema: - $ref: "#/components/schemas/TimeSeriesPoint" + $ref: "#/components/schemas/Attachment" + example: + rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + filename: My Image.jpeg + sizeBytes: 393469 + mediaType: image/jpeg description: Success response. - "204": - description: No Content - /api/v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints: + /api/v1/ontologies/{ontologyRid}/objects/{objectType}/aggregate: post: description: | - Stream all of the points of a time series property. + Perform functions on object fields in the specified ontology and object type. - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: streamPoints - x-operationVerb: streamPoints - x-auditCategory: ontologyDataLoad + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. + operationId: aggregateObjects + x-operationVerb: aggregate + x-auditCategory: ontologyDataSearch x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The unique Resource Identifier (RID) of the Ontology that contains the objects. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 + - description: The type of the object to aggregate on. in: path name: objectType required: true schema: $ref: "#/components/schemas/ObjectTypeApiName" example: employee - - description: | - The primary key of the object with the time series property. - in: path - name: primaryKey - required: true - schema: - $ref: "#/components/schemas/PropertyValueEscapedString" - example: 50030 - - description: | - The API name of the time series property. To find the API name for your time series property, - check the **Ontology Manager** or use the **Get object type** endpoint. - in: path - name: property - required: true - schema: - $ref: "#/components/schemas/PropertyApiName" - example: null - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false - schema: - $ref: "#/components/schemas/SdkPackageName" requestBody: content: application/json: schema: - $ref: "#/components/schemas/StreamTimeSeriesPointsRequest" + $ref: "#/components/schemas/AggregateObjectsRequest" example: - range: - type: relative - startTime: - when: BEFORE - value: 5 - unit: MONTHS - endTime: - when: BEFORE - value: 1 - unit: MONTHS + aggregation: + - type: min + field: properties.tenure + name: min_tenure + - type: avg + field: properties.tenure + name: avg_tenure + query: + not: + field: properties.name + eq: john + groupBy: + - field: properties.startDate + type: range + ranges: + - gte: 2020-01-01 + lt: 2020-06-01 + - field: properties.city + type: exact responses: "200": content: - '*/*': + application/json: schema: - format: binary - type: string + $ref: "#/components/schemas/AggregateObjectsResponse" example: data: - - time: 2020-03-06T12:00:00Z - value: 48.5 - - time: 2020-03-06T13:00:00Z - value: 75.01 - - time: 2020-03-06T14:00:00Z - value: 31.33 + - metrics: + - name: min_tenure + value: 1 + - name: avg_tenure + value: 3 + group: + properties.startDate: + gte: 2020-01-01 + lt: 2020-06-01 + properties.city: New York City + - metrics: + - name: min_tenure + value: 2 + - name: avg_tenure + value: 3 + group: + properties.startDate: + gte: 2020-01-01 + lt: 2020-06-01 + properties.city: San Francisco description: Success response. - /api/v2/ontologies/{ontology}/actions/{action}/apply: - post: - description: "Applies an action using the given parameters. \n\nChanges to the Ontology are eventually consistent and may take some time to be visible.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint.\n\nThird-party applications using this endpoint via OAuth2 must request the\nfollowing operation scopes: `api:ontologies-read api:ontologies-write`.\n" - operationId: applyActionV2 - x-operationVerb: apply - x-auditCategory: ontologyDataTransform + /api/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes: + get: + description: | + List the outgoing links for an object type. + + Third-party applications using this endpoint via OAuth2 must request the + following operation scopes: `api:ontologies-read`. + operationId: listOutgoingLinkTypes + x-operationVerb: listOutgoingLinkTypes + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - - api:ontologies-write - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager** application. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the action to apply. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager** application. in: path - name: action + name: objectType required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee - - description: | - The repository associated with a marketplace installation. + $ref: "#/components/schemas/ObjectTypeApiName" + example: Flight + - description: The desired size of the page to be returned. in: query - name: artifactRepository + name: pageSize required: false schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName + $ref: "#/components/schemas/PageSize" + - in: query + name: pageToken required: false schema: - $ref: "#/components/schemas/SdkPackageName" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/ApplyActionRequestV2" - example: - parameters: - id: 80060 - newName: Anna Smith-Doe + $ref: "#/components/schemas/PageToken" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/SyncApplyActionResponseV2" + $ref: "#/components/schemas/ListOutgoingLinkTypesResponse" example: - validation: - result: VALID - parameters: - id: - evaluatedConstraints: [] - result: VALID - required: true - newName: - evaluatedConstraints: [] - result: VALID - required: true + nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv + data: + - apiName: originAirport + objectTypeApiName: Airport + cardinality: ONE + foreignKeyPropertyApiName: originAirportId description: Success response. - /api/v2/ontologies/{ontology}/actions/{action}/applyBatch: - post: + /api/v1/ontologies/{ontologyRid}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}: + get: description: | - Applies multiple actions (of the same Action Type) using the given parameters. - Changes to the Ontology are eventually consistent and may take some time to be visible. - - Up to 20 actions may be applied in one call. Actions that only modify objects in Object Storage v2 and do not - call Functions may receive a higher limit. - - Note that [notifications](/docs/foundry/action-types/notifications/) are not currently supported by this endpoint. + Get an outgoing link for an object type. Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read api:ontologies-write`. - operationId: applyActionBatchV2 - x-operationVerb: applyBatch - x-auditCategory: ontologyDataTransform + following operation scopes: `api:ontologies-read`. + operationId: getOutgoingLinkType + x-operationVerb: getOutgoingLinkType + x-auditCategory: ontologyMetaDataLoad x-releaseStage: STABLE security: - OAuth2: - api:ontologies-read - - api:ontologies-write - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The unique Resource Identifier (RID) of the Ontology that contains the object type. To look up your Ontology RID, please use the + **List ontologies** endpoint or check the **Ontology Manager** application. in: path - name: ontology + name: ontologyRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/OntologyRid" + example: ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: | - The API name of the action to apply. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. + The API name of the object type. To find the API name, use the **List object types** endpoint or + check the **Ontology Manager** application. in: path - name: action + name: objectType required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" + $ref: "#/components/schemas/ObjectTypeApiName" + example: Employee - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false + The API name of the outgoing link. + To find the API name for your link type, check the **Ontology Manager**. + in: path + name: linkType + required: true schema: - $ref: "#/components/schemas/SdkPackageName" + $ref: "#/components/schemas/LinkTypeApiName" + example: directReport + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/LinkTypeSide" + example: + apiName: directReport + objectTypeApiName: Employee + cardinality: MANY + description: Success response. + /api/v1/datasets: + post: + description: | + Creates a new Dataset. A default branch - `master` for most enrollments - will be created on the Dataset. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + operationId: createDataset + x-operationVerb: create + x-auditCategory: metaDataCreate + x-releaseStage: STABLE + security: + - OAuth2: + - api:datasets-write + - BearerAuth: [] requestBody: content: application/json: schema: - $ref: "#/components/schemas/BatchApplyActionRequestV2" + $ref: "#/components/schemas/CreateDatasetRequest" example: - requests: - - parameters: - id: 80060 - newName: Anna Smith-Doe - - parameters: - id: 80061 - newName: Joe Bloggs + name: My Dataset + parentFolderRid: ri.foundry.main.folder.bfe58487-4c56-4c58-aba7-25defd6163c4 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/BatchApplyActionResponseV2" - example: {} - description: Success response. - /api/v2/ontologies/{ontology}/actions/{action}/applyAsync: - post: - description: "Applies an action using the given parameters. \n\nChanges to the Ontology are eventually consistent and may take some time to be visible.\n\nNote that [parameter default values](/docs/foundry/action-types/parameters-default-value/) are not currently supported by\nthis endpoint.\n\nThird-party applications using this endpoint via OAuth2 must request the\nfollowing operation scopes: `api:ontologies-read api:ontologies-write`.\n" - operationId: applyActionAsyncV2 - x-operationVerb: applyAsync - x-auditCategory: ontologyDataTransform - x-releaseStage: PRIVATE_BETA + $ref: "#/components/schemas/Dataset" + example: + rid: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + path: /Empyrean Airlines/My Important Project/My Dataset + description: "" + /api/v1/datasets/{datasetRid}: + get: + description: | + Gets the Dataset with the given DatasetRid. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + operationId: getDataset + x-operationVerb: get + x-auditCategory: metaDataAccess + x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read - - api:ontologies-write + - api:datasets-read + - BearerAuth: [] + parameters: + - in: path + name: datasetRid + required: true + schema: + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + responses: + "200": + content: + application/json: + schema: + $ref: "#/components/schemas/Dataset" + example: + rid: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + name: My Dataset + parentFolderRid: ri.foundry.main.folder.bfe58487-4c56-4c58-aba7-25defd6163c4 + description: "" + /api/v1/datasets/{datasetRid}/readTable: + get: + description: | + Gets the content of a dataset as a table in the specified format. + + This endpoint currently does not support views (Virtual datasets composed of other datasets). + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + operationId: readTable + x-operationVerb: read + x-auditCategory: dataExport + x-releaseStage: STABLE + security: + - OAuth2: + - api:datasets-read - BearerAuth: [] parameters: - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + The RID of the Dataset. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/DatasetRid" + - description: The identifier (name) of the Branch. + in: query + name: branchId + required: false + schema: + $ref: "#/components/schemas/BranchId" + - description: The Resource Identifier (RID) of the start Transaction. + in: query + name: startTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + - description: The Resource Identifier (RID) of the end Transaction. + in: query + name: endTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" - description: | - The API name of the action to apply. To find the API name for your action, use the **List action types** - endpoint or check the **Ontology Manager**. - in: path - name: action + The export format. Must be `ARROW` or `CSV`. + in: query + name: format required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: rename-employee + $ref: "#/components/schemas/TableExportFormat" + example: CSV - description: | - The repository associated with a marketplace installation. + A subset of the dataset columns to include in the result. Defaults to all columns. in: query - name: artifactRepository + name: columns required: false schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" + type: array + items: + type: string + x-safety: unsafe - description: | - The package name of the generated SDK. + A limit on the number of rows to return. Note that row ordering is non-deterministic. in: query - name: packageName + name: rowLimit required: false schema: - $ref: "#/components/schemas/SdkPackageName" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/AsyncApplyActionRequestV2" - example: - parameters: - id: 80060 - newName: Anna Smith-Doe + type: integer + x-safety: unsafe responses: "200": content: - application/json: + '*/*': schema: - $ref: "#/components/schemas/AsyncApplyActionResponseV2" - example: - operationId: ri.actions.main.action.c61d9ab5-2919-4127-a0a1-ac64c0ce6367 - description: Success response. - /api/v2/ontologies/{ontology}/objectSets/createTemporary: + format: binary + type: string + description: The content stream. + /api/v1/datasets/{datasetRid}/branches: post: - description: "Creates a temporary `ObjectSet` from the given definition. \n\nThird-party applications using this endpoint via OAuth2 must request the\nfollowing operation scopes: `api:ontologies-read api:ontologies-write`.\n" - operationId: createTemporaryObjectSetV2 - x-operationVerb: createTemporary - x-auditCategory: ontologyLogicCreate - x-releaseStage: PRIVATE_BETA + description: | + Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + operationId: createBranch + x-operationVerb: create + x-auditCategory: metaDataCreate + x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read - - api:ontologies-write + - api:datasets-write - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset on which to create the Branch. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da requestBody: content: application/json: schema: - $ref: "#/components/schemas/CreateTemporaryObjectSetRequestV2" + $ref: "#/components/schemas/CreateBranchRequest" example: - objectSet: - type: base - objectType: Employee + branchId: my-branch responses: "200": - description: Success response. content: application/json: schema: - $ref: "#/components/schemas/CreateTemporaryObjectSetResponseV2" + $ref: "#/components/schemas/Branch" example: - objectSetRid: ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053 - /api/v2/ontologies/{ontology}/objectSets/{objectSetRid}: + branchId: my-branch + description: "" get: - description: "Gets the definition of the `ObjectSet` with the given RID. \n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" - operationId: getObjectSetV2 - x-operationVerb: get - x-auditCategory: ontologyLogicAccess - x-releaseStage: PRIVATE_BETA + description: | + Lists the Branches of a Dataset. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + operationId: listBranches + x-operationVerb: list + x-auditCategory: metaDataAccess + x-releaseStage: STABLE + security: + - OAuth2: + - api:datasets-read + - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset on which to list Branches. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - description: | - The RID of the object set. - in: path - name: objectSetRid - required: true + The desired size of the page to be returned. Defaults to 1,000. + See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. + in: query + name: pageSize + required: false schema: - $ref: "#/components/schemas/ObjectSetRid" - example: ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053 + $ref: "#/components/schemas/PageSize" + - in: query + name: pageToken + required: false + schema: + $ref: "#/components/schemas/PageToken" responses: "200": - description: Success response. content: application/json: schema: - $ref: "#/components/schemas/ObjectSet" + $ref: "#/components/schemas/ListBranchesResponse" example: + nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - objectSet: - type: base - objectType: Employee - /api/v2/ontologies/{ontology}/objectSets/loadObjects: - post: + - branchId: master + transactionRid: ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4 + - branchId: test-v2 + transactionRid: ri.foundry.main.transaction.fc9feb4b-34e4-4bfd-9e4f-b6425fbea85f + - branchId: my-branch + description: "" + /api/v1/datasets/{datasetRid}/branches/{branchId}: + get: description: | - Load the ontology objects present in the `ObjectSet` from the provided object set definition. - - For Object Storage V1 backed objects, this endpoint returns a maximum of 10,000 objects. After 10,000 objects have been returned and if more objects - are available, attempting to load another page will result in an `ObjectsExceededLimit` error being returned. There is no limit on Object Storage V2 backed objects. - - Note that null value properties will not be returned. + Get a Branch of a Dataset. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: loadObjectSetV2 - x-operationVerb: load - x-auditCategory: ontologyDataLoad + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + operationId: getBranch + x-operationVerb: get + x-auditCategory: metaDataAccess x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset that contains the Branch. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false - schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" - - description: | - The package name of the generated SDK. - in: query - name: packageName - required: false + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: The identifier (name) of the Branch. + in: path + name: branchId + required: true schema: - $ref: "#/components/schemas/SdkPackageName" - requestBody: - content: - application/json: - schema: - $ref: "#/components/schemas/LoadObjectSetRequestV2" - example: - objectSet: - type: base - objectType: Employee - pageSize: 10000 - nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv + $ref: "#/components/schemas/BranchId" + example: master responses: "200": content: application/json: schema: - $ref: "#/components/schemas/LoadObjectSetResponseV2" + $ref: "#/components/schemas/Branch" example: - data: - - __rid: ri.phonograph2-objects.main.object.5b5dbc28-7f05-4e83-a33a-1e5b851 - __primaryKey: 50030 - __apiName: Employee - employeeId: 50030 - firstName: John - lastName: Smith - age: 21 - - __rid: ri.phonograph2-objects.main.object.88a6fccb-f333-46d6-a07e-7725c5f18b61 - __primaryKey: 20090 - __apiName: Employee - employeeId: 20090 - firstName: John - lastName: Haymore - age: 27 - description: Success response. - /api/v2/ontologies/{ontology}/objectSets/aggregate: - post: - description: "Aggregates the ontology objects present in the `ObjectSet` from the provided object set definition. \n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`.\n" - operationId: aggregateObjectSetV2 - x-operationVerb: aggregate - x-auditCategory: ontologyDataSearch + branchId: master + transactionRid: ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4 + description: "" + delete: + description: | + Deletes the Branch with the given BranchId. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + operationId: deleteBranch + x-operationVerb: delete + x-auditCategory: metaDataDelete x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-write - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset that contains the Branch. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The repository associated with a marketplace installation. - in: query - name: artifactRepository - required: false + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: The identifier (name) of the Branch. + in: path + name: branchId + required: true schema: - $ref: "#/components/schemas/ArtifactRepositoryRid" + $ref: "#/components/schemas/BranchId" + example: my-branch + responses: + "204": + description: Branch deleted. + /api/v1/datasets/{datasetRid}/transactions: + post: + description: | + Creates a Transaction on a Branch of a Dataset. + + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + operationId: createTransaction + x-operationVerb: create + x-auditCategory: metaDataCreate + x-releaseStage: STABLE + security: + - OAuth2: + - api:datasets-write + - BearerAuth: [] + parameters: + - description: The Resource Identifier (RID) of the Dataset on which to create the Transaction. + in: path + name: datasetRid + required: true + schema: + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da - description: | - The package name of the generated SDK. + The identifier (name) of the Branch on which to create the Transaction. Defaults to `master` for most enrollments. in: query - name: packageName + name: branchId required: false schema: - $ref: "#/components/schemas/SdkPackageName" + $ref: "#/components/schemas/BranchId" requestBody: content: application/json: schema: - $ref: "#/components/schemas/AggregateObjectSetRequestV2" + $ref: "#/components/schemas/CreateTransactionRequest" + example: + transactionType: SNAPSHOT responses: "200": content: application/json: schema: - $ref: "#/components/schemas/AggregateObjectsResponseV2" - example: - data: - - metrics: - - name: min_tenure - value: 1 - - name: avg_tenure - value: 3 - group: - startDate: - startValue: 2020-01-01 - endValue: 2020-06-01 - city: New York City - - metrics: - - name: min_tenure - value: 2 - - name: avg_tenure - value: 3 - group: - startDate: - startValue: 2020-01-01 - endValue: 2020-06-01 - city: San Francisco - description: Success response. - /api/v2/ontologies/{ontology}/objectTypes: + $ref: "#/components/schemas/Transaction" + example: + rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 + transactionType: SNAPSHOT + status: OPEN + createdTime: 2022-10-10T12:23:11.152Z + description: "" + /api/v1/datasets/{datasetRid}/transactions/{transactionRid}: get: description: | - Lists the object types for the given Ontology. - - Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are - more results available, at least one result will be present in the - response. + Gets a Transaction of a Dataset. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listObjectTypesV2 - x-operationVerb: list - x-auditCategory: ontologyMetaDataLoad + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`. + operationId: getTransaction + x-operationVerb: get + x-auditCategory: metaDataAccess x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset that contains the Transaction. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The desired size of the page to be returned. Defaults to 500. - See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. - in: query - name: pageSize - required: false - schema: - $ref: "#/components/schemas/PageSize" - - in: query - name: pageToken - required: false + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: The Resource Identifier (RID) of the Transaction. + in: path + name: transactionRid + required: true schema: - $ref: "#/components/schemas/PageToken" + $ref: "#/components/schemas/TransactionRid" + example: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListObjectTypesV2Response" + $ref: "#/components/schemas/Transaction" example: - nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv - data: - - apiName: employee - description: A full-time or part-time employee of our firm - displayName: Employee - status: ACTIVE - primaryKey: employeeId - properties: - employeeId: - dataType: - type: integer - fullName: - dataType: - type: string - office: - description: The unique ID of the employee's primary assigned office - dataType: - type: string - startDate: - description: "The date the employee was hired (most recently, if they were re-hired)" - dataType: - type: date - rid: ri.ontology.main.object-type.401ac022-89eb-4591-8b7e-0a912b9efb44 - - apiName: office - description: A physical location (not including rented co-working spaces) - displayName: Office - status: ACTIVE - primaryKey: officeId - properties: - officeId: - dataType: - type: string - address: - description: The office's physical address (not necessarily shipping address) - dataType: - type: string - capacity: - description: The maximum seated-at-desk capacity of the office (maximum fire-safe capacity may be higher) - dataType: - type: integer - rid: ri.ontology.main.object-type.9a0e4409-9b50-499f-a637-a3b8334060d9 - description: Success response. - /api/v2/ontologies/{ontology}/objectTypes/{objectType}: - get: + rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 + transactionType: SNAPSHOT + status: OPEN + createdTime: 2022-10-10T12:20:15.166Z + description: "" + /api/v1/datasets/{datasetRid}/transactions/{transactionRid}/commit: + post: description: | - Gets a specific object type with the given API name. + Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is + updated to point to the Transaction. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getObjectTypeV2 - x-operationVerb: get - x-auditCategory: ontologyMetaDataLoad + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + operationId: commitTransaction + x-operationVerb: commit + x-auditCategory: metaDataUpdate x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-write - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset that contains the Transaction. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: The Resource Identifier (RID) of the Transaction. in: path - name: objectType + name: transactionRid required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee + $ref: "#/components/schemas/TransactionRid" + example: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ObjectTypeV2" + $ref: "#/components/schemas/Transaction" example: - apiName: employee - description: A full-time or part-time employee of our firm - displayName: Employee - status: ACTIVE - primaryKey: employeeId - properties: - employeeId: - dataType: - type: integer - fullName: - dataType: - type: string - office: - description: The unique ID of the employee's primary assigned office - dataType: - type: string - startDate: - description: "The date the employee was hired (most recently, if they were re-hired)" - dataType: - type: date - rid: ri.ontology.main.object-type.0381eda6-69bb-4cb7-8ba0-c6158e094a04 - description: Success response. - /api/v2/ontologies/{ontology}/objectTypes/{objectType}/fullMetadata: - get: + rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 + transactionType: SNAPSHOT + status: COMMITTED + createdTime: 2022-10-10T12:20:15.166Z + closedTime: 2022-10-10T12:23:11.152Z + description: "" + /api/v1/datasets/{datasetRid}/transactions/{transactionRid}/abort: + post: description: | - Gets the full metadata for a specific object type with the given API name. + Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is + not updated. - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getObjectTypeFullMetadata - x-operationVerb: getFullMetadata - x-auditCategory: ontologyMetaDataLoad - x-releaseStage: PRIVATE_BETA + Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`. + operationId: abortTransaction + x-operationVerb: abort + x-auditCategory: metaDataUpdate + x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-write - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset that contains the Transaction. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager**. + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: The Resource Identifier (RID) of the Transaction. in: path - name: objectType + name: transactionRid required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: employee - - description: | - A boolean flag that, when set to true, enables the use of beta features in preview mode. - in: query - name: preview - required: false - schema: - $ref: "#/components/schemas/PreviewMode" + $ref: "#/components/schemas/TransactionRid" + example: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ObjectTypeFullMetadata" - description: Success response. - /api/v2/ontologies/{ontology}/actionTypes: + $ref: "#/components/schemas/Transaction" + example: + rid: ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496 + transactionType: SNAPSHOT + status: ABORTED + createdTime: 2022-10-10T12:20:15.166Z + closedTime: 2022-10-10T12:23:11.152Z + description: "" + /api/v1/datasets/{datasetRid}/files: get: - description: | - Lists the action types for the given Ontology. - - Each page may be smaller than the requested page size. However, it is guaranteed that if there are more - results available, at least one result will be present in the response. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: listActionTypesV2 + description: "Lists Files contained in a Dataset. By default files are listed on the latest view of the default \nbranch - `master` for most enrollments.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\n\nTo **list files on a specific Branch** specify the Branch's identifier as `branchId`. This will include the most\nrecent version of all files since the latest snapshot transaction, or the earliest ancestor transaction of the \nbranch if there are no snapshot transactions.\n\nTo **list files on the resolved view of a transaction** specify the Transaction's resource identifier\nas `endTransactionRid`. This will include the most recent version of all files since the latest snapshot\ntransaction, or the earliest ancestor transaction if there are no snapshot transactions.\n\nTo **list files on the resolved view of a range of transactions** specify the the start transaction's resource\nidentifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`. This\nwill include the most recent version of all files since the `startTransactionRid` up to the `endTransactionRid`.\nNote that an intermediate snapshot transaction will remove all files from the view. Behavior is undefined when \nthe start and end transactions do not belong to the same root-to-leaf path.\n\nTo **list files on a specific transaction** specify the Transaction's resource identifier as both the \n`startTransactionRid` and `endTransactionRid`. This will include only files that were modified as part of that\nTransaction.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\n" + operationId: listFiles x-operationVerb: list - x-auditCategory: ontologyMetaDataLoad + x-auditCategory: metaDataAccess x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset on which to list Files. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir + $ref: "#/components/schemas/DatasetRid" + - description: The identifier (name) of the Branch on which to list Files. Defaults to `master` for most enrollments. + in: query + name: branchId + required: false + schema: + $ref: "#/components/schemas/BranchId" + - description: The Resource Identifier (RID) of the start Transaction. + in: query + name: startTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + - description: The Resource Identifier (RID) of the end Transaction. + in: query + name: endTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" - description: | - The desired size of the page to be returned. Defaults to 500. + The desired size of the page to be returned. Defaults to 1,000. See [page sizes](/docs/foundry/api/general/overview/paging/#page-sizes) for details. in: query name: pageSize @@ -12551,326 +12695,365 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ListActionTypesResponseV2" + $ref: "#/components/schemas/ListFilesResponse" example: nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv data: - - apiName: promote-employee - description: Update an employee's title and compensation - parameters: - employeeId: - dataType: - type: integer - newTitle: - dataType: - type: string - newCompensation: - dataType: - type: double - rid: ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167 - - apiName: move-office - description: Update an office's physical location - parameters: - officeId: - dataType: - type: string - newAddress: - description: The office's new physical address (not necessarily shipping address) - dataType: - type: string - newCapacity: - description: The maximum seated-at-desk capacity of the new office (maximum fire-safe capacity may be higher) - dataType: - type: integer - rid: ri.ontology.main.action-type.9f84017d-cf17-4fa8-84c3-8e01e5d594f2 - description: Success response. - /api/v2/ontologies/{ontology}/actionTypes/{actionType}: - get: - description: | - Gets a specific action type with the given API name. - - Third-party applications using this endpoint via OAuth2 must request the following operation scope: `api:ontologies-read`. - operationId: getActionTypeV2 - x-operationVerb: get - x-auditCategory: ontologyMetaDataLoad + - path: q3-data/my-file.csv + transactionRid: ri.foundry.main.transaction.bf9515c2-02d4-4703-8f84-c3b3c190254d + sizeBytes: 74930 + updatedTime: 2022-10-10T16:44:55.192Z + - path: q2-data/my-file.csv + transactionRid: ri.foundry.main.transaction.d8db1cfc-9f8b-4bad-9d8c-00bd818a37c5 + sizeBytes: 47819 + updatedTime: 2022-07-12T10:12:50.919Z + - path: q2-data/my-other-file.csv + transactionRid: ri.foundry.main.transaction.d8db1cfc-9f8b-4bad-9d8c-00bd818a37c5 + sizeBytes: 55320 + updatedTime: 2022-07-12T10:12:46.112Z + description: "" + /api/v1/datasets/{datasetRid}/files:upload: + post: + description: "Uploads a File to an existing Dataset.\nThe body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`.\n\nBy default the file is uploaded to a new transaction on the default branch - `master` for most enrollments.\nIf the file already exists only the most recent version will be visible in the updated view.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. \n\nTo **upload a file to a specific Branch** specify the Branch's identifier as `branchId`. A new transaction will \nbe created and committed on this branch. By default the TransactionType will be `UPDATE`, to override this\ndefault specify `transactionType` in addition to `branchId`. \nSee [createBranch](/docs/foundry/api/datasets-resources/branches/create-branch/) to create a custom branch.\n\nTo **upload a file on a manually opened transaction** specify the Transaction's resource identifier as\n`transactionRid`. This is useful for uploading multiple files in a single transaction. \nSee [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to open a transaction.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.\n" + operationId: uploadFile + x-operationVerb: upload + x-auditCategory: dataCreate x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-write - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset on which to upload the File. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The name of the action type in the API. - in: path - name: actionType + $ref: "#/components/schemas/DatasetRid" + - description: The File's path within the Dataset. + in: query + name: filePath required: true schema: - $ref: "#/components/schemas/ActionTypeApiName" - example: promote-employee + $ref: "#/components/schemas/FilePath" + example: q3-data%2fmy-file.csv + - description: The identifier (name) of the Branch on which to upload the File. Defaults to `master` for most enrollments. + in: query + name: branchId + required: false + schema: + $ref: "#/components/schemas/BranchId" + - description: The type of the Transaction to create when using branchId. Defaults to `UPDATE`. + in: query + name: transactionType + required: false + schema: + $ref: "#/components/schemas/TransactionType" + - description: The Resource Identifier (RID) of the open Transaction on which to upload the File. + in: query + name: transactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + requestBody: + content: + '*/*': + schema: + format: binary + type: string responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ActionTypeV2" + $ref: "#/components/schemas/File" example: - data: - apiName: promote-employee - description: Update an employee's title and compensation - parameters: - employeeId: - dataType: - type: integer - newTitle: - dataType: - type: string - newCompensation: - dataType: - type: double - rid: ri.ontology.main.action-type.7ed72754-7491-428a-bb18-4d7296eb2167 - description: Success response. - /api/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes: + path: q3-data/my-file.csv + transactionRid: ri.foundry.main.transaction.bf9515c2-02d4-4703-8f84-c3b3c190254d + sizeBytes: 74930 + updatedTime: 2022-10-10T16:44:55.192Z + description: "" + /api/v1/datasets/{datasetRid}/files/{filePath}: get: - description: | - List the outgoing links for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: listOutgoingLinkTypesV2 - x-operationVerb: listOutgoingLinkTypes - x-auditCategory: ontologyMetaDataLoad + description: "Gets metadata about a File contained in a Dataset. By default this retrieves the file's metadata from the latest\nview of the default branch - `master` for most enrollments.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. \n\nTo **get a file's metadata from a specific Branch** specify the Branch's identifier as `branchId`. This will \nretrieve metadata for the most recent version of the file since the latest snapshot transaction, or the earliest\nancestor transaction of the branch if there are no snapshot transactions.\n\nTo **get a file's metadata from the resolved view of a transaction** specify the Transaction's resource identifier\nas `endTransactionRid`. This will retrieve metadata for the most recent version of the file since the latest snapshot\ntransaction, or the earliest ancestor transaction if there are no snapshot transactions.\n\nTo **get a file's metadata from the resolved view of a range of transactions** specify the the start transaction's\nresource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.\nThis will retrieve metadata for the most recent version of the file since the `startTransactionRid` up to the \n`endTransactionRid`. Behavior is undefined when the start and end transactions do not belong to the same root-to-leaf path.\n\nTo **get a file's metadata from a specific transaction** specify the Transaction's resource identifier as both the \n`startTransactionRid` and `endTransactionRid`.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\n" + operationId: getFileMetadata + x-operationVerb: get + x-auditCategory: metaDataAccess x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset that contains the File. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager** application. + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: The File's path within the Dataset. in: path - name: objectType + name: filePath required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: Flight - - description: The desired size of the page to be returned. + $ref: "#/components/schemas/FilePath" + example: q3-data%2fmy-file.csv + - description: The identifier (name) of the Branch that contains the File. Defaults to `master` for most enrollments. in: query - name: pageSize + name: branchId required: false schema: - $ref: "#/components/schemas/PageSize" - - in: query - name: pageToken + $ref: "#/components/schemas/BranchId" + - description: The Resource Identifier (RID) of the start Transaction. + in: query + name: startTransactionRid required: false schema: - $ref: "#/components/schemas/PageToken" + $ref: "#/components/schemas/TransactionRid" + - description: The Resource Identifier (RID) of the end Transaction. + in: query + name: endTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" responses: "200": content: application/json: schema: - $ref: "#/components/schemas/ListOutgoingLinkTypesResponseV2" + $ref: "#/components/schemas/File" example: - nextPageToken: v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv - data: - - apiName: originAirport - objectTypeApiName: Airport - cardinality: ONE - foreignKeyPropertyApiName: originAirportId - description: Success response. - /api/v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType}: - get: - description: | - Get an outgoing link for an object type. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: getOutgoingLinkTypeV2 - x-operationVerb: getOutgoingLinkType - x-auditCategory: ontologyMetaDataLoad + path: q3-data/my-file.csv + transactionRid: ri.foundry.main.transaction.bf9515c2-02d4-4703-8f84-c3b3c190254d + sizeBytes: 74930 + updatedTime: 2022-10-10T16:44:55.192Z + description: "" + delete: + description: "Deletes a File from a Dataset. By default the file is deleted in a new transaction on the default \nbranch - `master` for most enrollments. The file will still be visible on historical views.\n\n#### Advanced Usage\n \nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions.\n\nTo **delete a File from a specific Branch** specify the Branch's identifier as `branchId`. A new delete Transaction \nwill be created and committed on this branch.\n\nTo **delete a File using a manually opened Transaction**, specify the Transaction's resource identifier \nas `transactionRid`. The transaction must be of type `DELETE`. This is useful for deleting multiple files in a\nsingle transaction. See [createTransaction](/docs/foundry/api/datasets-resources/transactions/create-transaction/) to \nopen a transaction.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-write`.\n" + operationId: deleteFile + x-operationVerb: delete + x-auditCategory: dataDelete + x-releaseStage: STABLE + security: + - OAuth2: + - api:datasets-write + - BearerAuth: [] + parameters: + - description: The Resource Identifier (RID) of the Dataset on which to delete the File. + in: path + name: datasetRid + required: true + schema: + $ref: "#/components/schemas/DatasetRid" + example: ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da + - description: The File path within the Dataset. + in: path + name: filePath + required: true + schema: + $ref: "#/components/schemas/FilePath" + example: q3-data%2fmy-file.csv + - description: The identifier (name) of the Branch on which to delete the File. Defaults to `master` for most enrollments. + in: query + name: branchId + required: false + schema: + $ref: "#/components/schemas/BranchId" + - description: The Resource Identifier (RID) of the open delete Transaction on which to delete the File. + in: query + name: transactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + responses: + "204": + description: File deleted. + /api/v1/datasets/{datasetRid}/files/{filePath}/content: + get: + description: "Gets the content of a File contained in a Dataset. By default this retrieves the file's content from the latest\nview of the default branch - `master` for most enrollments.\n\n#### Advanced Usage\n\nSee [Datasets Core Concepts](/docs/foundry/data-integration/datasets/) for details on using branches and transactions. \n\nTo **get a file's content from a specific Branch** specify the Branch's identifier as `branchId`. This will \nretrieve the content for the most recent version of the file since the latest snapshot transaction, or the\nearliest ancestor transaction of the branch if there are no snapshot transactions.\n\nTo **get a file's content from the resolved view of a transaction** specify the Transaction's resource identifier\nas `endTransactionRid`. This will retrieve the content for the most recent version of the file since the latest\nsnapshot transaction, or the earliest ancestor transaction if there are no snapshot transactions.\n\nTo **get a file's content from the resolved view of a range of transactions** specify the the start transaction's\nresource identifier as `startTransactionRid` and the end transaction's resource identifier as `endTransactionRid`.\nThis will retrieve the content for the most recent version of the file since the `startTransactionRid` up to the \n`endTransactionRid`. Note that an intermediate snapshot transaction will remove all files from the view. Behavior\nis undefined when the start and end transactions do not belong to the same root-to-leaf path.\n\nTo **get a file's content from a specific transaction** specify the Transaction's resource identifier as both the \n`startTransactionRid` and `endTransactionRid`.\n\nThird-party applications using this endpoint via OAuth2 must request the following operation scope: `api:datasets-read`.\n" + operationId: getFileContent + x-operationVerb: read + x-auditCategory: dataExport x-releaseStage: STABLE security: - OAuth2: - - api:ontologies-read + - api:datasets-read - BearerAuth: [] parameters: - - description: | - The API name of the ontology. To find the API name, use the **List ontologies** endpoint or - check the **Ontology Manager**. + - description: The Resource Identifier (RID) of the Dataset that contains the File. in: path - name: ontology + name: datasetRid required: true schema: - $ref: "#/components/schemas/OntologyIdentifier" - example: palantir - - description: | - The API name of the object type. To find the API name, use the **List object types** endpoint or - check the **Ontology Manager** application. + $ref: "#/components/schemas/DatasetRid" + - description: The File's path within the Dataset. in: path - name: objectType + name: filePath required: true schema: - $ref: "#/components/schemas/ObjectTypeApiName" - example: Employee - - description: | - The API name of the outgoing link. - To find the API name for your link type, check the **Ontology Manager**. - in: path - name: linkType - required: true + $ref: "#/components/schemas/FilePath" + example: q3-data%2fmy-file.csv + - description: The identifier (name) of the Branch that contains the File. Defaults to `master` for most enrollments. + in: query + name: branchId + required: false schema: - $ref: "#/components/schemas/LinkTypeApiName" - example: directReport + $ref: "#/components/schemas/BranchId" + - description: The Resource Identifier (RID) of the start Transaction. + in: query + name: startTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + - description: The Resource Identifier (RID) of the end Transaction. + in: query + name: endTransactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" responses: "200": content: - application/json: + '*/*': schema: - $ref: "#/components/schemas/LinkTypeSideV2" - example: - apiName: directReport - objectTypeApiName: Employee - cardinality: MANY - description: Success response. - /api/v2/ontologies/attachments/upload: - post: + format: binary + type: string + description: "" + /api/v1/datasets/{datasetRid}/schema: + put: description: | - Upload an attachment to use in an action. Any attachment which has not been linked to an object via - an action within one hour after upload will be removed. - Previously mapped attachments which are not connected to any object anymore are also removed on - a biweekly basis. - The body of the request must contain the binary content of the file and the `Content-Type` header must be `application/octet-stream`. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-write`. - operationId: uploadAttachmentV2 - x-operationVerb: upload - x-auditCategory: dataCreate - x-releaseStage: STABLE + Puts a Schema on an existing Dataset and Branch. + operationId: putSchema + x-operationVerb: replaceSchema + x-auditCategory: metaDataUpdate + x-releaseStage: PRIVATE_BETA security: - OAuth2: - - api:ontologies-write + - api:datasets-write - BearerAuth: [] parameters: - - description: The size in bytes of the file content being uploaded. - in: header - name: Content-Length - required: true - schema: - $ref: "#/components/schemas/ContentLength" - - description: The media type of the file being uploaded. - in: header - name: Content-Type + - description: | + The RID of the Dataset on which to put the Schema. + in: path + name: datasetRid required: true schema: - $ref: "#/components/schemas/ContentType" - - description: The name of the file being uploaded. + $ref: "#/components/schemas/DatasetRid" + - description: | + The ID of the Branch on which to put the Schema. in: query - name: filename - required: true + name: branchId + required: false schema: - $ref: "#/components/schemas/Filename" - example: My Image.jpeg + $ref: "#/components/schemas/BranchId" + - in: query + name: preview + required: false + schema: + $ref: "#/components/schemas/PreviewMode" + example: true requestBody: content: - '*/*': + application/json: schema: - format: binary - type: string + type: object + x-type: + type: external + java: com.palantir.foundry.schemas.api.types.FoundrySchema responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/AttachmentV2" - example: - rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - filename: My Image.jpeg - sizeBytes: 393469 - mediaType: image/jpeg - description: Success response. - /api/v2/ontologies/attachments/{attachmentRid}/content: + "204": + description: "" get: description: | - Get the content of an attachment. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: getAttachmentContentV2 - x-operationVerb: read - x-auditCategory: dataExport - x-releaseStage: STABLE + Retrieves the Schema for a Dataset and Branch, if it exists. + operationId: getSchema + x-operationVerb: getSchema + x-auditCategory: metaDataAccess + x-releaseStage: PRIVATE_BETA security: - OAuth2: - - api:ontologies-read + - api:datasets-read - BearerAuth: [] parameters: - - description: The RID of the attachment. + - description: | + The RID of the Dataset. in: path - name: attachmentRid + name: datasetRid required: true schema: - $ref: "#/components/schemas/AttachmentRid" - example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + $ref: "#/components/schemas/DatasetRid" + - description: | + The ID of the Branch. + in: query + name: branchId + required: false + schema: + $ref: "#/components/schemas/BranchId" + - description: | + The TransactionRid that contains the Schema. + in: query + name: transactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + - in: query + name: preview + required: false + schema: + $ref: "#/components/schemas/PreviewMode" + example: true responses: "200": content: - '*/*': + application/json: schema: - format: binary - type: string - description: Success response. - /api/v2/ontologies/attachments/{attachmentRid}: - get: + type: object + x-type: + type: external + java: com.palantir.foundry.schemas.api.types.FoundrySchema + description: "" + "204": + description: no schema + delete: description: | - Get the metadata of an attachment. - - Third-party applications using this endpoint via OAuth2 must request the - following operation scopes: `api:ontologies-read`. - operationId: getAttachmentV2 - x-operationVerb: get - x-auditCategory: metaDataAccess - x-releaseStage: STABLE + Deletes the Schema from a Dataset and Branch. + operationId: deleteSchema + x-operationVerb: deleteSchema + x-auditCategory: metaDataDelete + x-releaseStage: PRIVATE_BETA security: - OAuth2: - - api:ontologies-read + - api:datasets-write - BearerAuth: [] parameters: - - description: The RID of the attachment. + - description: | + The RID of the Dataset on which to delete the schema. in: path - name: attachmentRid + name: datasetRid required: true schema: - $ref: "#/components/schemas/AttachmentRid" - example: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f + $ref: "#/components/schemas/DatasetRid" + - description: | + The ID of the Branch on which to delete the schema. + in: query + name: branchId + required: false + schema: + $ref: "#/components/schemas/BranchId" + - description: | + The RID of the Transaction on which to delete the schema. + in: query + name: transactionRid + required: false + schema: + $ref: "#/components/schemas/TransactionRid" + - in: query + name: preview + required: false + schema: + $ref: "#/components/schemas/PreviewMode" + example: true responses: - "200": - content: - application/json: - schema: - $ref: "#/components/schemas/AttachmentV2" - example: - rid: ri.attachments.main.attachment.bb32154e-e043-4b00-9461-93136ca96b6f - filename: My Image.jpeg - sizeBytes: 393469 - mediaType: image/jpeg - description: Success response. + "204": + description: Schema deleted. diff --git a/scripts/generate_sdk.sh b/scripts/generate_sdk.sh index d6e24c0d..ecac24fd 100755 --- a/scripts/generate_sdk.sh +++ b/scripts/generate_sdk.sh @@ -12,8 +12,6 @@ EXCLUDED_PATHS=( "tmp" # Docs examples live here. These will go away eventually. "assets" - # Unit tets are written manually - "test" "venv" ) @@ -22,7 +20,7 @@ TMP_DIR=$(mktemp -d) for EXCLUDED_PATH in "${EXCLUDED_PATHS[@]}"; do TARGET_PATH="$TMP_DIR/$EXCLUDED_PATH" mkdir -p $(dirname $TARGET_PATH) - cp -r $EXCLUDED_PATH $TARGET_PATH + cp -r $EXCLUDED_PATH $TARGET_PATH > /dev/null 2>&1 || true done # Remove everything in the current directory diff --git a/scripts/generate_spec.sh b/scripts/generate_spec.sh index 82618e74..89ad5eda 100755 --- a/scripts/generate_spec.sh +++ b/scripts/generate_spec.sh @@ -8,13 +8,12 @@ mkdir -p $TMP_DIR API_GATEWAY_VERSION=$( wget -q -O - "${MAVEN_REPO_PATH}/maven-metadata.xml" | \ yq -p xml -r '.metadata.versioning.release' ) +echo Downloading $API_GATEWAY_VERSION... mkdir -p "${TMP_DIR}" wget -P "${TMP_DIR}" "${MAVEN_REPO_PATH}/${API_GATEWAY_VERSION}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" &> /dev/null -tar -xf "${TMP_DIR}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" -C "${TMP_DIR}" --strip-components=4 "${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}/asset/palantir/ir/openapi-ir.json" -# tar -xf "${TMP_DIR}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" -C "${TMP_DIR}" --strip-components=4 "${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}/asset/palantir/ir-v2/openapi-ir.json" -tar -xf "${TMP_DIR}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" -C "${TMP_DIR}" --strip-components=4 "${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}/asset/palantir/ir/v2.json" -# tar -xf "${TMP_DIR}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" -C "${TMP_DIR}" --strip-components=4 "${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}/asset/palantir/ir-v2/v2.json" +tar -xf "${TMP_DIR}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" -C "${TMP_DIR}" --strip-components=4 "${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}/asset/palantir/ir-v2/openapi-ir.json" +tar -xf "${TMP_DIR}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" -C "${TMP_DIR}" --strip-components=4 "${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}/asset/palantir/ir-v2/v2.json" tar -xf "${TMP_DIR}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" -C "${TMP_DIR}" --strip-components=4 "${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}/asset/palantir/new-content/api-definition.yml" tar -xf "${TMP_DIR}/${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}.sls.tgz" -C "${TMP_DIR}" --strip-components=2 "${MAVEN_CONJURE_ARTIFACT_ID}-${API_GATEWAY_VERSION}/deployment/manifest.yml" diff --git a/test/__init__.py b/test/__init__.py deleted file mode 100644 index 490e9ab8..00000000 --- a/test/__init__.py +++ /dev/null @@ -1,13 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. diff --git a/test/auth/__init__.py b/test/auth/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/test/auth/test_foundry_auth_token_client.py b/test/auth/test_foundry_auth_token_client.py deleted file mode 100644 index f8a4389f..00000000 --- a/test/auth/test_foundry_auth_token_client.py +++ /dev/null @@ -1,71 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import pytest - -from foundry import UserTokenAuth - -# @pytest.fixture -# def temp_os_environ(): -# old_environ = os.environ.copy() - -# # Make sure to start with a clean slate -# for key in ["PALANTIR_HOSTNAME", "PALANTIR_TOKEN"]: -# if key in os.environ: -# os.environ.pop(key) - -# yield -# os.environ = old_environ - - -# def test_load_from_env(temp_os_environ): -# os.environ["PALANTIR_HOSTNAME"] = "host_test" -# os.environ["PALANTIR_TOKEN"] = "token_test" -# config = UserTokenAuth() -# assert config.hostname == "host_test" -# assert config._token == "token_test" - - -# def test_load_from_env_missing_token(temp_os_environ): -# os.environ["PALANTIR_HOSTNAME"] = "host_test" -# assert pytest.raises(ValueError, lambda: UserTokenAuth()) - - -# def test_load_from_env_missing_host(temp_os_environ): -# os.environ["PALANTIR_TOKEN"] = "token_test" -# assert pytest.raises(ValueError, lambda: UserTokenAuth()) - - -# def test_can_pass_config(): -# os.environ["PALANTIR_HOSTNAME"] = "host_test" -# os.environ["PALANTIR_TOKEN"] = "token_test" -# config = UserTokenAuth(hostname="host_test2", token="token_test2") -# assert config.hostname == "host_test2" -# assert config._token == "token_test2" - - -def test_can_pass_config_missing_token(): - assert pytest.raises(TypeError, lambda: UserTokenAuth(hostname="test")) # type: ignore - - -def test_can_pass_config_missing_host(): - assert pytest.raises(TypeError, lambda: UserTokenAuth(token="test")) # type: ignore - - -# def test_checks_host_type(): -# assert pytest.raises(ValueError, lambda: UserTokenAuth(hostname=1)) # type: ignore - - -# def test_checks_token_type(): -# assert pytest.raises(ValueError, lambda: UserTokenAuth(token=1)) # type: ignore diff --git a/test/auth/test_foundry_oauth_client.py b/test/auth/test_foundry_oauth_client.py deleted file mode 100644 index e52ec34e..00000000 --- a/test/auth/test_foundry_oauth_client.py +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import pytest - -from foundry import ConfidentialClientAuth -from foundry._errors.not_authenticated import NotAuthenticated - - -def test_fails_no_escopes(): - with pytest.raises(ValueError) as info: - ConfidentialClientAuth( - client_id="123", - client_secret="abc", - hostname="example.com", - scopes=[], - ) - - assert ( - str(info.value) == "You have not provided any scopes. At least one scope must be provided." - ) - - -def test_can_pass_config(): - config = ConfidentialClientAuth( - client_id="123", - client_secret="abc", - hostname="example.com", - scopes=["hello"], - ) - - assert config._hostname == "example.com" # type: ignore - assert config._client_id == "123" # type: ignore - assert config._client_secret == "abc" # type: ignore - - with pytest.raises(NotAuthenticated) as info: - config.get_token() - - assert str(info.value) == "Client has not been authenticated." diff --git a/test/models/__init__.py b/test/models/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/test/models/test_branch.py b/test/models/test_branch.py deleted file mode 100644 index 9aa2df66..00000000 --- a/test/models/test_branch.py +++ /dev/null @@ -1,39 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import pytest -from pydantic import ValidationError - -from foundry.v1.models import Branch - - -def test_model_validate(): - r = Branch.model_validate( - { - "branchId": "123", - "transactionRid": "ri.a.b.c.d", - } - ) - assert r.branch_id == "123" - assert r.transaction_rid == "ri.a.b.c.d" - - -def test_invalid_type(): - with pytest.raises(ValidationError): - Branch.model_validate( - { - "branchId": "123", - "transactionRid": 123, - }, - ) diff --git a/test/models/test_create_dataset_request.py b/test/models/test_create_dataset_request.py deleted file mode 100644 index 7a414d23..00000000 --- a/test/models/test_create_dataset_request.py +++ /dev/null @@ -1,77 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import pytest -from pydantic import TypeAdapter -from pydantic import ValidationError -from typing_extensions import assert_type - -from foundry.v1.models import CreateDatasetRequest -from foundry.v1.models import CreateDatasetRequestDict - -validator = TypeAdapter(CreateDatasetRequestDict) - - -def test_model_from_dict(): - req = CreateDatasetRequest.model_validate( - {"name": "FOLDER_NAME", "parentFolderRid": "ri.foundry.main.folder.1234567890"} - ) - - assert req.name == "FOLDER_NAME" - assert req.parent_folder_rid == "ri.foundry.main.folder.1234567890" - - -def test_model_constructor(): - req = CreateDatasetRequest( - name="FOLDER_NAME", - parentFolderRid="ri.foundry.main.folder.1234567890", - ) - - assert req.name == "FOLDER_NAME" - assert req.parent_folder_rid == "ri.foundry.main.folder.1234567890" - - -def test_to_dict(): - req = CreateDatasetRequest( - name="FOLDER_NAME", - parentFolderRid="ri.foundry.main.folder.1234567890", - ) - - req = req.to_dict() - assert_type(req, CreateDatasetRequestDict) - assert req["name"] == "FOLDER_NAME" - assert req["parentFolderRid"] == "ri.foundry.main.folder.1234567890" - - -def test_from_dict(): - req = validator.validate_python( - {"name": "FOLDER_NAME", "parentFolderRid": "ri.foundry.main.folder.1234567890"} - ) - - assert req["name"] == "FOLDER_NAME" - assert req["parentFolderRid"] == "ri.foundry.main.folder.1234567890" - - -def test_from_fails_bad_type(): - assert pytest.raises( - ValidationError, - lambda: validator.validate_python({"name": "FOLDER_NAME", "parentFolderRid": 123}), - ) - - -def test_from_fails_missing(): - assert pytest.raises( - ValidationError, - lambda: validator.validate_python({"name": "FOLDER_NAME"}), - ) diff --git a/test/models/test_ontology_data_type.py b/test/models/test_ontology_data_type.py deleted file mode 100644 index 9ae4a0df..00000000 --- a/test/models/test_ontology_data_type.py +++ /dev/null @@ -1,23 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -from pydantic import TypeAdapter - -from foundry.v2.models import OntologyDataType - - -def test_model_validate(): - ta = TypeAdapter(OntologyDataType) - result = ta.validate_python({"type": "any"}) - assert result.type == "any" diff --git a/test/models/test_transaction.py b/test/models/test_transaction.py deleted file mode 100644 index 1b92b389..00000000 --- a/test/models/test_transaction.py +++ /dev/null @@ -1,68 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import json -from datetime import datetime -from datetime import timezone -from typing import Union - -from foundry.v2.models import Transaction - - -def validate(created_time: Union[str, datetime]): - return Transaction.model_validate( - { - "rid": "ri.foundry.main.transaction.00000024-065b-a1ba-9d5c-805d236318ad", - "transactionType": "SNAPSHOT", - "status": "OPEN", - "createdTime": created_time, - } - ) - - -def test_model_validate_with_z(): - assert validate("2024-08-01T17:28:58.796Z").created_time == datetime( - 2024, 8, 1, 17, 28, 58, 796000, tzinfo=timezone.utc - ) - - -def test_model_validate_with_two_digit_milli(): - assert validate("2024-08-02T20:19:30.93+00:00").created_time == datetime( - 2024, 8, 2, 20, 19, 30, 930000, tzinfo=timezone.utc - ) - - -def test_model_validate_with_no_milli(): - assert validate("1990-12-31T15:59:59-08:00").created_time == datetime.fromisoformat( - "1990-12-31T15:59:59-08:00" - ) - - -def test_model_validate_with_datetime(): - assert validate(datetime(2024, 1, 1, tzinfo=timezone.utc)).created_time == datetime( - 2024, 1, 1, tzinfo=timezone.utc - ) - - -def test_model_can_dump_to_dict(): - transaction = validate("2024-01-01T00:00:00") - assert transaction.to_dict()["createdTime"] == datetime(2024, 1, 1, 0, 0) - - -def test_model_can_dump_to_json(): - transaction = validate("2024-01-01T00:00:00") - assert ( - json.loads(transaction.model_dump_json(by_alias=True))["createdTime"] - == "2024-01-01T00:00:00" - ) diff --git a/test/namespaces/__init__.py b/test/namespaces/__init__.py deleted file mode 100644 index e69de29b..00000000 diff --git a/test/namespaces/test_datasets.py b/test/namespaces/test_datasets.py deleted file mode 100644 index dbf5736f..00000000 --- a/test/namespaces/test_datasets.py +++ /dev/null @@ -1,168 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -from typing import Any - -import pytest -from pydantic import ValidationError - -from foundry.v1 import FoundryV1Client -from foundry.v1.models import Branch -from foundry.v1.models import CreateBranchRequest - -from ..utils import client_v1 # type: ignore -from ..utils import mock_responses - -TEST_RID = "ri.foundry.main.dataset.abc" - - -def mock_create_branch(monkeypatch: Any, dataset_rid: str, branch_id: str): - mock_responses( - monkeypatch, - [ - ( - { - "method": "POST", - "url": f"https://test.com/api/v1/datasets/{dataset_rid}/branches", - "json": {"branchId": branch_id}, - "params": {}, - }, - { - "status": 200, - "json": {"branchId": branch_id}, - "content": None, - }, - ) - ], - ) - - -def test_create_branch_fails_no_body(client_v1: FoundryV1Client): - with pytest.raises(ValueError): - client_v1.datasets.Dataset.Branch.create("test", create_branch_request=None) # type: ignore - - -def test_create_branch_fails_bad_body(client_v1: FoundryV1Client): - with pytest.raises(ValidationError): - client_v1.datasets.Dataset.Branch.create( - dataset_rid=TEST_RID, - create_branch_request={"branchId": "123", "transactionRid": 123}, # type: ignore - ) - - -def test_works_with_extra_property(client_v1: FoundryV1Client, monkeypatch: Any): - dataset_rid = TEST_RID - mock_create_branch( - monkeypatch, - dataset_rid=dataset_rid, - branch_id="branch_test", - ) - - # Just making sure this works - client_v1.datasets.Dataset.Branch.create( - dataset_rid=dataset_rid, - create_branch_request={"branchId": "branch_test"}, - ) - - # This ensures we don't fail if the user passes in an extra property - client_v1.datasets.Dataset.Branch.create( - dataset_rid=dataset_rid, - create_branch_request={"branchId": "branch_test", "foo": "bar"}, # type: ignore - ) - - -def test_create_branch_with_dict(client_v1: FoundryV1Client, monkeypatch: Any): - dataset_rid = TEST_RID - mock_create_branch( - monkeypatch, - dataset_rid=dataset_rid, - branch_id="branch_test", - ) - - res = client_v1.datasets.Dataset.Branch.create( - dataset_rid, - create_branch_request={ - "branchId": "branch_test", - }, - ) - - assert isinstance(res, Branch) - assert res.branch_id == "branch_test" - assert res.transaction_rid is None - - -def test_create_branch_with_model(client_v1: FoundryV1Client, monkeypatch: Any): - mock_create_branch( - monkeypatch, - dataset_rid=TEST_RID, - branch_id="branch_test", - ) - - res = client_v1.datasets.Dataset.Branch.create( - TEST_RID, - create_branch_request=CreateBranchRequest( - branchId="branch_test", - ), - ) - - assert isinstance(res, Branch) - assert res.branch_id == "branch_test" - assert res.transaction_rid is None - - -def test_create_branch_doesnt_fail_extra_property(client_v1: FoundryV1Client, monkeypatch: Any): - """ - We want to make sure that additional properties don't cause a failure when the extra - properties come from the server. - """ - dataset_rid = TEST_RID - mock_create_branch( - monkeypatch, - dataset_rid=dataset_rid, - branch_id="branch_test", - ) - - res = client_v1.datasets.Dataset.Branch.create( - dataset_rid=dataset_rid, - create_branch_request={"branchId": "branch_test"}, - ) - - assert res.branch_id == "branch_test" - - -def mock_data_read(monkeypatch: Any, data: bytes): - mock_responses( - monkeypatch, - [ - ( - { - "method": "GET", - "url": f"https://test.com/api/v1/datasets/{TEST_RID}/readTable", - "params": {"format": "CSV", "columns": []}, - "json": None, - }, - { - "status": 200, - "json": None, - "content": data, - }, - ) - ], - ) - - -def test_read_table_can_pass_in_str(client_v1: FoundryV1Client, monkeypatch: Any): - mock_data_read(monkeypatch, data=b"hello") - res = client_v1.datasets.Dataset.read(format="CSV", dataset_rid=TEST_RID, columns=[]) - assert res == b"hello" diff --git a/test/namespaces/test_ontologies.py b/test/namespaces/test_ontologies.py deleted file mode 100644 index ce4b80cf..00000000 --- a/test/namespaces/test_ontologies.py +++ /dev/null @@ -1,125 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -from typing import Any - -from foundry.v2 import FoundryV2Client - -# from foundry.models.search_json_query_v2 import EqualsQuery -# from foundry.models.search_json_query_v2 import SearchJsonQueryV2 -from ..utils import client_v2 # type: ignore -from ..utils import mock_responses - - -def mock_list_ontologies(monkeypatch: Any): - mock_responses( - monkeypatch, - [ - ( - { - "method": "GET", - "url": "https://test.com/api/v2/ontologies/MyOntology/objectTypes", - "json": None, - "params": None, - }, - { - "status": 200, - "json": { - "nextPageToken": None, - "data": [ - { - "rid": "ri.a.b.c.d", - "displayName": "TEST", - "pluralDisplayName": "TEST", - "apiName": "API", - "status": "ACTIVE", - "primaryKey": "123", - "primaryKey": "abc", - "titleProperty": "abc", - "properties": {}, - "icon": {"type": "blueprint", "name": "test", "color": "test"}, - } - ], - }, - "content": None, - }, - ) - ], - ) - - -def test_can_list_object_types(client_v2: FoundryV2Client, monkeypatch: Any): - mock_list_ontologies(monkeypatch) - - result = client_v2.ontologies.Ontology.ObjectType.list( - ontology="MyOntology", - ) - - assert len(list(result)) == 1 - - -# def mock_search_query(monkeypatch): -# mock_responses( -# monkeypatch, -# [ -# ( -# { -# "method": "POST", -# "url": "https://test.com/api/v2/ontologies/MyOntology/objects/MyObjectType/search", -# "body": {"where": {"field": "myProp", "type": "eq", "value": 21}}, -# }, -# {"status": 200, "body": {"nextPageToken": None, "data": [{}]}}, -# ) -# ], -# ) - - -# def test_can_search_using_classes(client_v2: FoundryV2Client, monkeypatch): -# mock_search_query(monkeypatch) - -# result = client_v2.ontologies.search_objects( -# ontology="MyOntology", -# object_type="MyObjectType", -# search_objects_request_v2=SearchObjectsRequestV2( -# where=EqualsQuery( -# type="eq", -# field="myProp", -# value=21, -# ) -# ), -# ) - -# assert result.data is not None and len(result.data) == 1 - - -# def test_can_search_with_dict(client_v2: FoundryV2Client, monkeypatch): -# mock_search_query(monkeypatch) - -# _ = client_v2.ontologies.search_objects( -# ontology="MyOntology", -# object_type="MyObjectType", -# search_objects_request_v2={"where": {"field": "myProp", "type": "eq", "value": 21}}, # type: ignore -# ) - - -# def test_can_search_with_query_builder(client_v2: FoundryV2Client, monkeypatch): -# mock_search_query(monkeypatch) - -# _ = client_v2.ontologies.search_objects( -# ontology="MyOntology", -# object_type="MyObjectType", -# search_objects_request_v2=SearchObjectsRequestV2( -# where=SearchQuery.eq(field="myProp", value=21) -# ), -# ) diff --git a/test/namespaces/test_operations.txt b/test/namespaces/test_operations.txt deleted file mode 100644 index 08dfdada..00000000 --- a/test/namespaces/test_operations.txt +++ /dev/null @@ -1,44 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import pytest -from foundry.exceptions import SDKInternalError -from ..utils import mock_responses -from ..utils import client - - -def test_get_operation(client, monkeypatch): - id = "ri.actions.main.action.75dd58b0-e773-4b13-af10-7dde1e095332" - mock_responses( - monkeypatch, - [ - ( - { - "method": "GET", - "url": f"https://test.com/api/v2/operations/{id}", - }, - { - "status": 200, - "body": {"type": "applyActionAsync", "id": id}, - }, - ) - ], - ) - - with pytest.raises(SDKInternalError): - r = client.operations.Operation.get( - id=id, - ) - - # assert r.id == id diff --git a/test/namespaces/test_security.py b/test/namespaces/test_security.py deleted file mode 100644 index a3a08d29..00000000 --- a/test/namespaces/test_security.py +++ /dev/null @@ -1,90 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -from typing import Any - -from foundry.v2 import FoundryV2Client - -# from foundry.models.search_json_query import EqualsQuery -from ..utils import client_v2 # type: ignore -from ..utils import mock_responses - - -def test_can_get_user(client_v2: FoundryV2Client, monkeypatch: Any): - user_id = "176a8ce7-1f63-4942-b89e-208f5f3d4380" - - mock_responses( - monkeypatch, - [ - ( - { - "method": "GET", - "url": f"https://test.com/api/v2/admin/users/{user_id}", - "json": None, - "params": {}, - }, - { - "status": 200, - "json": { - "id": user_id, - "username": "test-username", - "givenName": None, - "familyName": None, - "email": None, - "realm": "Palantir", - "organization": "ri.a.b.c.d", - "attributes": {}, - }, - "content": None, - }, - ) - ], - ) - - user = client_v2.admin.User.get(user_id) - assert user.id == user_id - assert user.username == "test-username" - - -def test_can_get_user_groups(client_v2: FoundryV2Client, monkeypatch: Any): - user_id = "176a8ce7-1f63-4942-b89e-208f5f3d4380" - group_id = "186a8ce7-1f63-4942-b89e-208f5f3d4380" - - mock_responses( - monkeypatch, - [ - ( - { - "method": "GET", - "url": f"https://test.com/api/v2/admin/users/{user_id}/groupMemberships", - "json": None, - "params": {}, - }, - { - "status": 200, - "json": { - "nextPageToken": "123", - "data": [{"groupId": group_id}], - }, - "content": None, - }, - ) - ], - ) - - result = client_v2.admin.User.GroupMembership.page(user_id) - assert result.next_page_token == "123" - assert len(result.data) == 1 - assert result.data[0].group_id == group_id - assert result.data[0].to_dict() == {"groupId": group_id} diff --git a/test/test_discriminators.py b/test/test_discriminators.py deleted file mode 100644 index 709c3a95..00000000 --- a/test/test_discriminators.py +++ /dev/null @@ -1,55 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import pytest -from pydantic import PydanticUndefinedAnnotation -from pydantic import TypeAdapter -from pydantic import ValidationError - -from foundry.v1 import models as models_v1 -from foundry.v2 import models as models_v2 - - -def test_can_validate_types(): - """ - The discriminators types are difficult to construct. This test ensures - that all discriminators are importable without raising any issues. - """ - - for models, model_name in [(models_v1, model_name) for model_name in dir(models_v1)] + [ - (models_v2, model_name) for model_name in dir(models_v2) - ]: - klass = getattr(models, model_name) - - if "Annotated[Union[" not in str(klass): - continue - - try: - ta = TypeAdapter(klass) - except PydanticUndefinedAnnotation as e: - print(model_name, str(klass)) - raise e - - with pytest.raises(ValidationError) as error: - ta.validate_python({}) - - assert error.value.errors(include_url=False) == [ - { - "type": "union_tag_not_found", - "loc": (), - "msg": "Unable to extract tag using discriminator 'type'", - "input": {}, - "ctx": {"discriminator": "'type'"}, - } - ] diff --git a/test/test_exceptions.py b/test/test_exceptions.py deleted file mode 100644 index cf7e3557..00000000 --- a/test/test_exceptions.py +++ /dev/null @@ -1,73 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import json -import re - -import pytest - -from foundry._errors.palantir_rpc_exception import PalantirRPCException -from foundry._errors.sdk_internal_error import SDKInternalError -from foundry._errors.sdk_internal_error import handle_unexpected - - -def test_sdk_internal_error(): - with pytest.raises(SDKInternalError) as error: - raise SDKInternalError("test") - - assert ( - re.match( - r"""^test\n -This is an unexpected issue and should be reported. When filing an issue, make sure to copy the package information listed below.\n -OS: \w+ -Python Version: \d+\.\d+\.\d+[^\n]+ -SDK Version: \d+\.\d+\.\d+ -OpenAPI Document Version: \d+\.\d+\.\d+ -Pydantic Version: \d+\.\d+\.\d+ -Pydantic Core Version: \d+\.\d+\.\d+ -Requests Version: \d+\.\d+\.\d+ -$""", - str(error.value), - ) - is not None - ), "Mismatch with text: " + str(error.value) - - -def test_handle_unexpected_fails_for_unkonwn_exception(): - @handle_unexpected - def raises_unknown_exception(): - raise ValueError("test") - - with pytest.raises(SDKInternalError) as error: - raises_unknown_exception() - - assert error.value.msg == "test" - - -def test_handle_unexpected_ignores_known_exception(): - @handle_unexpected - def raises_known_exception(): - raise PalantirRPCException({"errorName": "", "parameters": "", "errorInstanceId": ""}) - - with pytest.raises(PalantirRPCException) as error: - raises_known_exception() - - assert str(error.value) == json.dumps( - { - "errorInstanceId": "", - "errorName": "", - "parameters": "", - }, - indent=4, - ) diff --git a/test/utils.py b/test/utils.py deleted file mode 100644 index fb657434..00000000 --- a/test/utils.py +++ /dev/null @@ -1,90 +0,0 @@ -# Copyright 2024 Palantir Technologies, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import json as jsn -from typing import Any -from typing import Dict -from typing import List -from typing import Optional -from typing import Tuple -from typing import TypedDict -from unittest.mock import Mock - -import pytest -from requests import Session - -from foundry import UserTokenAuth -from foundry.v1 import FoundryV1Client -from foundry.v2 import FoundryV2Client - - -@pytest.fixture() -def client_v1(): - yield FoundryV1Client( - auth=UserTokenAuth(hostname="test.com", token="test"), hostname="test.com" - ) - - -@pytest.fixture() -def client_v2(): - yield FoundryV2Client( - auth=UserTokenAuth(hostname="test.com", token="test"), hostname="test.com" - ) - - -class MockRequest(TypedDict): - method: str - url: str - params: Optional[Dict[str, Any]] - json: Optional[Any] - - -class MockResponse(TypedDict): - status: int - content: Optional[bytes] - json: Optional[Any] - - -def mock_responses(monkeypatch: Any, request_responses: List[Tuple[MockRequest, MockResponse]]): - # Define a side_effect function for our mock. This will be called instead of the original method - def mock_request(_, method: str, url: str, json: Any = None, **kwargs: dict[str, Any]): - for request, response in request_responses: - if request["method"] != method: - continue - - if request["url"] != url: - continue - - if json is not None and json != request["json"]: - continue - - # Mock response - mock_response = Mock() - mock_response.status_code = response["status"] - - if response["json"]: - mock_response.content = jsn.dumps(response["json"]).encode() - elif response["content"]: - mock_response.content = response["content"] - else: - mock_response.content = None - - mock_response.headers = {} - - return mock_response - - pytest.fail(f"Unexpected request: {method} {url} {json}") - - # Use monkeypatch to replace the PoolManager.request method with our side_effect function - monkeypatch.setattr(Session, "request", mock_request) diff --git a/test/test_api_client.py b/tests/test_api_client.py similarity index 98% rename from test/test_api_client.py rename to tests/test_api_client.py index 8791de12..a4726c08 100644 --- a/test/test_api_client.py +++ b/tests/test_api_client.py @@ -12,6 +12,7 @@ # See the License for the specific language governing permissions and # limitations under the License. + import json import sys from typing import Any @@ -24,8 +25,8 @@ from foundry import PalantirRPCException from foundry import UserTokenAuth from foundry import __version__ -from foundry.api_client import ApiClient -from foundry.api_client import RequestInfo +from foundry._core import ApiClient +from foundry._core import RequestInfo class AttrDict(Dict[str, Any]): diff --git a/tests/test_discriminators.py b/tests/test_discriminators.py new file mode 100644 index 00000000..6aafe064 --- /dev/null +++ b/tests/test_discriminators.py @@ -0,0 +1,81 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +import pytest +from pydantic import PydanticUndefinedAnnotation +from pydantic import TypeAdapter +from pydantic import ValidationError + +from foundry.v1.core import models as models_core_v1 +from foundry.v1.datasets import models as models_datasets_v1 +from foundry.v1.geo import models as models_geo_v1 +from foundry.v1.ontologies import models as models_ontologies_v1 +from foundry.v2.admin import models as models_admin_v2 +from foundry.v2.core import models as models_core_v2 +from foundry.v2.datasets import models as models_datasets_v2 +from foundry.v2.filesystem import models as models_filesystem_v2 +from foundry.v2.geo import models as models_geo_v2 +from foundry.v2.ontologies import models as models_ontologies_v2 +from foundry.v2.orchestration import models as models_orchestration_v2 +from foundry.v2.third_party_applications import models as models_third_party_applications_v2 # NOQA + + +def test_can_validate_types(): + """ + The discriminators types are difficult to construct. This test ensures + that all discriminators are importable without raising any issues. + """ + + for models, model_name in [ + *[(models_core_v1, model_name) for model_name in dir(models_core_v1)], + *[(models_datasets_v1, model_name) for model_name in dir(models_datasets_v1)], + *[(models_geo_v1, model_name) for model_name in dir(models_geo_v1)], + *[(models_ontologies_v1, model_name) for model_name in dir(models_ontologies_v1)], + *[(models_admin_v2, model_name) for model_name in dir(models_admin_v2)], + *[(models_core_v2, model_name) for model_name in dir(models_core_v2)], + *[(models_datasets_v2, model_name) for model_name in dir(models_datasets_v2)], + *[(models_filesystem_v2, model_name) for model_name in dir(models_filesystem_v2)], + *[(models_geo_v2, model_name) for model_name in dir(models_geo_v2)], + *[(models_ontologies_v2, model_name) for model_name in dir(models_ontologies_v2)], + *[(models_ontologies_v2, model_name) for model_name in dir(models_ontologies_v2)], + *[(models_orchestration_v2, model_name) for model_name in dir(models_orchestration_v2)], + *[ + (models_third_party_applications_v2, model_name) + for model_name in dir(models_third_party_applications_v2) + ], + ]: + klass = getattr(models, model_name) + + if "Annotated[Union[" not in str(klass): + continue + + try: + ta = TypeAdapter(klass) + except PydanticUndefinedAnnotation as e: + print(model_name, str(klass)) + raise e + + with pytest.raises(ValidationError) as error: + ta.validate_python({}) + + assert error.value.errors(include_url=False) == [ + { + "type": "union_tag_not_found", + "loc": (), + "msg": "Unable to extract tag using discriminator 'type'", + "input": {}, + "ctx": {"discriminator": "'type'"}, + } + ] diff --git a/tests/test_exception.py b/tests/test_exception.py new file mode 100644 index 00000000..2ad79e73 --- /dev/null +++ b/tests/test_exception.py @@ -0,0 +1,74 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +import json +import re + +import pytest + +from foundry._errors.palantir_rpc_exception import PalantirRPCException +from foundry._errors.sdk_internal_error import SDKInternalError +from foundry._errors.sdk_internal_error import handle_unexpected + + +def test_sdk_internal_error(): + with pytest.raises(SDKInternalError) as error: + raise SDKInternalError("test") + + assert ( + re.match( + r"""^test\n +This is an unexpected issue and should be reported. When filing an issue, make sure to copy the package information listed below.\n +OS: \w+ +Python Version: \d+\.\d+\.\d+[^\n]+ +SDK Version: \d+\.\d+\.\d+ +OpenAPI Document Version: \d+\.\d+\.\d+ +Pydantic Version: \d+\.\d+\.\d+ +Pydantic Core Version: \d+\.\d+\.\d+ +Requests Version: \d+\.\d+\.\d+ +$""", + str(error.value), + ) + is not None + ), "Mismatch with text: " + str(error.value) + + +def test_handle_unexpected_fails_for_unkonwn_exception(): + @handle_unexpected + def raises_unknown_exception(): + raise ValueError("test") + + with pytest.raises(SDKInternalError) as error: + raises_unknown_exception() + + assert error.value.msg == "test" + + +def test_handle_unexpected_ignores_known_exception(): + @handle_unexpected + def raises_known_exception(): + raise PalantirRPCException({"errorName": "", "parameters": "", "errorInstanceId": ""}) + + with pytest.raises(PalantirRPCException) as error: + raises_known_exception() + + assert str(error.value) == json.dumps( + { + "errorInstanceId": "", + "errorName": "", + "parameters": "", + }, + indent=4, + ) diff --git a/tests/test_foundry_auth_token_client.py b/tests/test_foundry_auth_token_client.py new file mode 100644 index 00000000..d616bfa1 --- /dev/null +++ b/tests/test_foundry_auth_token_client.py @@ -0,0 +1,82 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +import os + +import pytest + +from foundry import UserTokenAuth + + +@pytest.fixture +def temp_os_environ(): + old_environ = os.environ.copy() + + # Make sure to start with a clean slate + for key in ["PALANTIR_HOSTNAME", "PALANTIR_TOKEN"]: + if key in os.environ: + os.environ.pop(key) + + yield + os.environ = old_environ + + +@pytest.mark.skip +def test_load_from_env(temp_os_environ): + os.environ["PALANTIR_HOSTNAME"] = "host_test" + os.environ["PALANTIR_TOKEN"] = "token_test" + config = UserTokenAuth() # type: ignore + assert config._hostname == "host_test" + assert config._token == "token_test" + + +@pytest.mark.skip +def test_load_from_env_missing_token(temp_os_environ): + os.environ["PALANTIR_HOSTNAME"] = "host_test" + assert pytest.raises(ValueError, lambda: UserTokenAuth()) # type: ignore + + +@pytest.mark.skip +def test_load_from_env_missing_host(temp_os_environ): + os.environ["PALANTIR_TOKEN"] = "token_test" + assert pytest.raises(ValueError, lambda: UserTokenAuth()) # type: ignore + + +@pytest.mark.skip +def test_can_pass_config(): + os.environ["PALANTIR_HOSTNAME"] = "host_test" + os.environ["PALANTIR_TOKEN"] = "token_test" + config = UserTokenAuth(hostname="host_test2", token="token_test2") + assert config.hostname == "host_test2" # type: ignore + assert config._token == "token_test2" + + +def test_can_pass_config_missing_token(): + assert pytest.raises(TypeError, lambda: UserTokenAuth(hostname="test")) # type: ignore + + +def test_can_pass_config_missing_host(): + assert pytest.raises(TypeError, lambda: UserTokenAuth(token="test")) # type: ignore + + +@pytest.mark.skip +def test_checks_host_type(): + assert pytest.raises(ValueError, lambda: UserTokenAuth(hostname=1)) # type: ignore + + +@pytest.mark.skip +def test_checks_token_type(): + assert pytest.raises(ValueError, lambda: UserTokenAuth(token=1)) # type: ignore + assert pytest.raises(ValueError, lambda: UserTokenAuth(token=1)) # type: ignore diff --git a/tests/test_foundry_token_oauth_client.py b/tests/test_foundry_token_oauth_client.py new file mode 100644 index 00000000..cad5dab2 --- /dev/null +++ b/tests/test_foundry_token_oauth_client.py @@ -0,0 +1,51 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +import pytest + +from foundry import ConfidentialClientAuth +from foundry._errors.not_authenticated import NotAuthenticated + + +def test_fails_no_escopes(): + with pytest.raises(ValueError) as info: + ConfidentialClientAuth( + client_id="123", + client_secret="abc", + hostname="example.com", + scopes=[], + ) + + assert ( + str(info.value) == "You have not provided any scopes. At least one scope must be provided." + ) + + +def test_can_pass_config(): + config = ConfidentialClientAuth( + client_id="123", + client_secret="abc", + hostname="example.com", + scopes=["hello"], + ) + + assert config._hostname == "example.com" # type: ignore + assert config._client_id == "123" # type: ignore + assert config._client_secret == "abc" # type: ignore + + with pytest.raises(NotAuthenticated) as info: + config.get_token() + + assert str(info.value) == "Client has not been authenticated." diff --git a/tests/test_utils.py b/tests/test_utils.py new file mode 100644 index 00000000..270f2917 --- /dev/null +++ b/tests/test_utils.py @@ -0,0 +1,7 @@ +from foundry._core.utils import remove_prefixes + + +def test_remove_prefixes(): + assert remove_prefixes("http://example.com", ["https://", "http://"]) == "example.com" + assert remove_prefixes("https://example.com", ["https://", "http://"]) == "example.com" + assert remove_prefixes("example.com", ["https://", "http://"]) == "example.com" diff --git a/tests/utils.py b/tests/utils.py new file mode 100644 index 00000000..0a87f668 --- /dev/null +++ b/tests/utils.py @@ -0,0 +1,126 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +import json +from contextlib import contextmanager +from typing import Any +from typing import Dict +from typing import List +from typing import Literal +from typing import Optional +from typing import cast +from unittest.mock import Mock +from unittest.mock import patch +from urllib.parse import quote + +import pytest +from pydantic import BaseModel +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +import foundry +from foundry.v1 import FoundryClient as FoundryV1Client +from foundry.v2 import FoundryClient as FoundryV2Client + + +class MockResponse(TypedDict): + status: int + content_type: Optional[str] + json: Optional[Any] + + +class MockRequest(TypedDict): + method: Literal["GET", "POST", "DELETE", "PATCH", "PUT"] + url: str + path_params: Dict[str, Any] + response: MockResponse + json: Optional[Any] + + +@pytest.fixture +def client_v1(): + yield FoundryV1Client( + auth=foundry.UserTokenAuth(hostname="example.palantirfoundry.com", token=""), + hostname="example.palantirfoundry.com", + ) + + +@pytest.fixture +def client_v2(): + yield FoundryV2Client( + auth=foundry.UserTokenAuth(hostname="example.palantirfoundry.com", token=""), + hostname="example.palantirfoundry.com", + ) + + +def serialize_response(response: Any): + """Serialize the response to primitive data structures (lists, dicts, str, int, etc.)""" + if response is None: + return None + elif isinstance(response, list): + return [serialize_response(value) for value in response] + elif isinstance(response, dict): + return {key: serialize_response(value) for key, value in response.items()} + elif isinstance(response, BaseModel): + # The to_dict() method will exist on each data model + return cast(Any, response).to_dict() + else: + return response + + +@contextmanager +def mock_requests(mocks: List[MockRequest]): + def _mock_request_impl(method: str, url: str, **kwargs): + if kwargs["data"] is None: + given_body = None + else: + given_body = json.loads(kwargs["data"].decode()) + + if isinstance(given_body, dict): + given_body = {key: value for key, value in given_body.items() if value is not None} + + for expected in mocks: + expected_url = expected["url"] + + for k, v in expected["path_params"].items(): + expected_url = expected_url.replace(f"{{{k}}}", quote(v, safe="")) + + if ( + method == expected["method"] + and url == expected_url + and given_body == expected["json"] + ): + # Create a mock response object + mock_response = Mock() + mock_response.status_code = expected["response"]["status"] + mock_response.json.return_value = expected["response"]["json"] + mock_response.content = ( + b"" + if expected["response"]["json"] is None + else json.dumps(expected["response"]["json"]).encode() + ) + mock_response.headers.get = lambda key: { + "content-type": expected["response"]["content_type"] + }.get(key) + return mock_response + + # If no match is found, return a default 404 response + mock_response = Mock() + mock_response.status_code = 404 + mock_response.json.return_value = {} + return mock_response + + with patch("requests.Session.request", side_effect=_mock_request_impl): + yield diff --git a/tests/v1/datasets/test_v1_datasets_branch.py b/tests/v1/datasets/test_v1_datasets_branch.py new file mode 100644 index 00000000..d59e61c3 --- /dev/null +++ b/tests/v1/datasets/test_v1_datasets_branch.py @@ -0,0 +1,182 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from pydantic import ValidationError + +from tests.utils import client_v1 +from tests.utils import mock_requests +from tests.utils import serialize_response + + +def test_create(client_v1): + with mock_requests( + [ + { + "method": "POST", + "url": "https://example.palantirfoundry.com/api/v1/datasets/{datasetRid}/branches", + "path_params": { + "datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da", + }, + "json": {"branchId": "my-branch"}, + "response": { + "status": 200, + "json": {"branchId": "my-branch"}, + "content_type": "application/json", + }, + } + ] + ): + dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" + branch_id = "my-branch" + transaction_rid = None + try: + response = client_v1.datasets.Dataset.Branch.create( + dataset_rid, + branch_id=branch_id, + transaction_rid=transaction_rid, + ) + except ValidationError as e: + raise Exception("There was a validation error with createBranch") from e + + assert serialize_response(response) == {"branchId": "my-branch"} + + +def test_delete(client_v1): + with mock_requests( + [ + { + "method": "DELETE", + "url": "https://example.palantirfoundry.com/api/v1/datasets/{datasetRid}/branches/{branchId}", + "path_params": { + "datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da", + "branchId": "my-branch", + }, + "json": None, + "response": { + "status": 200, + "json": None, + "content_type": "None", + }, + } + ] + ): + dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" + branch_id = "my-branch" + try: + response = client_v1.datasets.Dataset.Branch.delete( + dataset_rid, + branch_id, + ) + except ValidationError as e: + raise Exception("There was a validation error with deleteBranch") from e + + assert serialize_response(response) == None + + +def test_get(client_v1): + with mock_requests( + [ + { + "method": "GET", + "url": "https://example.palantirfoundry.com/api/v1/datasets/{datasetRid}/branches/{branchId}", + "path_params": { + "datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da", + "branchId": "master", + }, + "json": None, + "response": { + "status": 200, + "json": { + "branchId": "master", + "transactionRid": "ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4", + }, + "content_type": "application/json", + }, + } + ] + ): + dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" + branch_id = "master" + try: + response = client_v1.datasets.Dataset.Branch.get( + dataset_rid, + branch_id, + ) + except ValidationError as e: + raise Exception("There was a validation error with getBranch") from e + + assert serialize_response(response) == { + "branchId": "master", + "transactionRid": "ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4", + } + + +def test_page(client_v1): + with mock_requests( + [ + { + "method": "GET", + "url": "https://example.palantirfoundry.com/api/v1/datasets/{datasetRid}/branches", + "path_params": { + "datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da", + }, + "json": None, + "response": { + "status": 200, + "json": { + "nextPageToken": "v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv", + "data": [ + { + "branchId": "master", + "transactionRid": "ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4", + }, + { + "branchId": "test-v2", + "transactionRid": "ri.foundry.main.transaction.fc9feb4b-34e4-4bfd-9e4f-b6425fbea85f", + }, + {"branchId": "my-branch"}, + ], + }, + "content_type": "application/json", + }, + } + ] + ): + dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" + page_size = None + page_token = None + try: + response = client_v1.datasets.Dataset.Branch.page( + dataset_rid, + page_size=page_size, + page_token=page_token, + ) + except ValidationError as e: + raise Exception("There was a validation error with pageBranches") from e + + assert serialize_response(response) == { + "nextPageToken": "v1.VGhlcmUgaXMgc28gbXVjaCBsZWZ0IHRvIGJ1aWxkIC0gcGFsYW50aXIuY29tL2NhcmVlcnMv", + "data": [ + { + "branchId": "master", + "transactionRid": "ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4", + }, + { + "branchId": "test-v2", + "transactionRid": "ri.foundry.main.transaction.fc9feb4b-34e4-4bfd-9e4f-b6425fbea85f", + }, + {"branchId": "my-branch"}, + ], + } diff --git a/tests/v1/datasets/test_v1_datasets_dataset.py b/tests/v1/datasets/test_v1_datasets_dataset.py new file mode 100644 index 00000000..d0bd3a9e --- /dev/null +++ b/tests/v1/datasets/test_v1_datasets_dataset.py @@ -0,0 +1,57 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from pydantic import ValidationError + +from tests.utils import client_v1 +from tests.utils import mock_requests +from tests.utils import serialize_response + + +def test_get(client_v1): + with mock_requests( + [ + { + "method": "GET", + "url": "https://example.palantirfoundry.com/api/v1/datasets/{datasetRid}", + "path_params": { + "datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da", + }, + "json": None, + "response": { + "status": 200, + "json": { + "rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da", + "name": "My Dataset", + "parentFolderRid": "ri.foundry.main.folder.bfe58487-4c56-4c58-aba7-25defd6163c4", + }, + "content_type": "application/json", + }, + } + ] + ): + dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" + try: + response = client_v1.datasets.Dataset.get( + dataset_rid, + ) + except ValidationError as e: + raise Exception("There was a validation error with getDataset") from e + + assert serialize_response(response) == { + "rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da", + "name": "My Dataset", + "parentFolderRid": "ri.foundry.main.folder.bfe58487-4c56-4c58-aba7-25defd6163c4", + } diff --git a/tests/v1/datasets/test_v1_datasets_file.py b/tests/v1/datasets/test_v1_datasets_file.py new file mode 100644 index 00000000..7c8ce507 --- /dev/null +++ b/tests/v1/datasets/test_v1_datasets_file.py @@ -0,0 +1,56 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from pydantic import ValidationError + +from tests.utils import client_v1 +from tests.utils import mock_requests +from tests.utils import serialize_response + + +def test_delete(client_v1): + with mock_requests( + [ + { + "method": "DELETE", + "url": "https://example.palantirfoundry.com/api/v1/datasets/{datasetRid}/files/{filePath}", + "path_params": { + "datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da", + "filePath": "q3-data%2fmy-file.csv", + }, + "json": None, + "response": { + "status": 200, + "json": None, + "content_type": "None", + }, + } + ] + ): + dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" + file_path = "q3-data%2fmy-file.csv" + branch_id = None + transaction_rid = None + try: + response = client_v1.datasets.Dataset.File.delete( + dataset_rid, + file_path, + branch_id=branch_id, + transaction_rid=transaction_rid, + ) + except ValidationError as e: + raise Exception("There was a validation error with deleteFile") from e + + assert serialize_response(response) == None diff --git a/tests/v1/ontologies/test_v1_ontologies_action.py b/tests/v1/ontologies/test_v1_ontologies_action.py new file mode 100644 index 00000000..70e5a105 --- /dev/null +++ b/tests/v1/ontologies/test_v1_ontologies_action.py @@ -0,0 +1,300 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from pydantic import ValidationError + +from tests.utils import client_v1 +from tests.utils import mock_requests +from tests.utils import serialize_response + + +def test_apply(client_v1): + with mock_requests( + [ + { + "method": "POST", + "url": "https://example.palantirfoundry.com/api/v1/ontologies/{ontologyRid}/actions/{actionType}/apply", + "path_params": { + "ontologyRid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367", + "actionType": "rename-employee", + }, + "json": {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}}, + "response": { + "status": 200, + "json": {}, + "content_type": "application/json", + }, + } + ] + ): + ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" + action_type = "rename-employee" + parameters = {"id": 80060, "newName": "Anna Smith-Doe"} + try: + response = client_v1.ontologies.Action.apply( + ontology_rid, + action_type, + parameters=parameters, + ) + except ValidationError as e: + raise Exception("There was a validation error with applyAction") from e + + assert serialize_response(response) == {} + + +def test_apply_batch(client_v1): + with mock_requests( + [ + { + "method": "POST", + "url": "https://example.palantirfoundry.com/api/v1/ontologies/{ontologyRid}/actions/{actionType}/applyBatch", + "path_params": { + "ontologyRid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367", + "actionType": "rename-employee", + }, + "json": { + "requests": [ + {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}}, + {"parameters": {"id": 80061, "newName": "Joe Bloggs"}}, + ] + }, + "response": { + "status": 200, + "json": {}, + "content_type": "application/json", + }, + } + ] + ): + ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" + action_type = "rename-employee" + requests = [ + {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}}, + {"parameters": {"id": 80061, "newName": "Joe Bloggs"}}, + ] + try: + response = client_v1.ontologies.Action.apply_batch( + ontology_rid, + action_type, + requests=requests, + ) + except ValidationError as e: + raise Exception("There was a validation error with applyActionBatch") from e + + assert serialize_response(response) == {} + + +def test_validate(client_v1): + with mock_requests( + [ + { + "method": "POST", + "url": "https://example.palantirfoundry.com/api/v1/ontologies/{ontologyRid}/actions/{actionType}/validate", + "path_params": { + "ontologyRid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367", + "actionType": "rename-employee", + }, + "json": { + "parameters": { + "id": "2", + "firstName": "Chuck", + "lastName": "Jones", + "age": 17, + "date": "2021-05-01", + "numbers": [1, 2, 3], + "hasObjectSet": True, + "objectSet": "ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623", + "reference": "Chuck", + "percentage": 41.3, + "differentObjectId": "2", + } + }, + "response": { + "status": 200, + "json": { + "result": "INVALID", + "submissionCriteria": [ + { + "configuredFailureMessage": "First name can not match the first name of the referenced object.", + "result": "INVALID", + } + ], + "parameters": { + "age": { + "result": "INVALID", + "evaluatedConstraints": [{"type": "range", "gte": 18}], + "required": True, + }, + "id": {"result": "VALID", "evaluatedConstraints": [], "required": True}, + "date": { + "result": "VALID", + "evaluatedConstraints": [], + "required": True, + }, + "lastName": { + "result": "VALID", + "evaluatedConstraints": [ + { + "type": "oneOf", + "options": [ + {"displayName": "Doe", "value": "Doe"}, + {"displayName": "Smith", "value": "Smith"}, + {"displayName": "Adams", "value": "Adams"}, + {"displayName": "Jones", "value": "Jones"}, + ], + "otherValuesAllowed": True, + } + ], + "required": True, + }, + "numbers": { + "result": "VALID", + "evaluatedConstraints": [{"type": "arraySize", "lte": 4, "gte": 2}], + "required": True, + }, + "differentObjectId": { + "result": "VALID", + "evaluatedConstraints": [{"type": "objectPropertyValue"}], + "required": False, + }, + "firstName": { + "result": "VALID", + "evaluatedConstraints": [], + "required": True, + }, + "reference": { + "result": "VALID", + "evaluatedConstraints": [{"type": "objectQueryResult"}], + "required": False, + }, + "percentage": { + "result": "VALID", + "evaluatedConstraints": [{"type": "range", "lt": 100, "gte": 0}], + "required": True, + }, + "objectSet": { + "result": "VALID", + "evaluatedConstraints": [], + "required": True, + }, + "attachment": { + "result": "VALID", + "evaluatedConstraints": [], + "required": False, + }, + "hasObjectSet": { + "result": "VALID", + "evaluatedConstraints": [], + "required": False, + }, + "multipleAttachments": { + "result": "VALID", + "evaluatedConstraints": [{"type": "arraySize", "gte": 0}], + "required": False, + }, + }, + }, + "content_type": "application/json", + }, + } + ] + ): + ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" + action_type = "rename-employee" + parameters = { + "id": "2", + "firstName": "Chuck", + "lastName": "Jones", + "age": 17, + "date": "2021-05-01", + "numbers": [1, 2, 3], + "hasObjectSet": True, + "objectSet": "ri.object-set.main.object-set.39a9f4bd-f77e-45ce-9772-70f25852f623", + "reference": "Chuck", + "percentage": 41.3, + "differentObjectId": "2", + } + try: + response = client_v1.ontologies.Action.validate( + ontology_rid, + action_type, + parameters=parameters, + ) + except ValidationError as e: + raise Exception("There was a validation error with validateAction") from e + + assert serialize_response(response) == { + "result": "INVALID", + "submissionCriteria": [ + { + "configuredFailureMessage": "First name can not match the first name of the referenced object.", + "result": "INVALID", + } + ], + "parameters": { + "age": { + "result": "INVALID", + "evaluatedConstraints": [{"type": "range", "gte": 18}], + "required": True, + }, + "id": {"result": "VALID", "evaluatedConstraints": [], "required": True}, + "date": {"result": "VALID", "evaluatedConstraints": [], "required": True}, + "lastName": { + "result": "VALID", + "evaluatedConstraints": [ + { + "type": "oneOf", + "options": [ + {"displayName": "Doe", "value": "Doe"}, + {"displayName": "Smith", "value": "Smith"}, + {"displayName": "Adams", "value": "Adams"}, + {"displayName": "Jones", "value": "Jones"}, + ], + "otherValuesAllowed": True, + } + ], + "required": True, + }, + "numbers": { + "result": "VALID", + "evaluatedConstraints": [{"type": "arraySize", "lte": 4, "gte": 2}], + "required": True, + }, + "differentObjectId": { + "result": "VALID", + "evaluatedConstraints": [{"type": "objectPropertyValue"}], + "required": False, + }, + "firstName": {"result": "VALID", "evaluatedConstraints": [], "required": True}, + "reference": { + "result": "VALID", + "evaluatedConstraints": [{"type": "objectQueryResult"}], + "required": False, + }, + "percentage": { + "result": "VALID", + "evaluatedConstraints": [{"type": "range", "lt": 100, "gte": 0}], + "required": True, + }, + "objectSet": {"result": "VALID", "evaluatedConstraints": [], "required": True}, + "attachment": {"result": "VALID", "evaluatedConstraints": [], "required": False}, + "hasObjectSet": {"result": "VALID", "evaluatedConstraints": [], "required": False}, + "multipleAttachments": { + "result": "VALID", + "evaluatedConstraints": [{"type": "arraySize", "gte": 0}], + "required": False, + }, + }, + } diff --git a/tests/v1/ontologies/test_v1_ontologies_ontology.py b/tests/v1/ontologies/test_v1_ontologies_ontology.py new file mode 100644 index 00000000..5a6f177d --- /dev/null +++ b/tests/v1/ontologies/test_v1_ontologies_ontology.py @@ -0,0 +1,113 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from pydantic import ValidationError + +from tests.utils import client_v1 +from tests.utils import mock_requests +from tests.utils import serialize_response + + +def test_get(client_v1): + with mock_requests( + [ + { + "method": "GET", + "url": "https://example.palantirfoundry.com/api/v1/ontologies/{ontologyRid}", + "path_params": { + "ontologyRid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367", + }, + "json": None, + "response": { + "status": 200, + "json": { + "apiName": "default-ontology", + "displayName": "Ontology", + "description": "The default ontology", + "rid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367", + }, + "content_type": "application/json", + }, + } + ] + ): + ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" + try: + response = client_v1.ontologies.Ontology.get( + ontology_rid, + ) + except ValidationError as e: + raise Exception("There was a validation error with getOntology") from e + + assert serialize_response(response) == { + "apiName": "default-ontology", + "displayName": "Ontology", + "description": "The default ontology", + "rid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367", + } + + +def test_list(client_v1): + with mock_requests( + [ + { + "method": "GET", + "url": "https://example.palantirfoundry.com/api/v1/ontologies", + "path_params": {}, + "json": None, + "response": { + "status": 200, + "json": { + "data": [ + { + "apiName": "default-ontology", + "displayName": "Ontology", + "description": "The default ontology", + "rid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367", + }, + { + "apiName": "shared-ontology", + "displayName": "Shared ontology", + "description": "The ontology shared with our suppliers", + "rid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367", + }, + ] + }, + "content_type": "application/json", + }, + } + ] + ): + try: + response = client_v1.ontologies.Ontology.list() + except ValidationError as e: + raise Exception("There was a validation error with listOntologies") from e + + assert serialize_response(response) == { + "data": [ + { + "apiName": "default-ontology", + "displayName": "Ontology", + "description": "The default ontology", + "rid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367", + }, + { + "apiName": "shared-ontology", + "displayName": "Shared ontology", + "description": "The ontology shared with our suppliers", + "rid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367", + }, + ] + } diff --git a/tests/v1/ontologies/test_v1_ontologies_query.py b/tests/v1/ontologies/test_v1_ontologies_query.py new file mode 100644 index 00000000..955b0f7e --- /dev/null +++ b/tests/v1/ontologies/test_v1_ontologies_query.py @@ -0,0 +1,54 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from pydantic import ValidationError + +from tests.utils import client_v1 +from tests.utils import mock_requests +from tests.utils import serialize_response + + +def test_execute(client_v1): + with mock_requests( + [ + { + "method": "POST", + "url": "https://example.palantirfoundry.com/api/v1/ontologies/{ontologyRid}/queries/{queryApiName}/execute", + "path_params": { + "ontologyRid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367", + "queryApiName": "getEmployeesInCity", + }, + "json": {"parameters": {"city": "New York"}}, + "response": { + "status": 200, + "json": {"value": ["EMP546", "EMP609", "EMP989"]}, + "content_type": "application/json", + }, + } + ] + ): + ontology_rid = "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367" + query_api_name = "getEmployeesInCity" + parameters = {"city": "New York"} + try: + response = client_v1.ontologies.Query.execute( + ontology_rid, + query_api_name, + parameters=parameters, + ) + except ValidationError as e: + raise Exception("There was a validation error with executeQuery") from e + + assert serialize_response(response) == {"value": ["EMP546", "EMP609", "EMP989"]} diff --git a/tests/v2/admin/test_v2_admin_user.py b/tests/v2/admin/test_v2_admin_user.py new file mode 100644 index 00000000..c43da973 --- /dev/null +++ b/tests/v2/admin/test_v2_admin_user.py @@ -0,0 +1,85 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from pydantic import ValidationError + +from tests.utils import client_v2 +from tests.utils import mock_requests +from tests.utils import serialize_response + + +def test_get_current(client_v2): + with mock_requests( + [ + { + "method": "GET", + "url": "https://example.palantirfoundry.com/api/v2/admin/users/getCurrent", + "path_params": {}, + "json": None, + "response": { + "status": 200, + "json": { + "givenName": "John", + "familyName": "Smith", + "organization": "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa", + "realm": "palantir-internal-realm", + "attributes": { + "multipass:givenName": ["John"], + "multipass:familyName": ["Smith"], + "multipass:email:primary": ["jsmith@example.com"], + "multipass:realm": ["eab0a251-ca1a-4a84-a482-200edfb8026f"], + "multipass:organization-rid": [ + "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa" + ], + "department": ["Finance"], + "jobTitle": ["Accountant"], + }, + "id": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", + "email": "jsmith@example.com", + "username": "jsmith", + }, + "content_type": "application/json", + }, + } + ] + ): + preview = None + try: + response = client_v2.admin.User.get_current( + preview=preview, + ) + except ValidationError as e: + raise Exception("There was a validation error with getCurrentUser") from e + + assert serialize_response(response) == { + "givenName": "John", + "familyName": "Smith", + "organization": "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa", + "realm": "palantir-internal-realm", + "attributes": { + "multipass:givenName": ["John"], + "multipass:familyName": ["Smith"], + "multipass:email:primary": ["jsmith@example.com"], + "multipass:realm": ["eab0a251-ca1a-4a84-a482-200edfb8026f"], + "multipass:organization-rid": [ + "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa" + ], + "department": ["Finance"], + "jobTitle": ["Accountant"], + }, + "id": "f05f8da4-b84c-4fca-9c77-8af0b13d11de", + "email": "jsmith@example.com", + "username": "jsmith", + } diff --git a/tests/v2/ontologies/test_v2_ontologies_action.py b/tests/v2/ontologies/test_v2_ontologies_action.py new file mode 100644 index 00000000..2a6fd8a9 --- /dev/null +++ b/tests/v2/ontologies/test_v2_ontologies_action.py @@ -0,0 +1,68 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from pydantic import ValidationError + +from tests.utils import client_v2 +from tests.utils import mock_requests +from tests.utils import serialize_response + + +def test_apply_batch(client_v2): + with mock_requests( + [ + { + "method": "POST", + "url": "https://example.palantirfoundry.com/api/v2/ontologies/{ontology}/actions/{action}/applyBatch", + "path_params": { + "ontology": "palantir", + "action": "rename-employee", + }, + "json": { + "requests": [ + {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}}, + {"parameters": {"id": 80061, "newName": "Joe Bloggs"}}, + ] + }, + "response": { + "status": 200, + "json": {}, + "content_type": "application/json", + }, + } + ] + ): + ontology = "palantir" + action = "rename-employee" + requests = [ + {"parameters": {"id": 80060, "newName": "Anna Smith-Doe"}}, + {"parameters": {"id": 80061, "newName": "Joe Bloggs"}}, + ] + artifact_repository = None + options = None + package_name = None + try: + response = client_v2.ontologies.Action.apply_batch( + ontology, + action, + requests=requests, + artifact_repository=artifact_repository, + options=options, + package_name=package_name, + ) + except ValidationError as e: + raise Exception("There was a validation error with applyActionBatchV2") from e + + assert serialize_response(response) == {} diff --git a/tests/v2/ontologies/test_v2_ontologies_ontology.py b/tests/v2/ontologies/test_v2_ontologies_ontology.py new file mode 100644 index 00000000..20182736 --- /dev/null +++ b/tests/v2/ontologies/test_v2_ontologies_ontology.py @@ -0,0 +1,59 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from pydantic import ValidationError + +from tests.utils import client_v2 +from tests.utils import mock_requests +from tests.utils import serialize_response + + +def test_get(client_v2): + with mock_requests( + [ + { + "method": "GET", + "url": "https://example.palantirfoundry.com/api/v2/ontologies/{ontology}", + "path_params": { + "ontology": "palantir", + }, + "json": None, + "response": { + "status": 200, + "json": { + "apiName": "default-ontology", + "displayName": "Ontology", + "description": "The default ontology", + "rid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367", + }, + "content_type": "application/json", + }, + } + ] + ): + ontology = "palantir" + try: + response = client_v2.ontologies.Ontology.get( + ontology, + ) + except ValidationError as e: + raise Exception("There was a validation error with getOntologyV2") from e + + assert serialize_response(response) == { + "apiName": "default-ontology", + "displayName": "Ontology", + "description": "The default ontology", + "rid": "ri.ontology.main.ontology.c61d9ab5-2919-4127-a0a1-ac64c0ce6367", + } diff --git a/tests/v2/ontologies/test_v2_ontologies_ontology_object.py b/tests/v2/ontologies/test_v2_ontologies_ontology_object.py new file mode 100644 index 00000000..996319e7 --- /dev/null +++ b/tests/v2/ontologies/test_v2_ontologies_ontology_object.py @@ -0,0 +1,56 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from pydantic import ValidationError + +from tests.utils import client_v2 +from tests.utils import mock_requests +from tests.utils import serialize_response + + +def test_count(client_v2): + with mock_requests( + [ + { + "method": "POST", + "url": "https://example.palantirfoundry.com/api/v2/ontologies/{ontology}/objects/{objectType}/count", + "path_params": { + "ontology": "palantir", + "objectType": "employee", + }, + "json": None, + "response": { + "status": 200, + "json": {"count": 100}, + "content_type": "application/json", + }, + } + ] + ): + ontology = "palantir" + object_type = "employee" + artifact_repository = None + package_name = None + try: + response = client_v2.ontologies.OntologyObject.count( + ontology, + object_type, + artifact_repository=artifact_repository, + package_name=package_name, + ) + except ValidationError as e: + raise Exception("There was a validation error with countObjects") from e + + assert serialize_response(response) == {"count": 100} diff --git a/tests/v2/ontologies/test_v2_ontologies_ontology_object_set.py b/tests/v2/ontologies/test_v2_ontologies_ontology_object_set.py new file mode 100644 index 00000000..098b035b --- /dev/null +++ b/tests/v2/ontologies/test_v2_ontologies_ontology_object_set.py @@ -0,0 +1,55 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from pydantic import ValidationError + +from tests.utils import client_v2 +from tests.utils import mock_requests +from tests.utils import serialize_response + + +def test_create_temporary(client_v2): + with mock_requests( + [ + { + "method": "POST", + "url": "https://example.palantirfoundry.com/api/v2/ontologies/{ontology}/objectSets/createTemporary", + "path_params": { + "ontology": "palantir", + }, + "json": {"objectSet": {"type": "base", "objectType": "Employee"}}, + "response": { + "status": 200, + "json": { + "objectSetRid": "ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053" + }, + "content_type": "application/json", + }, + } + ] + ): + ontology = "palantir" + object_set = {"type": "base", "objectType": "Employee"} + try: + response = client_v2.ontologies.OntologyObjectSet.create_temporary( + ontology, + object_set=object_set, + ) + except ValidationError as e: + raise Exception("There was a validation error with createTemporaryObjectSetV2") from e + + assert serialize_response(response) == { + "objectSetRid": "ri.object-set.main.object-set.c32ccba5-1a55-4cfe-ad71-160c4c77a053" + } diff --git a/tests/v2/ontologies/test_v2_ontologies_query.py b/tests/v2/ontologies/test_v2_ontologies_query.py new file mode 100644 index 00000000..4a898fb7 --- /dev/null +++ b/tests/v2/ontologies/test_v2_ontologies_query.py @@ -0,0 +1,58 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from pydantic import ValidationError + +from tests.utils import client_v2 +from tests.utils import mock_requests +from tests.utils import serialize_response + + +def test_execute(client_v2): + with mock_requests( + [ + { + "method": "POST", + "url": "https://example.palantirfoundry.com/api/v2/ontologies/{ontology}/queries/{queryApiName}/execute", + "path_params": { + "ontology": "palantir", + "queryApiName": "getEmployeesInCity", + }, + "json": {"parameters": {"city": "New York"}}, + "response": { + "status": 200, + "json": {"value": ["EMP546", "EMP609", "EMP989"]}, + "content_type": "application/json", + }, + } + ] + ): + ontology = "palantir" + query_api_name = "getEmployeesInCity" + parameters = {"city": "New York"} + artifact_repository = None + package_name = None + try: + response = client_v2.ontologies.Query.execute( + ontology, + query_api_name, + parameters=parameters, + artifact_repository=artifact_repository, + package_name=package_name, + ) + except ValidationError as e: + raise Exception("There was a validation error with executeQueryV2") from e + + assert serialize_response(response) == {"value": ["EMP546", "EMP609", "EMP989"]} diff --git a/tests/v2/third_party_applications/test_v2_third_party_applications_third_party_application.py b/tests/v2/third_party_applications/test_v2_third_party_applications_third_party_application.py new file mode 100644 index 00000000..760080ed --- /dev/null +++ b/tests/v2/third_party_applications/test_v2_third_party_applications_third_party_application.py @@ -0,0 +1,57 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from pydantic import ValidationError + +from tests.utils import client_v2 +from tests.utils import mock_requests +from tests.utils import serialize_response + + +def test_get(client_v2): + with mock_requests( + [ + { + "method": "GET", + "url": "https://example.palantirfoundry.com/api/v2/thirdPartyApplications/{thirdPartyApplicationRid}", + "path_params": { + "thirdPartyApplicationRid": "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6", + }, + "json": None, + "response": { + "status": 200, + "json": { + "rid": "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" + }, + "content_type": "application/json", + }, + } + ] + ): + third_party_application_rid = ( + "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" + ) + preview = None + try: + response = client_v2.third_party_applications.ThirdPartyApplication.get( + third_party_application_rid, + preview=preview, + ) + except ValidationError as e: + raise Exception("There was a validation error with getThirdPartyApplication") from e + + assert serialize_response(response) == { + "rid": "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" + } diff --git a/tests/v2/third_party_applications/test_v2_third_party_applications_version.py b/tests/v2/third_party_applications/test_v2_third_party_applications_version.py new file mode 100644 index 00000000..66ed74c8 --- /dev/null +++ b/tests/v2/third_party_applications/test_v2_third_party_applications_version.py @@ -0,0 +1,94 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from pydantic import ValidationError + +from tests.utils import client_v2 +from tests.utils import mock_requests +from tests.utils import serialize_response + + +def test_delete(client_v2): + with mock_requests( + [ + { + "method": "DELETE", + "url": "https://example.palantirfoundry.com/api/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion}", + "path_params": { + "thirdPartyApplicationRid": "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6", + "versionVersion": "1.2.0", + }, + "json": None, + "response": { + "status": 200, + "json": None, + "content_type": "None", + }, + } + ] + ): + third_party_application_rid = ( + "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" + ) + version_version = "1.2.0" + preview = None + try: + response = ( + client_v2.third_party_applications.ThirdPartyApplication.Website.Version.delete( + third_party_application_rid, + version_version, + preview=preview, + ) + ) + except ValidationError as e: + raise Exception("There was a validation error with deleteVersion") from e + + assert serialize_response(response) == None + + +def test_get(client_v2): + with mock_requests( + [ + { + "method": "GET", + "url": "https://example.palantirfoundry.com/api/v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion}", + "path_params": { + "thirdPartyApplicationRid": "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6", + "versionVersion": "1.2.0", + }, + "json": None, + "response": { + "status": 200, + "json": {"version": "1.2.0"}, + "content_type": "application/json", + }, + } + ] + ): + third_party_application_rid = ( + "ri.third-party-applications.main.application.292db3b2-b653-4de6-971c-7e97a7b881d6" + ) + version_version = "1.2.0" + preview = None + try: + response = client_v2.third_party_applications.ThirdPartyApplication.Website.Version.get( + third_party_application_rid, + version_version, + preview=preview, + ) + except ValidationError as e: + raise Exception("There was a validation error with getVersion") from e + + assert serialize_response(response) == {"version": "1.2.0"} diff --git a/tox.ini b/tox.ini index 452b0527..2a22c23e 100644 --- a/tox.ini +++ b/tox.ini @@ -3,6 +3,8 @@ isolated_build = true envlist = py{39,310,311,312}-pydantic{2.1.0,2.1,2.2,2.3,2.4,2.5}-requests{2.25,2.26,2.31}, pylint, mypy, black [testenv] +setenv = + PYTHONPATH = {toxinidir} deps = pytest typing-extensions >= 4.7.1 @@ -16,7 +18,7 @@ deps = requests{2.26}: requests==2.26.* requests{2.31}: requests==2.31.* commands = - pytest test/ + pytest tests/ [testenv:pyright] deps = @@ -27,6 +29,6 @@ commands = [testenv:black] deps = - black == 23.12.1 + black == 24.1.1 commands = - black --check foundry test + black --check foundry tests