Skip to content

Commit 62a5892

Browse files
svc-excavator-botsvc-excavator-bot
committed
Excavator: Upgrade API Version
1 parent e2841fe commit 62a5892

72 files changed

Lines changed: 1671 additions & 375 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: 33 additions & 0 deletions
Large diffs are not rendered by default.

‎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.1497.0",
27+
"minVersion": "1.1507.0",
2828
"maxVersion": "1.x.x",
2929
"optional": false
3030
}

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

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

‎docs/v2/Admin/CbacBanner.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# CbacBanner
2+
3+
Method | HTTP request | Release Stage |
4+
------------- | ------------- | ----- |
5+
[**get**](#get) | **GET** /v2/admin/cbacBanner | Public Beta |
6+
7+
# **get**
8+
Returns a classification banner string and colors for the given set of marking IDs.
9+
10+
### Parameters
11+
12+
Name | Type | Description | Notes |
13+
------------- | ------------- | ------------- | ------------- |
14+
**display_type** | Optional[ClassificationBannerDisplayType] | The display type of the banner. Defaults to PORTION_MARKING. | [optional] |
15+
**marking_ids** | Optional[List[MarkingId]] | The marking IDs for which to generate a banner. | [optional] |
16+
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
17+
18+
### Return type
19+
**CbacBanner**
20+
21+
### Example
22+
23+
```python
24+
from foundry_sdk import FoundryClient
25+
import foundry_sdk
26+
from pprint import pprint
27+
28+
client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")
29+
30+
# Optional[ClassificationBannerDisplayType] | The display type of the banner. Defaults to PORTION_MARKING.
31+
display_type = None
32+
# Optional[List[MarkingId]] | The marking IDs for which to generate a banner.
33+
marking_ids = None
34+
# Optional[PreviewMode] | Enables the use of preview functionality.
35+
preview = None
36+
37+
38+
try:
39+
api_response = client.admin.CbacBanner.get(
40+
display_type=display_type, marking_ids=marking_ids, preview=preview
41+
)
42+
print("The get response:\n")
43+
pprint(api_response)
44+
except foundry_sdk.PalantirRPCException as e:
45+
print("HTTP error when calling CbacBanner.get: %s\n" % e)
46+
47+
```
48+
49+
50+
51+
### Authorization
52+
53+
See [README](../../../README.md#authorization)
54+
55+
### HTTP response details
56+
| Status Code | Type | Description | Content Type |
57+
|-------------|-------------|-------------|------------------|
58+
**200** | CbacBanner | | application/json |
59+
60+
[[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)
61+

‎docs/v2/Admin/Enrollment.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
Method | HTTP request | Release Stage |
44
------------- | ------------- | ----- |
5-
[**get**](#get) | **GET** /v2/admin/enrollments/{enrollmentRid} | Private Beta |
6-
[**get_current**](#get_current) | **GET** /v2/admin/enrollments/getCurrent | Private Beta |
5+
[**get**](#get) | **GET** /v2/admin/enrollments/{enrollmentRid} | Public Beta |
6+
[**get_current**](#get_current) | **GET** /v2/admin/enrollments/getCurrent | Public Beta |
77

88
# **get**
99
Get the Enrollment with the specified rid.

‎docs/v2/Admin/EnrollmentRoleAssignment.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
Method | HTTP request | Release Stage |
44
------------- | ------------- | ----- |
5-
[**add**](#add) | **POST** /v2/admin/enrollments/{enrollmentRid}/roleAssignments/add | Private Beta |
6-
[**list**](#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/roleAssignments | Private Beta |
7-
[**remove**](#remove) | **POST** /v2/admin/enrollments/{enrollmentRid}/roleAssignments/remove | Private Beta |
5+
[**add**](#add) | **POST** /v2/admin/enrollments/{enrollmentRid}/roleAssignments/add | Public Beta |
6+
[**list**](#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/roleAssignments | Public Beta |
7+
[**remove**](#remove) | **POST** /v2/admin/enrollments/{enrollmentRid}/roleAssignments/remove | Public Beta |
88

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

‎docs/v2/Admin/GroupProviderInfo.md‎

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
Method | HTTP request | Release Stage |
44
------------- | ------------- | ----- |
5-
[**get**](#get) | **GET** /v2/admin/groups/{groupId}/providerInfo | Public Beta |
6-
[**replace**](#replace) | **PUT** /v2/admin/groups/{groupId}/providerInfo | Public Beta |
5+
[**get**](#get) | **GET** /v2/admin/groups/{groupId}/providerInfo | Stable |
6+
[**replace**](#replace) | **PUT** /v2/admin/groups/{groupId}/providerInfo | Stable |
77

88
# **get**
99
Get the GroupProviderInfo.
@@ -13,7 +13,6 @@ Get the GroupProviderInfo.
1313
Name | Type | Description | Notes |
1414
------------- | ------------- | ------------- | ------------- |
1515
**group_id** | GroupId | | |
16-
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
1716

1817
### Return type
1918
**GroupProviderInfo**
@@ -29,12 +28,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa
2928

3029
# GroupId
3130
group_id = None
32-
# Optional[PreviewMode] | Enables the use of preview functionality.
33-
preview = None
3431

3532

3633
try:
37-
api_response = client.admin.Group.ProviderInfo.get(group_id, preview=preview)
34+
api_response = client.admin.Group.ProviderInfo.get(group_id)
3835
print("The get response:\n")
3936
pprint(api_response)
4037
except foundry_sdk.PalantirRPCException as e:
@@ -64,7 +61,6 @@ Name | Type | Description | Notes |
6461
------------- | ------------- | ------------- | ------------- |
6562
**group_id** | GroupId | | |
6663
**provider_id** | ProviderId | The ID of the Group in the external authentication provider. This value is determined by the authentication provider. At most one Group can have a given provider ID in a given Realm. | |
67-
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
6864

6965
### Return type
7066
**GroupProviderInfo**
@@ -82,14 +78,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa
8278
group_id = None
8379
# ProviderId | The ID of the Group in the external authentication provider. This value is determined by the authentication provider. At most one Group can have a given provider ID in a given Realm.
8480
provider_id = "2838c8f3-d76a-4e99-acf1-1dee537e4c48"
85-
# Optional[PreviewMode] | Enables the use of preview functionality.
86-
preview = None
8781

8882

8983
try:
90-
api_response = client.admin.Group.ProviderInfo.replace(
91-
group_id, provider_id=provider_id, preview=preview
92-
)
84+
api_response = client.admin.Group.ProviderInfo.replace(group_id, provider_id=provider_id)
9385
print("The replace response:\n")
9486
pprint(api_response)
9587
except foundry_sdk.PalantirRPCException as e:

‎docs/v2/Admin/Host.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Method | HTTP request | Release Stage |
44
------------- | ------------- | ----- |
5-
[**list**](#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/hosts | Private Beta |
5+
[**list**](#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/hosts | Public Beta |
66

77
# **list**
88
Lists all Hosts.

‎docs/v2/Admin/MarkingCategory.md‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
Method | HTTP request | Release Stage |
44
------------- | ------------- | ----- |
5-
[**create**](#create) | **POST** /v2/admin/markingCategories | Private Beta |
6-
[**get**](#get) | **GET** /v2/admin/markingCategories/{markingCategoryId} | Public Beta |
7-
[**list**](#list) | **GET** /v2/admin/markingCategories | Public Beta |
8-
[**replace**](#replace) | **PUT** /v2/admin/markingCategories/{markingCategoryId} | Private Beta |
5+
[**create**](#create) | **POST** /v2/admin/markingCategories | Public Beta |
6+
[**get**](#get) | **GET** /v2/admin/markingCategories/{markingCategoryId} | Stable |
7+
[**list**](#list) | **GET** /v2/admin/markingCategories | Stable |
8+
[**replace**](#replace) | **PUT** /v2/admin/markingCategories/{markingCategoryId} | Public Beta |
99

1010
# **create**
1111
Creates a new MarkingCategory.
@@ -37,6 +37,7 @@ description = "Markings related to data about our customers"
3737
initial_permissions = {
3838
"organizationRids": ["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"],
3939
"roles": [{"role": "ADMINISTER", "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"}],
40+
"isPublic": False,
4041
}
4142
# MarkingCategoryName
4243
name = "Customer Data"
@@ -76,7 +77,6 @@ Get the MarkingCategory with the specified id.
7677
Name | Type | Description | Notes |
7778
------------- | ------------- | ------------- | ------------- |
7879
**marking_category_id** | MarkingCategoryId | | |
79-
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
8080

8181
### Return type
8282
**MarkingCategory**
@@ -92,12 +92,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa
9292

9393
# MarkingCategoryId
9494
marking_category_id = None
95-
# Optional[PreviewMode] | Enables the use of preview functionality.
96-
preview = None
9795

9896

9997
try:
100-
api_response = client.admin.MarkingCategory.get(marking_category_id, preview=preview)
98+
api_response = client.admin.MarkingCategory.get(marking_category_id)
10199
print("The get response:\n")
102100
pprint(api_response)
103101
except foundry_sdk.PalantirRPCException as e:
@@ -127,7 +125,6 @@ Name | Type | Description | Notes |
127125
------------- | ------------- | ------------- | ------------- |
128126
**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] |
129127
**page_token** | Optional[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 use it to populate the `pageToken` field of the next request. | [optional] |
130-
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
131128

132129
### Return type
133130
**ListMarkingCategoriesResponse**
@@ -145,13 +142,11 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa
145142
page_size = None
146143
# Optional[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 use it to populate the `pageToken` field of the next request.
147144
page_token = None
148-
# Optional[PreviewMode] | Enables the use of preview functionality.
149-
preview = None
150145

151146

152147
try:
153148
for marking_category in client.admin.MarkingCategory.list(
154-
page_size=page_size, page_token=page_token, preview=preview
149+
page_size=page_size, page_token=page_token
155150
):
156151
pprint(marking_category)
157152
except foundry_sdk.PalantirRPCException as e:

‎docs/v2/Admin/Organization.md‎

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
Method | HTTP request | Release Stage |
44
------------- | ------------- | ----- |
5-
[**create**](#create) | **POST** /v2/admin/organizations | Private Beta |
6-
[**get**](#get) | **GET** /v2/admin/organizations/{organizationRid} | Public Beta |
7-
[**list_available_roles**](#list_available_roles) | **GET** /v2/admin/organizations/{organizationRid}/listAvailableRoles | Public Beta |
8-
[**replace**](#replace) | **PUT** /v2/admin/organizations/{organizationRid} | Public Beta |
5+
[**create**](#create) | **POST** /v2/admin/organizations | Public Beta |
6+
[**get**](#get) | **GET** /v2/admin/organizations/{organizationRid} | Stable |
7+
[**list_available_roles**](#list_available_roles) | **GET** /v2/admin/organizations/{organizationRid}/listAvailableRoles | Stable |
8+
[**replace**](#replace) | **PUT** /v2/admin/organizations/{organizationRid} | Stable |
99

1010
# **create**
1111
Creates a new Organization.
@@ -84,7 +84,6 @@ Get the Organization with the specified rid.
8484
Name | Type | Description | Notes |
8585
------------- | ------------- | ------------- | ------------- |
8686
**organization_rid** | OrganizationRid | | |
87-
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
8887

8988
### Return type
9089
**Organization**
@@ -100,12 +99,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa
10099

101100
# OrganizationRid
102101
organization_rid = None
103-
# Optional[PreviewMode] | Enables the use of preview functionality.
104-
preview = None
105102

106103

107104
try:
108-
api_response = client.admin.Organization.get(organization_rid, preview=preview)
105+
api_response = client.admin.Organization.get(organization_rid)
109106
print("The get response:\n")
110107
pprint(api_response)
111108
except foundry_sdk.PalantirRPCException as e:
@@ -135,7 +132,6 @@ List all roles that can be assigned to a principal for the given Organization.
135132
Name | Type | Description | Notes |
136133
------------- | ------------- | ------------- | ------------- |
137134
**organization_rid** | OrganizationRid | | |
138-
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
139135

140136
### Return type
141137
**ListAvailableOrganizationRolesResponse**
@@ -151,12 +147,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa
151147

152148
# OrganizationRid
153149
organization_rid = None
154-
# Optional[PreviewMode] | Enables the use of preview functionality.
155-
preview = None
156150

157151

158152
try:
159-
api_response = client.admin.Organization.list_available_roles(organization_rid, preview=preview)
153+
api_response = client.admin.Organization.list_available_roles(organization_rid)
160154
print("The list_available_roles response:\n")
161155
pprint(api_response)
162156
except foundry_sdk.PalantirRPCException as e:
@@ -188,7 +182,6 @@ Name | Type | Description | Notes |
188182
**name** | OrganizationName | | |
189183
**description** | Optional[str] | | [optional] |
190184
**host** | Optional[HostName] | The primary host name of the Organization. This should be used when constructing URLs for users of this Organization. | [optional] |
191-
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |
192185

193186
### Return type
194187
**Organization**
@@ -210,13 +203,11 @@ name = "Example Organization"
210203
description = None
211204
# Optional[HostName] | The primary host name of the Organization. This should be used when constructing URLs for users of this Organization.
212205
host = "example.palantirfoundry.com"
213-
# Optional[PreviewMode] | Enables the use of preview functionality.
214-
preview = None
215206

216207

217208
try:
218209
api_response = client.admin.Organization.replace(
219-
organization_rid, name=name, description=description, host=host, preview=preview
210+
organization_rid, name=name, description=description, host=host
220211
)
221212
print("The replace response:\n")
222213
pprint(api_response)

0 commit comments

Comments
 (0)