Excavator: Upgrade API Version (#77)

palantir · Nov 28, 2024 · fcd5603 · fcd5603
1 parent 6ae589a
commit fcd5603
Show file tree

Hide file tree

Showing 209 changed files with 4,088 additions and 249 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,3 @@
 **/__pycache__
 *.pyc
 tmp
-
-# IntelliJ
-.idea/
diff --git a/README.md b/README.md
diff --git a/docs/v1/ontologies/models/CreateInterfaceObjectRule.md b/docs/v1/ontologies/models/CreateInterfaceObjectRule.md
@@ -5,6 +5,7 @@ CreateInterfaceObjectRule
 ## Properties
 | Name | Type | Required | Description |
 | ------------ | ------------- | ------------- | ------------- |
+**interface_type_api_name** | InterfaceTypeApiName | Yes |  |
 **type** | Literal["createInterfaceObject"] | Yes | None |
 
 

diff --git a/docs/v1/ontologies/models/CreateInterfaceObjectRuleDict.md b/docs/v1/ontologies/models/CreateInterfaceObjectRuleDict.md
@@ -5,6 +5,7 @@ CreateInterfaceObjectRule
 ## Properties
 | Name | Type | Required | Description |
 | ------------ | ------------- | ------------- | ------------- |
+**interfaceTypeApiName** | InterfaceTypeApiName | Yes |  |
 **type** | Literal["createInterfaceObject"] | Yes | None |
 
 

diff --git a/docs/v1/ontologies/models/DeleteInterfaceObjectRule.md b/docs/v1/ontologies/models/DeleteInterfaceObjectRule.md
@@ -0,0 +1,12 @@
+# DeleteInterfaceObjectRule
+
+DeleteInterfaceObjectRule
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**interface_type_api_name** | InterfaceTypeApiName | Yes |  |
+**type** | Literal["deleteInterfaceObject"] | Yes | None |
+
+
+[[Back to Model list]](../../../../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/DeleteInterfaceObjectRuleDict.md b/docs/v1/ontologies/models/DeleteInterfaceObjectRuleDict.md
@@ -0,0 +1,12 @@
+# DeleteInterfaceObjectRuleDict
+
+DeleteInterfaceObjectRule
+
+## Properties
+| Name | Type | Required | Description |
+| ------------ | ------------- | ------------- | ------------- |
+**interfaceTypeApiName** | InterfaceTypeApiName | Yes |  |
+**type** | Literal["deleteInterfaceObject"] | Yes | None |
+
+
+[[Back to Model list]](../../../../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/InterfaceTypeApiName.md b/docs/v1/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
+pydantic.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/LogicRule.md b/docs/v1/ontologies/models/LogicRule.md
@@ -9,6 +9,7 @@ This discriminator class uses the `type` field to differentiate between classes.
 
 | Class | Value
 | ------------ | -------------
+DeleteInterfaceObjectRule | deleteInterfaceObject
 ModifyInterfaceObjectRule | modifyInterfaceObject
 ModifyObjectRule | modifyObject
 DeleteObjectRule | deleteObject

diff --git a/docs/v1/ontologies/models/LogicRuleDict.md b/docs/v1/ontologies/models/LogicRuleDict.md
@@ -9,6 +9,7 @@ This discriminator class uses the `type` field to differentiate between classes.
 
 | Class | Value
 | ------------ | -------------
+DeleteInterfaceObjectRuleDict | deleteInterfaceObject
 ModifyInterfaceObjectRuleDict | modifyInterfaceObject
 ModifyObjectRuleDict | modifyObject
 DeleteObjectRuleDict | deleteObject

diff --git a/docs/v1/ontologies/models/ModifyInterfaceObjectRule.md b/docs/v1/ontologies/models/ModifyInterfaceObjectRule.md
@@ -5,6 +5,7 @@ ModifyInterfaceObjectRule
 ## Properties
 | Name | Type | Required | Description |
 | ------------ | ------------- | ------------- | ------------- |
+**interface_type_api_name** | InterfaceTypeApiName | Yes |  |
 **type** | Literal["modifyInterfaceObject"] | Yes | None |
 
 

diff --git a/docs/v1/ontologies/models/ModifyInterfaceObjectRuleDict.md b/docs/v1/ontologies/models/ModifyInterfaceObjectRuleDict.md
@@ -5,6 +5,7 @@ ModifyInterfaceObjectRule
 ## Properties
 | Name | Type | Required | Description |
 | ------------ | ------------- | ------------- | ------------- |
+**interfaceTypeApiName** | InterfaceTypeApiName | Yes |  |
 **type** | Literal["modifyInterfaceObject"] | Yes | None |
 
 

diff --git a/docs/v1/ontologies/models/PropertyValue.md b/docs/v1/ontologies/models/PropertyValue.md
@@ -2,23 +2,25 @@
 
 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"`                                                                           |
+| 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"`                                                                                 |
+| MediaReference | JSON encoded `MediaReference` object                        | `{"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}}`                       |
+| Short           | number                                                      | `8739`                                                                                             |
+| String          | string                                                      | `"Call me Ishmael"`                                                                                |
+| Timestamp       | ISO 8601 extended offset date-time string in UTC zone       | `"2021-01-04T05:00:00Z"`                                                                           |
+| Timeseries      | JSON encoded `TimeseriesProperty` object or seriesId string | `{"seriesId": "wellPressureSeriesId", "syncRid": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df"}` or `{"templateRid": "ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9", "templateVersion": "0.0.0"}` or `"wellPressureSeriesId"`|                                                                           |
 
 Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings.
 

diff --git a/docs/v2/Admin/Group.md b/docs/v2/Admin/Group.md
@@ -37,7 +37,17 @@ foundry_client = FoundryClient(
 )
 
 # 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
+attributes = {
+    "multipass:givenName": ["John"],
+    "multipass:familyName": ["Smith"],
+    "multipass:email:primary": ["[email protected]"],
+    "multipass:realm": ["eab0a251-ca1a-4a84-a482-200edfb8026f"],
+    "multipass:organization-rid": [
+        "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
+    ],
+    "department": ["Finance"],
+    "jobTitle": ["Accountant"],
+}
 # 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.

diff --git a/docs/v2/Connectivity/Connection.md b/docs/v2/Connectivity/Connection.md
@@ -2,6 +2,7 @@
 
 Method | HTTP request |
 ------------- | ------------- |
+[**update_secrets**](#update_secrets) | **POST** /v2/connectivity/connections/{connectionRid}/updateSecrets |
 
 Get the Connection with the specified rid.
 
@@ -57,9 +58,19 @@ See [README](../../../README.md#authorization)
 
 [[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)
 
+# **update_secrets**
 Updates the secrets on the connection to the specified secret values.
 Secrets that are currently configured on the connection but are omitted in the request will remain unchanged.
 
+Secrets are transmitted over the network encrypted using TLS. Once the secrets reach Foundry's servers, 
+they will be temporarily decrypted and remain in plaintext in memory to be processed as needed. 
+They will stay in plaintext in memory until the garbage collection process cleans up the memory. 
+The secrets are always stored encrypted on our servers.
+
+By using this endpoint, you acknowledge and accept any potential risks associated with the temporary 
+in-memory handling of secrets. If you do not want your secrets to be temporarily decrypted, you should 
+use the Foundry UI instead.
+
 
 ### Parameters
 
@@ -86,7 +97,7 @@ foundry_client = FoundryClient(
 # ConnectionRid | connectionRid
 connection_rid = None
 # Dict[SecretName, PlaintextValue] | The secrets to be updated. The specified secret names must already be configured on the connection.
-secrets = None
+secrets = {"Password": "MySecretPassword"}
 # Optional[PreviewMode] | preview
 preview = None
 

diff --git a/docs/v2/Connectivity/FileImport.md b/docs/v2/Connectivity/FileImport.md
@@ -2,7 +2,14 @@
 
 Method | HTTP request |
 ------------- | ------------- |
-
+[**create**](#create) | **POST** /v2/connectivity/connections/{connectionRid}/fileImports |
+[**delete**](#delete) | **DELETE** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid} |
+[**execute**](#execute) | **POST** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}/execute |
+[**get**](#get) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid} |
+[**list**](#list) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports |
+[**page**](#page) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports |
+
+# **create**
 Creates a new FileImport.
 
 ### Parameters
@@ -37,7 +44,7 @@ connection_rid = None
 # DatasetRid | The RID of the output dataset.
 dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"
 # FileImportDisplayName |
-display_name = None
+display_name = "My file import"
 # List[FileImportFilterDict] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs)
 file_import_filters = None
 # FileImportMode |
@@ -81,6 +88,7 @@ See [README](../../../README.md#authorization)
 
 [[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 FileImport with the specified RID.
 Deleting the file import does not delete the destination dataset but the dataset will no longer
 be updated by this import.
@@ -142,6 +150,7 @@ See [README](../../../README.md#authorization)
 
 [[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)
 
+# **execute**
 Executes the FileImport, which runs asynchronously as a [Foundry Build](/docs/foundry/data-integration/builds/).
 The returned BuildRid can be used to check the status via the Orchestration API.
 
@@ -202,6 +211,7 @@ See [README](../../../README.md#authorization)
 
 [[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 FileImport with the specified rid.
 
 ### Parameters
@@ -260,6 +270,7 @@ See [README](../../../README.md#authorization)
 
 [[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 file imports defined for this connection.
 Only file imports that the user has permissions to view will be returned.
 
@@ -319,6 +330,7 @@ See [README](../../../README.md#authorization)
 
 [[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 file imports defined for this connection.
 Only file imports that the user has permissions to view will be returned.
 
@@ -383,3 +395,85 @@ See [README](../../../README.md#authorization)
 
 [[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)
 
+Replace the FileImport with the specified rid.
+
+### Parameters
+
+Name | Type | Description  | Notes |
+------------- | ------------- | ------------- | ------------- |
+**connection_rid** | ConnectionRid | connectionRid |  |
+**file_import_rid** | FileImportRid | fileImportRid |  |
+**dataset_rid** | DatasetRid | The RID of the output dataset. |  |
+**display_name** | FileImportDisplayName |  |  |
+**file_import_filters** | List[FileImportFilterDict] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) |  |
+**import_mode** | FileImportMode |  |  |
+**branch_name** | Optional[BranchName] | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. | [optional] |
+**preview** | Optional[PreviewMode] | preview | [optional] |
+**subfolder** | Optional[pydantic.StrictStr] | A subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system. | [optional] |
+
+### Return type
+**FileImport**
+
+### Example
+
+```python
+from foundry.v2 import FoundryClient
+import foundry
+from pprint import pprint
+
+foundry_client = FoundryClient(
+    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
+)
+
+# ConnectionRid | connectionRid
+connection_rid = None
+# FileImportRid | fileImportRid
+file_import_rid = None
+# DatasetRid | The RID of the output dataset.
+dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da"
+# FileImportDisplayName |
+display_name = "My file import"
+# List[FileImportFilterDict] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs)
+file_import_filters = None
+# FileImportMode |
+import_mode = "SNAPSHOT"
+# Optional[BranchName] | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments.
+branch_name = "master"
+# Optional[PreviewMode] | preview
+preview = None
+# Optional[pydantic.StrictStr] | A subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system.
+subfolder = "subfolder1/subfolder2"
+
+
+try:
+    api_response = foundry_client.connectivity.Connection.FileImport.replace(
+        connection_rid,
+        file_import_rid,
+        dataset_rid=dataset_rid,
+        display_name=display_name,
+        file_import_filters=file_import_filters,
+        import_mode=import_mode,
+        branch_name=branch_name,
+        preview=preview,
+        subfolder=subfolder,
+    )
+    print("The replace response:\n")
+    pprint(api_response)
+except foundry.PalantirRPCException as e:
+    print("HTTP error when calling FileImport.replace: %s\n" % e)
+
+```
+
+
+
+### Authorization
+
+See [README](../../../README.md#authorization)
+
+### HTTP response details
+| Status Code | Type        | Description | Content Type |
+|-------------|-------------|-------------|------------------|
+**200** | FileImport  | The replaced FileImport | 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)
+