Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 60 additions & 2 deletions README.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs-snippets-npm/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@
"homepage": "https://github.com/palantir/foundry-platform-python#readme",
"devDependencies": {
"@osdk/docs-spec-core": "^0.5.0",
"@osdk/platform-docs-spec": "^0.6.0",
"@osdk/docs-spec-platform": "^0.8.0",
"typescript": "^5.8.3"
},
"sls": {
"dependencies": {
"com.palantir.foundry.api:api-gateway": {
"minVersion": "1.1163.0",
"minVersion": "1.1174.0",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
41 changes: 33 additions & 8 deletions docs-snippets-npm/src/index.ts

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions docs/v1/Ontologies/models/PropertyTypeRid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# PropertyTypeRid

PropertyTypeRid

## 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)
11 changes: 11 additions & 0 deletions docs/v1/Ontologies/models/SdkPackageRid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# SdkPackageRid

SdkPackageRid

## 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)
11 changes: 11 additions & 0 deletions docs/v1/Ontologies/models/SdkVersion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# SdkVersion

SdkVersion

## Type
```python
str
```


[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md)
52 changes: 52 additions & 0 deletions docs/v2/Admin/Organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**get**](#get) | **GET** /v2/admin/organizations/{organizationRid} | Public Beta |
[**list_available_roles**](#list_available_roles) | **GET** /v2/admin/organizations/{organizationRid}/listAvailableRoles | Public Beta |
[**replace**](#replace) | **PUT** /v2/admin/organizations/{organizationRid} | Public Beta |

# **get**
Expand Down Expand Up @@ -55,6 +56,57 @@ 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_available_roles**
List all roles that can be assigned to a principal for the given Organization.


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**organization_rid** | OrganizationRid | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**ListAvailableOrganizationRolesResponse**

### Example

```python
from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# OrganizationRid
organization_rid = None
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.admin.Organization.list_available_roles(organization_rid, preview=preview)
print("The list_available_roles response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling Organization.list_available_roles: %s\n" % e)

```



### Authorization

See [README](../../../README.md#authorization)

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | ListAvailableOrganizationRolesResponse | | 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)

# **replace**
Replace the Organization with the specified rid.

Expand Down
183 changes: 183 additions & 0 deletions docs/v2/Admin/OrganizationRoleAssignment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,183 @@
# OrganizationRoleAssignment

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**add**](#add) | **POST** /v2/admin/organizations/{organizationRid}/roleAssignments/add | Public Beta |
[**list**](#list) | **GET** /v2/admin/organizations/{organizationRid}/roleAssignments | Public Beta |
[**remove**](#remove) | **POST** /v2/admin/organizations/{organizationRid}/roleAssignments/remove | Public Beta |

# **add**
Assign roles to principals for the given Organization. At most 100 role assignments can be added in a single request.


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**organization_rid** | OrganizationRid | | |
**role_assignments** | List[RoleAssignmentUpdate] | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**None**

### Example

```python
from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# OrganizationRid
organization_rid = None
# List[RoleAssignmentUpdate]
role_assignments = [
{
"roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268",
"principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
}
]
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.admin.Organization.OrganizationRoleAssignment.add(
organization_rid, role_assignments=role_assignments, preview=preview
)
print("The add response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling OrganizationRoleAssignment.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**
List all principals who are assigned a role for the given Organization.


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**organization_rid** | OrganizationRid | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**ListOrganizationRoleAssignmentsResponse**

### Example

```python
from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# OrganizationRid
organization_rid = None
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.admin.Organization.OrganizationRoleAssignment.list(
organization_rid, preview=preview
)
print("The list response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling OrganizationRoleAssignment.list: %s\n" % e)

```



### Authorization

See [README](../../../README.md#authorization)

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | ListOrganizationRoleAssignmentsResponse | | 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**
Remove roles from principals for the given Organization. At most 100 role assignments can be removed in a single request.


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**organization_rid** | OrganizationRid | | |
**role_assignments** | List[RoleAssignmentUpdate] | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**None**

### Example

```python
from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# OrganizationRid
organization_rid = None
# List[RoleAssignmentUpdate]
role_assignments = [
{
"roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268",
"principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de",
}
]
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.admin.Organization.OrganizationRoleAssignment.remove(
organization_rid, role_assignments=role_assignments, preview=preview
)
print("The remove response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
print("HTTP error when calling OrganizationRoleAssignment.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)

11 changes: 11 additions & 0 deletions docs/v2/Admin/models/ListAvailableOrganizationRolesResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# ListAvailableOrganizationRolesResponse

ListAvailableOrganizationRolesResponse

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**data** | List[Role] | Yes | |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
12 changes: 12 additions & 0 deletions docs/v2/Admin/models/ListOrganizationRoleAssignmentsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ListOrganizationRoleAssignmentsResponse

ListOrganizationRoleAssignmentsResponse

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**data** | List[OrganizationRoleAssignment] | 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)
13 changes: 13 additions & 0 deletions docs/v2/Admin/models/OrganizationRoleAssignment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# OrganizationRoleAssignment

OrganizationRoleAssignment

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**principal_type** | PrincipalType | Yes | |
**principal_id** | PrincipalId | Yes | |
**role_id** | RoleId | Yes | |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
8 changes: 8 additions & 0 deletions docs/v2/AipAgents/Session.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Name | Type | Description | Notes |
**user_input** | UserTextInput | The user message for the Agent to respond to. | |
**contexts_override** | Optional[List[InputContext]] | If set, automatic [context retrieval](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. | [optional] |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
**session_trace_id** | Optional[SessionTraceId] | The unique identifier to use for this continue session trace. By generating and passing this ID to the `blockingContinue` endpoint, clients can use this trace ID to separately load details of the trace used to generate a result, while the result is in progress. If omitted, it will be generated automatically. Clients can check the generated ID by inspecting the `sessionTraceId` in the `SessionExchangeResult`. | [optional] |

### Return type
**SessionExchangeResult**
Expand Down Expand Up @@ -65,6 +66,8 @@ user_input = {"text": "What is the status of my order?"}
contexts_override = None
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None
# Optional[SessionTraceId] | The unique identifier to use for this continue session trace. By generating and passing this ID to the `blockingContinue` endpoint, clients can use this trace ID to separately load details of the trace used to generate a result, while the result is in progress. If omitted, it will be generated automatically. Clients can check the generated ID by inspecting the `sessionTraceId` in the `SessionExchangeResult`.
session_trace_id = "12345678-1234-5678-1234-123456789abc"


try:
Expand All @@ -75,6 +78,7 @@ try:
user_input=user_input,
contexts_override=contexts_override,
preview=preview,
session_trace_id=session_trace_id,
)
print("The blocking_continue response:\n")
pprint(api_response)
Expand Down Expand Up @@ -419,6 +423,7 @@ Name | Type | Description | Notes |
**contexts_override** | Optional[List[InputContext]] | If set, automatic [context](https://palantir.com/docs/foundry/agent-studio/retrieval-context/) retrieval is skipped and the list of specified context is provided to the Agent instead. If omitted, relevant context for the user message is automatically retrieved and included in the prompt, based on data sources configured on the Agent for the session. | [optional] |
**message_id** | Optional[MessageId] | A client-generated Universally Unique Identifier (UUID) to identify the message, which the client can use to cancel the exchange before the streaming response is complete. | [optional] |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
**session_trace_id** | Optional[SessionTraceId] | The unique identifier to use for this continue session trace. By generating and passing this ID to the `streamingContinue` endpoint, clients can use this trace ID to separately load details of the trace used to generate a result, while the result is in progress. If omitted, it will be generated automatically. Clients can check the generated ID by inspecting the `sessionTraceId` in the `SessionExchangeResult`, which can be loaded via the `getContent` endpoint. | [optional] |

### Return type
**bytes**
Expand Down Expand Up @@ -456,6 +461,8 @@ contexts_override = None
message_id = "00f8412a-c29d-4063-a417-8052825285a5"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None
# Optional[SessionTraceId] | The unique identifier to use for this continue session trace. By generating and passing this ID to the `streamingContinue` endpoint, clients can use this trace ID to separately load details of the trace used to generate a result, while the result is in progress. If omitted, it will be generated automatically. Clients can check the generated ID by inspecting the `sessionTraceId` in the `SessionExchangeResult`, which can be loaded via the `getContent` endpoint.
session_trace_id = "12345678-1234-5678-1234-123456789abc"


try:
Expand All @@ -467,6 +474,7 @@ try:
contexts_override=contexts_override,
message_id=message_id,
preview=preview,
session_trace_id=session_trace_id,
)
print("The streaming_continue response:\n")
pprint(api_response)
Expand Down
Loading