Skip to content

Commit 724e870

Browse files
daherrerodaherrero
authored
Enable Checkpoints and regenerate SDK with API Gateway 1.1495.0 (#327)
Enable Checkpoints and regenerate SDK with API Gateway 1.1495.0
1 parent 78e6012 commit 724e870

146 files changed

Lines changed: 3907 additions & 673 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 116 additions & 1 deletion
Large diffs are not rendered by default.

‎config.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,7 @@
171171
"Admin": true,
172172
"AipAgents": true,
173173
"Audit": true,
174+
"Checkpoints": true,
174175
"Connectivity": true,
175176
"Core": true,
176177
"DataHealth": true,

‎docs-snippets-npm/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424
"sls": {
2525
"dependencies": {
2626
"com.palantir.foundry.api:api-gateway": {
27-
"minVersion": "1.1494.0",
27+
"minVersion": "1.1495.0",
2828
"maxVersion": "1.x.x",
2929
"optional": false
3030
}

‎docs-snippets-npm/src/index.ts‎

Lines changed: 45 additions & 30 deletions
Large diffs are not rendered by default.

‎docs/v2/Checkpoints/Record.md‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
# Record
2+
3+
Method | HTTP request | Release Stage |
4+
------------- | ------------- | ----- |
5+
[**get**](#get) | **GET** /v2/checkpoints/records/{recordRid} | Public Beta |
6+
[**get_batch**](#get_batch) | **POST** /v2/checkpoints/records/getBatch | Public Beta |
7+
[**search**](#search) | **POST** /v2/checkpoints/records/search | Public Beta |
8+
9+
# **get**
10+
Retrieve a single checkpoint record by id.
11+
12+
### Parameters
13+
14+
Name | Type | Description | Notes |
15+
------------- | ------------- | ------------- | ------------- |
16+
**record_rid** | RecordRid | | |
17+
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
18+
19+
### Return type
20+
**Record**
21+
22+
### Example
23+
24+
```python
25+
from foundry_sdk import FoundryClient
26+
import foundry_sdk
27+
from pprint import pprint
28+
29+
client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")
30+
31+
# RecordRid
32+
record_rid = None
33+
# Optional[PreviewMode] | Enables the use of preview functionality.
34+
preview = None
35+
36+
37+
try:
38+
api_response = client.checkpoints.Record.get(record_rid, preview=preview)
39+
print("The get response:\n")
40+
pprint(api_response)
41+
except foundry_sdk.PalantirRPCException as e:
42+
print("HTTP error when calling Record.get: %s\n" % e)
43+
44+
```
45+
46+
47+
48+
### Authorization
49+
50+
See [README](../../../README.md#authorization)
51+
52+
### HTTP response details
53+
| Status Code | Type | Description | Content Type |
54+
|-------------|-------------|-------------|------------------|
55+
**200** | Record | | application/json |
56+
57+
[[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)
58+
59+
# **get_batch**
60+
Fetch multiple checkpoint records in a single request. Records not found
61+
or inaccessible to the user will be omitted from the response.
62+
63+
64+
The maximum batch size for this endpoint is 100.
65+
66+
### Parameters
67+
68+
Name | Type | Description | Notes |
69+
------------- | ------------- | ------------- | ------------- |
70+
**body** | List[GetRecordsBatchRequestElement] | Body of the request | |
71+
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
72+
73+
### Return type
74+
**GetRecordsBatchResponse**
75+
76+
### Example
77+
78+
```python
79+
from foundry_sdk import FoundryClient
80+
import foundry_sdk
81+
from pprint import pprint
82+
83+
client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")
84+
85+
# List[GetRecordsBatchRequestElement] | Body of the request
86+
body = [{"recordRid": "ri.checkpoints.main.checkpoint.a1b2c3d4-e5f6-7890-abcd-ef1234567890"}]
87+
# Optional[PreviewMode] | Enables the use of preview functionality.
88+
preview = None
89+
90+
91+
try:
92+
api_response = client.checkpoints.Record.get_batch(body, preview=preview)
93+
print("The get_batch response:\n")
94+
pprint(api_response)
95+
except foundry_sdk.PalantirRPCException as e:
96+
print("HTTP error when calling Record.get_batch: %s\n" % e)
97+
98+
```
99+
100+
101+
102+
### Authorization
103+
104+
See [README](../../../README.md#authorization)
105+
106+
### HTTP response details
107+
| Status Code | Type | Description | Content Type |
108+
|-------------|-------------|-------------|------------------|
109+
**200** | GetRecordsBatchResponse | | application/json |
110+
111+
[[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)
112+
113+
# **search**
114+
Search for checkpoint records.
115+
116+
### Parameters
117+
118+
Name | Type | Description | Notes |
119+
------------- | ------------- | ------------- | ------------- |
120+
**where** | SearchCheckpointRecordsRequest | | |
121+
**page_size** | Optional[PageSize] | The page size for the search request. If no value is provided, a default of `100` will be used. | [optional] |
122+
**page_token** | Optional[PageToken] | | [optional] |
123+
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
124+
**sort_direction** | Optional[SortDirection] | Chronological order of creation time for records to be returned in. Defaults to reverse chronological order (DESC). | [optional] |
125+
126+
### Return type
127+
**SearchCheckpointRecordsResponse**
128+
129+
### Example
130+
131+
```python
132+
from foundry_sdk import FoundryClient
133+
import foundry_sdk
134+
from pprint import pprint
135+
136+
client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")
137+
138+
# SearchCheckpointRecordsRequest
139+
where = {"filter": {"type": "eq", "field": "checkpointType", "value": "CONTOUR_EXPORT"}}
140+
# Optional[PageSize] | The page size for the search request. If no value is provided, a default of `100` will be used.
141+
page_size = 100
142+
# Optional[PageToken]
143+
page_token = "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
144+
# Optional[PreviewMode] | Enables the use of preview functionality.
145+
preview = None
146+
# Optional[SortDirection] | Chronological order of creation time for records to be returned in. Defaults to reverse chronological order (DESC).
147+
sort_direction = "DESC"
148+
149+
150+
try:
151+
api_response = client.checkpoints.Record.search(
152+
where=where,
153+
page_size=page_size,
154+
page_token=page_token,
155+
preview=preview,
156+
sort_direction=sort_direction,
157+
)
158+
print("The search response:\n")
159+
pprint(api_response)
160+
except foundry_sdk.PalantirRPCException as e:
161+
print("HTTP error when calling Record.search: %s\n" % e)
162+
163+
```
164+
165+
166+
167+
### Authorization
168+
169+
See [README](../../../README.md#authorization)
170+
171+
### HTTP response details
172+
| Status Code | Type | Description | Content Type |
173+
|-------------|-------------|-------------|------------------|
174+
**200** | SearchCheckpointRecordsResponse | | application/json |
175+
176+
[[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)
177+

‎docs/v2/Checkpoints/models/AcknowledgementJustification.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# AcknowledgementJustification
2+
3+
Checkpoint justification that requires the user to mark a checkbox.
4+
5+
## Properties
6+
| Name | Type | Required | Description |
7+
| ------------ | ------------- | ------------- | ------------- |
8+
**prompt** | str | Yes | Prompt acknowledged by the user. |
9+
**description** | Optional[str] | No | Supplemental information that helps users understand the prompt. |
10+
**title** | str | Yes | Title of the checkpoint the user is acknowledging. |
11+
**type** | Literal["acknowledgementJustification"] | Yes | None |
12+
13+
14+
[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)

‎docs/v2/Checkpoints/models/ActingUser.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ActingUser
2+
3+
User that performed the checkpoint action.
4+
5+
## Properties
6+
| Name | Type | Required | Description |
7+
| ------------ | ------------- | ------------- | ------------- |
8+
**user_id** | UserId | Yes | |
9+
**username** | RedactableString | Yes | |
10+
**organization_rid** | Optional[OrganizationRid] | No | |
11+
12+
13+
[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)

‎docs/v2/Checkpoints/models/ApprovalsMetadata.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# ApprovalsMetadata
2+
3+
Metadata linking a checkpoint record to an Approvals workflow.
4+
5+
## Properties
6+
| Name | Type | Required | Description |
7+
| ------------ | ------------- | ------------- | ------------- |
8+
**approvals_task_id** | ApprovalsTaskId | Yes | |
9+
**approvals_subtask_ids** | List[ApprovalsSubtaskId] | Yes | |
10+
11+
12+
[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)

‎docs/v2/Checkpoints/models/ApprovalsSubtaskId.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ApprovalsSubtaskId
2+
3+
Identifier of an Approvals subtask tied to the checkpoint.
4+
5+
## Type
6+
```python
7+
str
8+
```
9+
10+
11+
[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)

‎docs/v2/Checkpoints/models/ApprovalsTaskId.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# ApprovalsTaskId
2+
3+
Identifier of an Approvals task tied to the checkpoint.
4+
5+
## Type
6+
```python
7+
str
8+
```
9+
10+
11+
[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)

0 commit comments

Comments
 (0)