diff --git a/README.md b/README.md index 54e463d86..1be1aac6e 100644 --- a/README.md +++ b/README.md @@ -873,6 +873,7 @@ Namespace | Resource | Operation | HTTP request | **Ontologies** | ObjectType | [**get_edits_history**](docs/v2/Ontologies/ObjectType.md#get_edits_history) | **POST** /v2/ontologies/{ontology}/objectTypes/{objectType}/editsHistory | **Ontologies** | ObjectType | [**get_full_metadata**](docs/v2/Ontologies/ObjectType.md#get_full_metadata) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/fullMetadata | **Ontologies** | ObjectType | [**get_outgoing_link_type**](docs/v2/Ontologies/ObjectType.md#get_outgoing_link_type) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes/{linkType} | +**Ontologies** | ObjectType | [**get_outgoing_link_types_by_object_type_rid_batch**](docs/v2/Ontologies/ObjectType.md#get_outgoing_link_types_by_object_type_rid_batch) | **POST** /v2/ontologies/{ontology}/outgoingLinkTypes/getByRidBatch | **Ontologies** | ObjectType | [**list**](docs/v2/Ontologies/ObjectType.md#list) | **GET** /v2/ontologies/{ontology}/objectTypes | **Ontologies** | ObjectType | [**list_outgoing_link_types**](docs/v2/Ontologies/ObjectType.md#list_outgoing_link_types) | **GET** /v2/ontologies/{ontology}/objectTypes/{objectType}/outgoingLinkTypes | **Ontologies** | Ontology | [**get**](docs/v2/Ontologies/Ontology.md#get) | **GET** /v2/ontologies/{ontology} | @@ -2447,6 +2448,9 @@ Namespace | Name | Import | **Ontologies** | [GetObjectTypeByRidBatchRequest](docs/v2/Ontologies/models/GetObjectTypeByRidBatchRequest.md) | `from foundry_sdk.v2.ontologies.models import GetObjectTypeByRidBatchRequest` | **Ontologies** | [GetObjectTypeByRidBatchRequestElement](docs/v2/Ontologies/models/GetObjectTypeByRidBatchRequestElement.md) | `from foundry_sdk.v2.ontologies.models import GetObjectTypeByRidBatchRequestElement` | **Ontologies** | [GetObjectTypeByRidBatchResponse](docs/v2/Ontologies/models/GetObjectTypeByRidBatchResponse.md) | `from foundry_sdk.v2.ontologies.models import GetObjectTypeByRidBatchResponse` | +**Ontologies** | [GetOutgoingLinkTypesByObjectTypeRidBatchRequest](docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchRequest.md) | `from foundry_sdk.v2.ontologies.models import GetOutgoingLinkTypesByObjectTypeRidBatchRequest` | +**Ontologies** | [GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement](docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement.md) | `from foundry_sdk.v2.ontologies.models import GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement` | +**Ontologies** | [GetOutgoingLinkTypesByObjectTypeRidBatchResponse](docs/v2/Ontologies/models/GetOutgoingLinkTypesByObjectTypeRidBatchResponse.md) | `from foundry_sdk.v2.ontologies.models import GetOutgoingLinkTypesByObjectTypeRidBatchResponse` | **Ontologies** | [GetSelectedPropertyOperation](docs/v2/Ontologies/models/GetSelectedPropertyOperation.md) | `from foundry_sdk.v2.ontologies.models import GetSelectedPropertyOperation` | **Ontologies** | [GreatestPropertyExpression](docs/v2/Ontologies/models/GreatestPropertyExpression.md) | `from foundry_sdk.v2.ontologies.models import GreatestPropertyExpression` | **Ontologies** | [GroupMemberConstraint](docs/v2/Ontologies/models/GroupMemberConstraint.md) | `from foundry_sdk.v2.ontologies.models import GroupMemberConstraint` | @@ -2994,9 +2998,15 @@ Namespace | Name | Import | **ThirdPartyApplications** | [VersionVersion](docs/v2/ThirdPartyApplications/models/VersionVersion.md) | `from foundry_sdk.v2.third_party_applications.models import VersionVersion` | **ThirdPartyApplications** | [Website](docs/v2/ThirdPartyApplications/models/Website.md) | `from foundry_sdk.v2.third_party_applications.models import Website` | **Widgets** | [DevModeSettings](docs/v2/Widgets/models/DevModeSettings.md) | `from foundry_sdk.v2.widgets.models import DevModeSettings` | +**Widgets** | [DevModeSettingsV2](docs/v2/Widgets/models/DevModeSettingsV2.md) | `from foundry_sdk.v2.widgets.models import DevModeSettingsV2` | +**Widgets** | [DevModeSnapshot](docs/v2/Widgets/models/DevModeSnapshot.md) | `from foundry_sdk.v2.widgets.models import DevModeSnapshot` | +**Widgets** | [DevModeSnapshotId](docs/v2/Widgets/models/DevModeSnapshotId.md) | `from foundry_sdk.v2.widgets.models import DevModeSnapshotId` | **Widgets** | [DevModeStatus](docs/v2/Widgets/models/DevModeStatus.md) | `from foundry_sdk.v2.widgets.models import DevModeStatus` | **Widgets** | [FilePath](docs/v2/Widgets/models/FilePath.md) | `from foundry_sdk.v2.widgets.models import FilePath` | **Widgets** | [ListReleasesResponse](docs/v2/Widgets/models/ListReleasesResponse.md) | `from foundry_sdk.v2.widgets.models import ListReleasesResponse` | +**Widgets** | [OntologySdkInputSpec](docs/v2/Widgets/models/OntologySdkInputSpec.md) | `from foundry_sdk.v2.widgets.models import OntologySdkInputSpec` | +**Widgets** | [OntologySdkPackageRid](docs/v2/Widgets/models/OntologySdkPackageRid.md) | `from foundry_sdk.v2.widgets.models import OntologySdkPackageRid` | +**Widgets** | [OntologySdkVersion](docs/v2/Widgets/models/OntologySdkVersion.md) | `from foundry_sdk.v2.widgets.models import OntologySdkVersion` | **Widgets** | [Release](docs/v2/Widgets/models/Release.md) | `from foundry_sdk.v2.widgets.models import Release` | **Widgets** | [ReleaseLocator](docs/v2/Widgets/models/ReleaseLocator.md) | `from foundry_sdk.v2.widgets.models import ReleaseLocator` | **Widgets** | [ReleaseVersion](docs/v2/Widgets/models/ReleaseVersion.md) | `from foundry_sdk.v2.widgets.models import ReleaseVersion` | @@ -3006,14 +3016,17 @@ Namespace | Name | Import | **Widgets** | [ScriptEntrypoint](docs/v2/Widgets/models/ScriptEntrypoint.md) | `from foundry_sdk.v2.widgets.models import ScriptEntrypoint` | **Widgets** | [ScriptType](docs/v2/Widgets/models/ScriptType.md) | `from foundry_sdk.v2.widgets.models import ScriptType` | **Widgets** | [SetWidgetSetDevModeSettingsByIdRequest](docs/v2/Widgets/models/SetWidgetSetDevModeSettingsByIdRequest.md) | `from foundry_sdk.v2.widgets.models import SetWidgetSetDevModeSettingsByIdRequest` | -**Widgets** | [SetWidgetSetDevModeSettingsRequest](docs/v2/Widgets/models/SetWidgetSetDevModeSettingsRequest.md) | `from foundry_sdk.v2.widgets.models import SetWidgetSetDevModeSettingsRequest` | +**Widgets** | [SetWidgetSetManifestDevModeSettingsV2Request](docs/v2/Widgets/models/SetWidgetSetManifestDevModeSettingsV2Request.md) | `from foundry_sdk.v2.widgets.models import SetWidgetSetManifestDevModeSettingsV2Request` | **Widgets** | [StylesheetEntrypoint](docs/v2/Widgets/models/StylesheetEntrypoint.md) | `from foundry_sdk.v2.widgets.models import StylesheetEntrypoint` | **Widgets** | [WidgetDevModeSettings](docs/v2/Widgets/models/WidgetDevModeSettings.md) | `from foundry_sdk.v2.widgets.models import WidgetDevModeSettings` | +**Widgets** | [WidgetDevModeSettingsV2](docs/v2/Widgets/models/WidgetDevModeSettingsV2.md) | `from foundry_sdk.v2.widgets.models import WidgetDevModeSettingsV2` | **Widgets** | [WidgetId](docs/v2/Widgets/models/WidgetId.md) | `from foundry_sdk.v2.widgets.models import WidgetId` | **Widgets** | [WidgetRid](docs/v2/Widgets/models/WidgetRid.md) | `from foundry_sdk.v2.widgets.models import WidgetRid` | **Widgets** | [WidgetSet](docs/v2/Widgets/models/WidgetSet.md) | `from foundry_sdk.v2.widgets.models import WidgetSet` | **Widgets** | [WidgetSetDevModeSettings](docs/v2/Widgets/models/WidgetSetDevModeSettings.md) | `from foundry_sdk.v2.widgets.models import WidgetSetDevModeSettings` | **Widgets** | [WidgetSetDevModeSettingsById](docs/v2/Widgets/models/WidgetSetDevModeSettingsById.md) | `from foundry_sdk.v2.widgets.models import WidgetSetDevModeSettingsById` | +**Widgets** | [WidgetSetDevModeSettingsV2](docs/v2/Widgets/models/WidgetSetDevModeSettingsV2.md) | `from foundry_sdk.v2.widgets.models import WidgetSetDevModeSettingsV2` | +**Widgets** | [WidgetSetInputSpec](docs/v2/Widgets/models/WidgetSetInputSpec.md) | `from foundry_sdk.v2.widgets.models import WidgetSetInputSpec` | **Widgets** | [WidgetSetRid](docs/v2/Widgets/models/WidgetSetRid.md) | `from foundry_sdk.v2.widgets.models import WidgetSetRid` | @@ -3687,6 +3700,7 @@ Namespace | Name | Import | **Models** | ModelStudioNotFound | `from foundry_sdk.v2.models.errors import ModelStudioNotFound` | **Models** | ModelStudioTrainerNotFound | `from foundry_sdk.v2.models.errors import ModelStudioTrainerNotFound` | **Models** | ModelVersionNotFound | `from foundry_sdk.v2.models.errors import ModelVersionNotFound` | +**Models** | OntologyBindingRequired | `from foundry_sdk.v2.models.errors import OntologyBindingRequired` | **Models** | OntologyNotFound | `from foundry_sdk.v2.models.errors import OntologyNotFound` | **Models** | ParquetExperimentArtifactTablePermissionDenied | `from foundry_sdk.v2.models.errors import ParquetExperimentArtifactTablePermissionDenied` | **Models** | ParquetExperimentSeriesPermissionDenied | `from foundry_sdk.v2.models.errors import ParquetExperimentSeriesPermissionDenied` | @@ -3933,12 +3947,10 @@ Namespace | Name | Import | **ThirdPartyApplications** | VersionNotFound | `from foundry_sdk.v2.third_party_applications.errors import VersionNotFound` | **ThirdPartyApplications** | WebsiteNotFound | `from foundry_sdk.v2.third_party_applications.errors import WebsiteNotFound` | **Widgets** | DeleteReleasePermissionDenied | `from foundry_sdk.v2.widgets.errors import DeleteReleasePermissionDenied` | -**Widgets** | DevModeSettingsNotFound | `from foundry_sdk.v2.widgets.errors import DevModeSettingsNotFound` | -**Widgets** | DisableDevModeSettingsPermissionDenied | `from foundry_sdk.v2.widgets.errors import DisableDevModeSettingsPermissionDenied` | **Widgets** | EnableDevModeSettingsPermissionDenied | `from foundry_sdk.v2.widgets.errors import EnableDevModeSettingsPermissionDenied` | +**Widgets** | EnableDevModeSettingsV2PermissionDenied | `from foundry_sdk.v2.widgets.errors import EnableDevModeSettingsV2PermissionDenied` | **Widgets** | FileCountLimitExceeded | `from foundry_sdk.v2.widgets.errors import FileCountLimitExceeded` | **Widgets** | FileSizeLimitExceeded | `from foundry_sdk.v2.widgets.errors import FileSizeLimitExceeded` | -**Widgets** | GetDevModeSettingsPermissionDenied | `from foundry_sdk.v2.widgets.errors import GetDevModeSettingsPermissionDenied` | **Widgets** | InvalidDevModeBaseHref | `from foundry_sdk.v2.widgets.errors import InvalidDevModeBaseHref` | **Widgets** | InvalidDevModeEntrypointCssCount | `from foundry_sdk.v2.widgets.errors import InvalidDevModeEntrypointCssCount` | **Widgets** | InvalidDevModeEntrypointJsCount | `from foundry_sdk.v2.widgets.errors import InvalidDevModeEntrypointJsCount` | @@ -3968,12 +3980,11 @@ Namespace | Name | Import | **Widgets** | InvalidWidgetId | `from foundry_sdk.v2.widgets.errors import InvalidWidgetId` | **Widgets** | InvalidWidgetName | `from foundry_sdk.v2.widgets.errors import InvalidWidgetName` | **Widgets** | OntologySdkNotFound | `from foundry_sdk.v2.widgets.errors import OntologySdkNotFound` | -**Widgets** | PauseDevModeSettingsPermissionDenied | `from foundry_sdk.v2.widgets.errors import PauseDevModeSettingsPermissionDenied` | **Widgets** | PublishReleasePermissionDenied | `from foundry_sdk.v2.widgets.errors import PublishReleasePermissionDenied` | **Widgets** | ReleaseNotFound | `from foundry_sdk.v2.widgets.errors import ReleaseNotFound` | **Widgets** | RepositoryNotFound | `from foundry_sdk.v2.widgets.errors import RepositoryNotFound` | **Widgets** | SetWidgetSetDevModeSettingsByIdPermissionDenied | `from foundry_sdk.v2.widgets.errors import SetWidgetSetDevModeSettingsByIdPermissionDenied` | -**Widgets** | SetWidgetSetDevModeSettingsPermissionDenied | `from foundry_sdk.v2.widgets.errors import SetWidgetSetDevModeSettingsPermissionDenied` | +**Widgets** | SetWidgetSetManifestDevModeSettingsV2PermissionDenied | `from foundry_sdk.v2.widgets.errors import SetWidgetSetManifestDevModeSettingsV2PermissionDenied` | **Widgets** | VersionAlreadyExists | `from foundry_sdk.v2.widgets.errors import VersionAlreadyExists` | **Widgets** | VersionLimitExceeded | `from foundry_sdk.v2.widgets.errors import VersionLimitExceeded` | **Widgets** | WidgetIdNotFound | `from foundry_sdk.v2.widgets.errors import WidgetIdNotFound` | diff --git a/docs-snippets-npm/package.json b/docs-snippets-npm/package.json index 84e1e9d11..1c81f7ac0 100644 --- a/docs-snippets-npm/package.json +++ b/docs-snippets-npm/package.json @@ -24,7 +24,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1552.0", + "minVersion": "1.1560.0", "maxVersion": "1.x.x", "optional": false } diff --git a/docs-snippets-npm/src/index.ts b/docs-snippets-npm/src/index.ts index b9fed0d5c..f8ccf0d93 100644 --- a/docs-snippets-npm/src/index.ts +++ b/docs-snippets-npm/src/index.ts @@ -1563,6 +1563,11 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse: + """ + Gets outgoing link types for a batch of object types, identified by their RIDs. + + For each requested object type, returns the list of outgoing link types visible to the + requesting token. Optionally, results can be filtered to only include specific link type RIDs. + + Object types that don't exist or that the requesting token lacks permissions for are + silently omitted from the response. + + The maximum batch size for this endpoint is 100. + + :param ontology: + :type ontology: OntologyIdentifier + :param filter_link_type_rids: If provided, only return outgoing link types with RIDs in this list. If omitted, all outgoing link types for each requested object type are returned. + :type filter_link_type_rids: List[LinkTypeRid] + :param requests: + :type requests: List[GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement] + :param branch: The Foundry branch to load the outgoing link type definitions from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. + :type branch: Optional[FoundryBranch] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/outgoingLinkTypes/getByRidBatch", + query_params={ + "branch": branch, + }, + path_params={ + "ontology": ontology, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body=ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchRequest( + requests=requests, + filter_link_type_rids=filter_link_type_rids, + ), + response_type=ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse, + request_timeout=request_timeout, + throwable_errors={}, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -479,6 +545,9 @@ def get_by_rid_batch(_: ontologies_models.GetObjectTypeByRidBatchResponse): ... def get_edits_history(_: ontologies_models.ObjectTypeEditsHistoryResponse): ... def get_full_metadata(_: ontologies_models.ObjectTypeFullMetadata): ... def get_outgoing_link_type(_: ontologies_models.LinkTypeSideV2): ... + def get_outgoing_link_types_by_object_type_rid_batch( + _: ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse, + ): ... def list(_: ontologies_models.ListObjectTypesV2Response): ... def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV2): ... @@ -489,6 +558,10 @@ def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV self.get_outgoing_link_type = core.with_raw_response( get_outgoing_link_type, client.get_outgoing_link_type ) + self.get_outgoing_link_types_by_object_type_rid_batch = core.with_raw_response( + get_outgoing_link_types_by_object_type_rid_batch, + client.get_outgoing_link_types_by_object_type_rid_batch, + ) self.list = core.with_raw_response(list, client.list) self.list_outgoing_link_types = core.with_raw_response( list_outgoing_link_types, client.list_outgoing_link_types @@ -502,6 +575,9 @@ def get_by_rid_batch(_: ontologies_models.GetObjectTypeByRidBatchResponse): ... def get_edits_history(_: ontologies_models.ObjectTypeEditsHistoryResponse): ... def get_full_metadata(_: ontologies_models.ObjectTypeFullMetadata): ... def get_outgoing_link_type(_: ontologies_models.LinkTypeSideV2): ... + def get_outgoing_link_types_by_object_type_rid_batch( + _: ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse, + ): ... def list(_: ontologies_models.ListObjectTypesV2Response): ... def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV2): ... @@ -518,6 +594,10 @@ def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV self.get_outgoing_link_type = core.with_streaming_response( get_outgoing_link_type, client.get_outgoing_link_type ) + self.get_outgoing_link_types_by_object_type_rid_batch = core.with_streaming_response( + get_outgoing_link_types_by_object_type_rid_batch, + client.get_outgoing_link_types_by_object_type_rid_batch, + ) self.list = core.with_streaming_response(list, client.list) self.list_outgoing_link_types = core.with_streaming_response( list_outgoing_link_types, client.list_outgoing_link_types @@ -856,6 +936,72 @@ def get_outgoing_link_type( ), ) + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def get_outgoing_link_types_by_object_type_rid_batch( + self, + ontology: ontologies_models.OntologyIdentifier, + *, + filter_link_type_rids: typing.List[ontologies_models.LinkTypeRid], + requests: typing_extensions.Annotated[ + typing.List[ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement], + annotated_types.Len(min_length=1, max_length=100), + ], + branch: typing.Optional[core_models.FoundryBranch] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> typing.Awaitable[ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse]: + """ + Gets outgoing link types for a batch of object types, identified by their RIDs. + + For each requested object type, returns the list of outgoing link types visible to the + requesting token. Optionally, results can be filtered to only include specific link type RIDs. + + Object types that don't exist or that the requesting token lacks permissions for are + silently omitted from the response. + + The maximum batch size for this endpoint is 100. + + :param ontology: + :type ontology: OntologyIdentifier + :param filter_link_type_rids: If provided, only return outgoing link types with RIDs in this list. If omitted, all outgoing link types for each requested object type are returned. + :type filter_link_type_rids: List[LinkTypeRid] + :param requests: + :type requests: List[GetOutgoingLinkTypesByObjectTypeRidBatchRequestElement] + :param branch: The Foundry branch to load the outgoing link type definitions from. If not specified, the default branch will be used. Branches are an experimental feature and not all workflows are supported. + :type branch: Optional[FoundryBranch] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: typing.Awaitable[ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse] + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/ontologies/{ontology}/outgoingLinkTypes/getByRidBatch", + query_params={ + "branch": branch, + }, + path_params={ + "ontology": ontology, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body=ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchRequest( + requests=requests, + filter_link_type_rids=filter_link_type_rids, + ), + response_type=ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse, + request_timeout=request_timeout, + throwable_errors={}, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -978,6 +1124,9 @@ def get_by_rid_batch(_: ontologies_models.GetObjectTypeByRidBatchResponse): ... def get_edits_history(_: ontologies_models.ObjectTypeEditsHistoryResponse): ... def get_full_metadata(_: ontologies_models.ObjectTypeFullMetadata): ... def get_outgoing_link_type(_: ontologies_models.LinkTypeSideV2): ... + def get_outgoing_link_types_by_object_type_rid_batch( + _: ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse, + ): ... def list(_: ontologies_models.ListObjectTypesV2Response): ... def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV2): ... @@ -994,6 +1143,10 @@ def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV self.get_outgoing_link_type = core.async_with_raw_response( get_outgoing_link_type, client.get_outgoing_link_type ) + self.get_outgoing_link_types_by_object_type_rid_batch = core.async_with_raw_response( + get_outgoing_link_types_by_object_type_rid_batch, + client.get_outgoing_link_types_by_object_type_rid_batch, + ) self.list = core.async_with_raw_response(list, client.list) self.list_outgoing_link_types = core.async_with_raw_response( list_outgoing_link_types, client.list_outgoing_link_types @@ -1007,6 +1160,9 @@ def get_by_rid_batch(_: ontologies_models.GetObjectTypeByRidBatchResponse): ... def get_edits_history(_: ontologies_models.ObjectTypeEditsHistoryResponse): ... def get_full_metadata(_: ontologies_models.ObjectTypeFullMetadata): ... def get_outgoing_link_type(_: ontologies_models.LinkTypeSideV2): ... + def get_outgoing_link_types_by_object_type_rid_batch( + _: ontologies_models.GetOutgoingLinkTypesByObjectTypeRidBatchResponse, + ): ... def list(_: ontologies_models.ListObjectTypesV2Response): ... def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV2): ... @@ -1023,6 +1179,10 @@ def list_outgoing_link_types(_: ontologies_models.ListOutgoingLinkTypesResponseV self.get_outgoing_link_type = core.async_with_streaming_response( get_outgoing_link_type, client.get_outgoing_link_type ) + self.get_outgoing_link_types_by_object_type_rid_batch = core.async_with_streaming_response( + get_outgoing_link_types_by_object_type_rid_batch, + client.get_outgoing_link_types_by_object_type_rid_batch, + ) self.list = core.async_with_streaming_response(list, client.list) self.list_outgoing_link_types = core.async_with_streaming_response( list_outgoing_link_types, client.list_outgoing_link_types diff --git a/foundry_sdk/v2/widgets/_client.py b/foundry_sdk/v2/widgets/_client.py index 77c280bd3..1c9155c3c 100644 --- a/foundry_sdk/v2/widgets/_client.py +++ b/foundry_sdk/v2/widgets/_client.py @@ -53,6 +53,16 @@ def DevModeSettings(self): config=self._config, ) + @cached_property + def DevModeSettingsV2(self): + from foundry_sdk.v2.widgets.dev_mode_settings_v2 import DevModeSettingsV2Client + + return DevModeSettingsV2Client( + auth=self._auth, + hostname=self._hostname_supplier, + config=self._config, + ) + @cached_property def Repository(self): from foundry_sdk.v2.widgets.repository import RepositoryClient @@ -90,6 +100,7 @@ def __init__( config: typing.Optional[core.Config] = None, ): from foundry_sdk.v2.widgets.dev_mode_settings import AsyncDevModeSettingsClient + from foundry_sdk.v2.widgets.dev_mode_settings_v2 import AsyncDevModeSettingsV2Client # NOQA from foundry_sdk.v2.widgets.repository import AsyncRepositoryClient from foundry_sdk.v2.widgets.widget_set import AsyncWidgetSetClient @@ -97,6 +108,10 @@ def __init__( auth=auth, hostname=hostname, config=config ) + self.DevModeSettingsV2 = AsyncDevModeSettingsV2Client( + auth=auth, hostname=hostname, config=config + ) + self.Repository = AsyncRepositoryClient(auth=auth, hostname=hostname, config=config) self.WidgetSet = AsyncWidgetSetClient(auth=auth, hostname=hostname, config=config) diff --git a/foundry_sdk/v2/widgets/dev_mode_settings.py b/foundry_sdk/v2/widgets/dev_mode_settings.py index 4c09d696c..ca082df6f 100644 --- a/foundry_sdk/v2/widgets/dev_mode_settings.py +++ b/foundry_sdk/v2/widgets/dev_mode_settings.py @@ -54,49 +54,6 @@ def __init__( self.with_streaming_response = _DevModeSettingsClientStreaming(self) self.with_raw_response = _DevModeSettingsClientRaw(self) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def disable( - self, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> widgets_models.DevModeSettings: - """ - Disable dev mode for the user associated with the provided token. - :param preview: Enables the use of preview functionality. - :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: widgets_models.DevModeSettings - - :raises DisableDevModeSettingsPermissionDenied: Could not disable the DevModeSettings. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/widgets/devModeSettings/disable", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=widgets_models.DevModeSettings, - request_timeout=request_timeout, - throwable_errors={ - "DisableDevModeSettingsPermissionDenied": widgets_errors.DisableDevModeSettingsPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -140,145 +97,6 @@ def enable( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> widgets_models.DevModeSettings: - """ - Get the dev mode settings for the user associated with the provided token. - :param preview: Enables the use of preview functionality. - :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: widgets_models.DevModeSettings - - :raises DevModeSettingsNotFound: The given DevModeSettings could not be found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/widgets/devModeSettings", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=widgets_models.DevModeSettings, - request_timeout=request_timeout, - throwable_errors={ - "DevModeSettingsNotFound": widgets_errors.DevModeSettingsNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def pause( - self, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> widgets_models.DevModeSettings: - """ - Pause dev mode for the user associated with the provided token. - :param preview: Enables the use of preview functionality. - :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: widgets_models.DevModeSettings - - :raises PauseDevModeSettingsPermissionDenied: Could not pause the DevModeSettings. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/widgets/devModeSettings/pause", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=widgets_models.DevModeSettings, - request_timeout=request_timeout, - throwable_errors={ - "PauseDevModeSettingsPermissionDenied": widgets_errors.PauseDevModeSettingsPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def set_widget_set( - self, - *, - settings: widgets_models.WidgetSetDevModeSettings, - widget_set_rid: widgets_models.WidgetSetRid, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> widgets_models.DevModeSettings: - """ - Set the dev mode settings for the given widget set for the user associated with the provided token. - :param settings: - :type settings: WidgetSetDevModeSettings - :param widget_set_rid: - :type widget_set_rid: WidgetSetRid - :param preview: Enables the use of preview functionality. - :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: widgets_models.DevModeSettings - - :raises SetWidgetSetDevModeSettingsPermissionDenied: Could not setWidgetSet the DevModeSettings. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/widgets/devModeSettings/setWidgetSet", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=widgets_models.SetWidgetSetDevModeSettingsRequest( - widget_set_rid=widget_set_rid, - settings=settings, - ), - response_type=widgets_models.DevModeSettings, - request_timeout=request_timeout, - throwable_errors={ - "SetWidgetSetDevModeSettingsPermissionDenied": widgets_errors.SetWidgetSetDevModeSettingsPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -337,18 +155,10 @@ def set_widget_set_by_id( class _DevModeSettingsClientRaw: def __init__(self, client: DevModeSettingsClient) -> None: - def disable(_: widgets_models.DevModeSettings): ... def enable(_: widgets_models.DevModeSettings): ... - def get(_: widgets_models.DevModeSettings): ... - def pause(_: widgets_models.DevModeSettings): ... - def set_widget_set(_: widgets_models.DevModeSettings): ... def set_widget_set_by_id(_: widgets_models.DevModeSettings): ... - self.disable = core.with_raw_response(disable, client.disable) self.enable = core.with_raw_response(enable, client.enable) - self.get = core.with_raw_response(get, client.get) - self.pause = core.with_raw_response(pause, client.pause) - self.set_widget_set = core.with_raw_response(set_widget_set, client.set_widget_set) self.set_widget_set_by_id = core.with_raw_response( set_widget_set_by_id, client.set_widget_set_by_id ) @@ -356,18 +166,10 @@ def set_widget_set_by_id(_: widgets_models.DevModeSettings): ... class _DevModeSettingsClientStreaming: def __init__(self, client: DevModeSettingsClient) -> None: - def disable(_: widgets_models.DevModeSettings): ... def enable(_: widgets_models.DevModeSettings): ... - def get(_: widgets_models.DevModeSettings): ... - def pause(_: widgets_models.DevModeSettings): ... - def set_widget_set(_: widgets_models.DevModeSettings): ... def set_widget_set_by_id(_: widgets_models.DevModeSettings): ... - self.disable = core.with_streaming_response(disable, client.disable) self.enable = core.with_streaming_response(enable, client.enable) - self.get = core.with_streaming_response(get, client.get) - self.pause = core.with_streaming_response(pause, client.pause) - self.set_widget_set = core.with_streaming_response(set_widget_set, client.set_widget_set) self.set_widget_set_by_id = core.with_streaming_response( set_widget_set_by_id, client.set_widget_set_by_id ) @@ -402,49 +204,6 @@ def __init__( self.with_streaming_response = _AsyncDevModeSettingsClientStreaming(self) self.with_raw_response = _AsyncDevModeSettingsClientRaw(self) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def disable( - self, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[widgets_models.DevModeSettings]: - """ - Disable dev mode for the user associated with the provided token. - :param preview: Enables the use of preview functionality. - :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: typing.Awaitable[widgets_models.DevModeSettings] - - :raises DisableDevModeSettingsPermissionDenied: Could not disable the DevModeSettings. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/widgets/devModeSettings/disable", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=widgets_models.DevModeSettings, - request_timeout=request_timeout, - throwable_errors={ - "DisableDevModeSettingsPermissionDenied": widgets_errors.DisableDevModeSettingsPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -488,145 +247,6 @@ def enable( ), ) - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def get( - self, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[widgets_models.DevModeSettings]: - """ - Get the dev mode settings for the user associated with the provided token. - :param preview: Enables the use of preview functionality. - :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: typing.Awaitable[widgets_models.DevModeSettings] - - :raises DevModeSettingsNotFound: The given DevModeSettings could not be found. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="GET", - resource_path="/v2/widgets/devModeSettings", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=widgets_models.DevModeSettings, - request_timeout=request_timeout, - throwable_errors={ - "DevModeSettingsNotFound": widgets_errors.DevModeSettingsNotFound, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def pause( - self, - *, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[widgets_models.DevModeSettings]: - """ - Pause dev mode for the user associated with the provided token. - :param preview: Enables the use of preview functionality. - :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: typing.Awaitable[widgets_models.DevModeSettings] - - :raises PauseDevModeSettingsPermissionDenied: Could not pause the DevModeSettings. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/widgets/devModeSettings/pause", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Accept": "application/json", - }, - body=None, - response_type=widgets_models.DevModeSettings, - request_timeout=request_timeout, - throwable_errors={ - "PauseDevModeSettingsPermissionDenied": widgets_errors.PauseDevModeSettingsPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - - @core.maybe_ignore_preview - @pydantic.validate_call - @errors.handle_unexpected - def set_widget_set( - self, - *, - settings: widgets_models.WidgetSetDevModeSettings, - widget_set_rid: widgets_models.WidgetSetRid, - preview: typing.Optional[core_models.PreviewMode] = None, - request_timeout: typing.Optional[core.Timeout] = None, - _sdk_internal: core.SdkInternal = {}, - ) -> typing.Awaitable[widgets_models.DevModeSettings]: - """ - Set the dev mode settings for the given widget set for the user associated with the provided token. - :param settings: - :type settings: WidgetSetDevModeSettings - :param widget_set_rid: - :type widget_set_rid: WidgetSetRid - :param preview: Enables the use of preview functionality. - :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: typing.Awaitable[widgets_models.DevModeSettings] - - :raises SetWidgetSetDevModeSettingsPermissionDenied: Could not setWidgetSet the DevModeSettings. - """ - - return self._api_client.call_api( - core.RequestInfo( - method="POST", - resource_path="/v2/widgets/devModeSettings/setWidgetSet", - query_params={ - "preview": preview, - }, - path_params={}, - header_params={ - "Content-Type": "application/json", - "Accept": "application/json", - }, - body=widgets_models.SetWidgetSetDevModeSettingsRequest( - widget_set_rid=widget_set_rid, - settings=settings, - ), - response_type=widgets_models.DevModeSettings, - request_timeout=request_timeout, - throwable_errors={ - "SetWidgetSetDevModeSettingsPermissionDenied": widgets_errors.SetWidgetSetDevModeSettingsPermissionDenied, - }, - response_mode=_sdk_internal.get("response_mode"), - ), - ) - @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -685,18 +305,10 @@ def set_widget_set_by_id( class _AsyncDevModeSettingsClientRaw: def __init__(self, client: AsyncDevModeSettingsClient) -> None: - def disable(_: widgets_models.DevModeSettings): ... def enable(_: widgets_models.DevModeSettings): ... - def get(_: widgets_models.DevModeSettings): ... - def pause(_: widgets_models.DevModeSettings): ... - def set_widget_set(_: widgets_models.DevModeSettings): ... def set_widget_set_by_id(_: widgets_models.DevModeSettings): ... - self.disable = core.async_with_raw_response(disable, client.disable) self.enable = core.async_with_raw_response(enable, client.enable) - self.get = core.async_with_raw_response(get, client.get) - self.pause = core.async_with_raw_response(pause, client.pause) - self.set_widget_set = core.async_with_raw_response(set_widget_set, client.set_widget_set) self.set_widget_set_by_id = core.async_with_raw_response( set_widget_set_by_id, client.set_widget_set_by_id ) @@ -704,20 +316,10 @@ def set_widget_set_by_id(_: widgets_models.DevModeSettings): ... class _AsyncDevModeSettingsClientStreaming: def __init__(self, client: AsyncDevModeSettingsClient) -> None: - def disable(_: widgets_models.DevModeSettings): ... def enable(_: widgets_models.DevModeSettings): ... - def get(_: widgets_models.DevModeSettings): ... - def pause(_: widgets_models.DevModeSettings): ... - def set_widget_set(_: widgets_models.DevModeSettings): ... def set_widget_set_by_id(_: widgets_models.DevModeSettings): ... - self.disable = core.async_with_streaming_response(disable, client.disable) self.enable = core.async_with_streaming_response(enable, client.enable) - self.get = core.async_with_streaming_response(get, client.get) - self.pause = core.async_with_streaming_response(pause, client.pause) - self.set_widget_set = core.async_with_streaming_response( - set_widget_set, client.set_widget_set - ) self.set_widget_set_by_id = core.async_with_streaming_response( set_widget_set_by_id, client.set_widget_set_by_id ) diff --git a/foundry_sdk/v2/widgets/dev_mode_settings_v2.py b/foundry_sdk/v2/widgets/dev_mode_settings_v2.py new file mode 100644 index 000000000..73a956c2e --- /dev/null +++ b/foundry_sdk/v2/widgets/dev_mode_settings_v2.py @@ -0,0 +1,379 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT 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 typing + +import pydantic +import typing_extensions + +from foundry_sdk import _core as core +from foundry_sdk import _errors as errors +from foundry_sdk.v2.core import models as core_models +from foundry_sdk.v2.widgets import errors as widgets_errors +from foundry_sdk.v2.widgets import models as widgets_models + + +class DevModeSettingsV2Client: + """ + The API client for the DevModeSettingsV2 Resource. + + :param auth: Your auth configuration. + :param hostname: The hostname supplier for resolving base URLs. + :param config: Optionally specify the configuration for the HTTP session. + """ + + def __init__( + self, + auth: core.Auth, + hostname: typing.Union[str, core.HostnameSupplier], + config: typing.Optional[core.Config] = None, + ): + self._auth = auth + if isinstance(hostname, core.HostnameSupplier): + self._hostname_supplier = hostname + else: + self._hostname_supplier = core.create_hostname_supplier(hostname, config) + self._hostname = self._hostname_supplier.get_hostname() + self._config = config + self._api_client = core.ApiClient( + auth=auth, hostname=self._hostname_supplier, config=config + ) + + self.with_streaming_response = _DevModeSettingsV2ClientStreaming(self) + self.with_raw_response = _DevModeSettingsV2ClientRaw(self) + + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def enable( + self, + *, + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> widgets_models.DevModeSettingsV2: + """ + Enable dev mode for the user associated with the provided token. + :param preview: Enables the use of preview functionality. + :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: widgets_models.DevModeSettingsV2 + + :raises EnableDevModeSettingsV2PermissionDenied: Could not enable the DevModeSettingsV2. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/widgets/devModeSettingsV2/enable", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + response_type=widgets_models.DevModeSettingsV2, + request_timeout=request_timeout, + throwable_errors={ + "EnableDevModeSettingsV2PermissionDenied": widgets_errors.EnableDevModeSettingsV2PermissionDenied, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def set_widget_set_manifest( + self, + *, + manifest: typing.Any, + widget_set_rid: widgets_models.WidgetSetRid, + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> widgets_models.DevModeSettingsV2: + """ + Set the dev mode settings for the given widget set using the manifest format. + The request body is a dev settings manifest JSON object with the following + structure: + + { + "manifestVersion": "1.0.0", + "devSettings": { + "baseHref": "...", + "widgets": { ... }, + "inputSpec": { ... } + } + } + + See https://github.com/palantir/osdk-ts for the widget library API types for the + dev settings manifest. + + :param manifest: + :type manifest: Any + :param widget_set_rid: + :type widget_set_rid: WidgetSetRid + :param preview: Enables the use of preview functionality. + :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: widgets_models.DevModeSettingsV2 + + :raises InvalidDevModeBaseHref: The base href in the dev mode settings is invalid. It must be a valid localhost URL with an optional port. + :raises InvalidDevModeEntrypointCssCount: The dev mode settings contains too many CSS entrypoints. You must limit the number of CSS entrypoints to the maximum allowed. + :raises InvalidDevModeEntrypointJsCount: The dev mode settings contains too many JavaScript entrypoints. You must limit the number of JavaScript entrypoints to the maximum allowed. + :raises InvalidDevModeFilePath: The dev mode settings contains an invalid entrypoint file path. The file path must be a valid localhost URL with an optional port and a file path. + :raises InvalidDevModeWidgetSettingsCount: The dev mode settings contains too many widget settings. You must limit the number of widget settings to the maximum allowed. + :raises InvalidManifest: The provided manifest could not be parsed or is not well formed. + :raises SetWidgetSetManifestDevModeSettingsV2PermissionDenied: Could not setWidgetSetManifest the DevModeSettingsV2. + :raises WidgetIdNotFound: A non-existent widget id was provided. If creating a new widget, you must first publish your changes before previewing with developer mode. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/widgets/devModeSettingsV2/setWidgetSetManifest", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body=widgets_models.SetWidgetSetManifestDevModeSettingsV2Request( + widget_set_rid=widget_set_rid, + manifest=manifest, + ), + response_type=widgets_models.DevModeSettingsV2, + request_timeout=request_timeout, + throwable_errors={ + "InvalidDevModeBaseHref": widgets_errors.InvalidDevModeBaseHref, + "InvalidDevModeEntrypointCssCount": widgets_errors.InvalidDevModeEntrypointCssCount, + "InvalidDevModeEntrypointJsCount": widgets_errors.InvalidDevModeEntrypointJsCount, + "InvalidDevModeFilePath": widgets_errors.InvalidDevModeFilePath, + "InvalidDevModeWidgetSettingsCount": widgets_errors.InvalidDevModeWidgetSettingsCount, + "InvalidManifest": widgets_errors.InvalidManifest, + "SetWidgetSetManifestDevModeSettingsV2PermissionDenied": widgets_errors.SetWidgetSetManifestDevModeSettingsV2PermissionDenied, + "WidgetIdNotFound": widgets_errors.WidgetIdNotFound, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + + +class _DevModeSettingsV2ClientRaw: + def __init__(self, client: DevModeSettingsV2Client) -> None: + def enable(_: widgets_models.DevModeSettingsV2): ... + def set_widget_set_manifest(_: widgets_models.DevModeSettingsV2): ... + + self.enable = core.with_raw_response(enable, client.enable) + self.set_widget_set_manifest = core.with_raw_response( + set_widget_set_manifest, client.set_widget_set_manifest + ) + + +class _DevModeSettingsV2ClientStreaming: + def __init__(self, client: DevModeSettingsV2Client) -> None: + def enable(_: widgets_models.DevModeSettingsV2): ... + def set_widget_set_manifest(_: widgets_models.DevModeSettingsV2): ... + + self.enable = core.with_streaming_response(enable, client.enable) + self.set_widget_set_manifest = core.with_streaming_response( + set_widget_set_manifest, client.set_widget_set_manifest + ) + + +class AsyncDevModeSettingsV2Client: + """ + The API client for the DevModeSettingsV2 Resource. + + :param auth: Your auth configuration. + :param hostname: The hostname supplier for resolving base URLs. + :param config: Optionally specify the configuration for the HTTP session. + """ + + def __init__( + self, + auth: core.Auth, + hostname: typing.Union[str, core.HostnameSupplier], + config: typing.Optional[core.Config] = None, + ): + self._auth = auth + if isinstance(hostname, core.HostnameSupplier): + self._hostname_supplier = hostname + else: + self._hostname_supplier = core.create_hostname_supplier(hostname, config) + self._hostname = self._hostname_supplier.get_hostname() + self._config = config + self._api_client = core.AsyncApiClient( + auth=auth, hostname=self._hostname_supplier, config=config + ) + + self.with_streaming_response = _AsyncDevModeSettingsV2ClientStreaming(self) + self.with_raw_response = _AsyncDevModeSettingsV2ClientRaw(self) + + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def enable( + self, + *, + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> typing.Awaitable[widgets_models.DevModeSettingsV2]: + """ + Enable dev mode for the user associated with the provided token. + :param preview: Enables the use of preview functionality. + :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: typing.Awaitable[widgets_models.DevModeSettingsV2] + + :raises EnableDevModeSettingsV2PermissionDenied: Could not enable the DevModeSettingsV2. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/widgets/devModeSettingsV2/enable", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Accept": "application/json", + }, + body=None, + response_type=widgets_models.DevModeSettingsV2, + request_timeout=request_timeout, + throwable_errors={ + "EnableDevModeSettingsV2PermissionDenied": widgets_errors.EnableDevModeSettingsV2PermissionDenied, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def set_widget_set_manifest( + self, + *, + manifest: typing.Any, + widget_set_rid: widgets_models.WidgetSetRid, + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> typing.Awaitable[widgets_models.DevModeSettingsV2]: + """ + Set the dev mode settings for the given widget set using the manifest format. + The request body is a dev settings manifest JSON object with the following + structure: + + { + "manifestVersion": "1.0.0", + "devSettings": { + "baseHref": "...", + "widgets": { ... }, + "inputSpec": { ... } + } + } + + See https://github.com/palantir/osdk-ts for the widget library API types for the + dev settings manifest. + + :param manifest: + :type manifest: Any + :param widget_set_rid: + :type widget_set_rid: WidgetSetRid + :param preview: Enables the use of preview functionality. + :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: typing.Awaitable[widgets_models.DevModeSettingsV2] + + :raises InvalidDevModeBaseHref: The base href in the dev mode settings is invalid. It must be a valid localhost URL with an optional port. + :raises InvalidDevModeEntrypointCssCount: The dev mode settings contains too many CSS entrypoints. You must limit the number of CSS entrypoints to the maximum allowed. + :raises InvalidDevModeEntrypointJsCount: The dev mode settings contains too many JavaScript entrypoints. You must limit the number of JavaScript entrypoints to the maximum allowed. + :raises InvalidDevModeFilePath: The dev mode settings contains an invalid entrypoint file path. The file path must be a valid localhost URL with an optional port and a file path. + :raises InvalidDevModeWidgetSettingsCount: The dev mode settings contains too many widget settings. You must limit the number of widget settings to the maximum allowed. + :raises InvalidManifest: The provided manifest could not be parsed or is not well formed. + :raises SetWidgetSetManifestDevModeSettingsV2PermissionDenied: Could not setWidgetSetManifest the DevModeSettingsV2. + :raises WidgetIdNotFound: A non-existent widget id was provided. If creating a new widget, you must first publish your changes before previewing with developer mode. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="POST", + resource_path="/v2/widgets/devModeSettingsV2/setWidgetSetManifest", + query_params={ + "preview": preview, + }, + path_params={}, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body=widgets_models.SetWidgetSetManifestDevModeSettingsV2Request( + widget_set_rid=widget_set_rid, + manifest=manifest, + ), + response_type=widgets_models.DevModeSettingsV2, + request_timeout=request_timeout, + throwable_errors={ + "InvalidDevModeBaseHref": widgets_errors.InvalidDevModeBaseHref, + "InvalidDevModeEntrypointCssCount": widgets_errors.InvalidDevModeEntrypointCssCount, + "InvalidDevModeEntrypointJsCount": widgets_errors.InvalidDevModeEntrypointJsCount, + "InvalidDevModeFilePath": widgets_errors.InvalidDevModeFilePath, + "InvalidDevModeWidgetSettingsCount": widgets_errors.InvalidDevModeWidgetSettingsCount, + "InvalidManifest": widgets_errors.InvalidManifest, + "SetWidgetSetManifestDevModeSettingsV2PermissionDenied": widgets_errors.SetWidgetSetManifestDevModeSettingsV2PermissionDenied, + "WidgetIdNotFound": widgets_errors.WidgetIdNotFound, + }, + response_mode=_sdk_internal.get("response_mode"), + ), + ) + + +class _AsyncDevModeSettingsV2ClientRaw: + def __init__(self, client: AsyncDevModeSettingsV2Client) -> None: + def enable(_: widgets_models.DevModeSettingsV2): ... + def set_widget_set_manifest(_: widgets_models.DevModeSettingsV2): ... + + self.enable = core.async_with_raw_response(enable, client.enable) + self.set_widget_set_manifest = core.async_with_raw_response( + set_widget_set_manifest, client.set_widget_set_manifest + ) + + +class _AsyncDevModeSettingsV2ClientStreaming: + def __init__(self, client: AsyncDevModeSettingsV2Client) -> None: + def enable(_: widgets_models.DevModeSettingsV2): ... + def set_widget_set_manifest(_: widgets_models.DevModeSettingsV2): ... + + self.enable = core.async_with_streaming_response(enable, client.enable) + self.set_widget_set_manifest = core.async_with_streaming_response( + set_widget_set_manifest, client.set_widget_set_manifest + ) diff --git a/foundry_sdk/v2/widgets/errors.py b/foundry_sdk/v2/widgets/errors.py index 10baf0b2f..195ca56ba 100644 --- a/foundry_sdk/v2/widgets/errors.py +++ b/foundry_sdk/v2/widgets/errors.py @@ -42,42 +42,29 @@ class DeleteReleasePermissionDenied(errors.PermissionDeniedError): error_instance_id: str -class DevModeSettingsNotFoundParameters(typing_extensions.TypedDict): - """The given DevModeSettings could not be found.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class DevModeSettingsNotFound(errors.NotFoundError): - name: typing.Literal["DevModeSettingsNotFound"] - parameters: DevModeSettingsNotFoundParameters - error_instance_id: str - - -class DisableDevModeSettingsPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not disable the DevModeSettings.""" +class EnableDevModeSettingsPermissionDeniedParameters(typing_extensions.TypedDict): + """Could not enable the DevModeSettings.""" __pydantic_config__ = {"extra": "allow"} # type: ignore @dataclass -class DisableDevModeSettingsPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["DisableDevModeSettingsPermissionDenied"] - parameters: DisableDevModeSettingsPermissionDeniedParameters +class EnableDevModeSettingsPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["EnableDevModeSettingsPermissionDenied"] + parameters: EnableDevModeSettingsPermissionDeniedParameters error_instance_id: str -class EnableDevModeSettingsPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not enable the DevModeSettings.""" +class EnableDevModeSettingsV2PermissionDeniedParameters(typing_extensions.TypedDict): + """Could not enable the DevModeSettingsV2.""" __pydantic_config__ = {"extra": "allow"} # type: ignore @dataclass -class EnableDevModeSettingsPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["EnableDevModeSettingsPermissionDenied"] - parameters: EnableDevModeSettingsPermissionDeniedParameters +class EnableDevModeSettingsV2PermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["EnableDevModeSettingsV2PermissionDenied"] + parameters: EnableDevModeSettingsV2PermissionDeniedParameters error_instance_id: str @@ -116,19 +103,6 @@ class FileSizeLimitExceeded(errors.BadRequestError): error_instance_id: str -class GetDevModeSettingsPermissionDeniedParameters(typing_extensions.TypedDict): - """The provided token does not have permission to access dev mode settings.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class GetDevModeSettingsPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["GetDevModeSettingsPermissionDenied"] - parameters: GetDevModeSettingsPermissionDeniedParameters - error_instance_id: str - - class InvalidDevModeBaseHrefParameters(typing_extensions.TypedDict): """ The base href in the dev mode settings is invalid. It must be a valid localhost URL @@ -390,10 +364,7 @@ class InvalidFilePath(errors.BadRequestError): class InvalidManifestParameters(typing_extensions.TypedDict): - """ - The manifest file in the .zip archive at the path `.palantir/widgets.config.json` - could not be found or is not well formed. - """ + """The provided manifest could not be parsed or is not well formed.""" __pydantic_config__ = {"extra": "allow"} # type: ignore @@ -617,19 +588,6 @@ class OntologySdkNotFound(errors.NotFoundError): error_instance_id: str -class PauseDevModeSettingsPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not pause the DevModeSettings.""" - - __pydantic_config__ = {"extra": "allow"} # type: ignore - - -@dataclass -class PauseDevModeSettingsPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["PauseDevModeSettingsPermissionDenied"] - parameters: PauseDevModeSettingsPermissionDeniedParameters - error_instance_id: str - - class PublishReleasePermissionDeniedParameters(typing_extensions.TypedDict): """Could not publish the Repository.""" @@ -694,16 +652,16 @@ class SetWidgetSetDevModeSettingsByIdPermissionDenied(errors.PermissionDeniedErr error_instance_id: str -class SetWidgetSetDevModeSettingsPermissionDeniedParameters(typing_extensions.TypedDict): - """Could not setWidgetSet the DevModeSettings.""" +class SetWidgetSetManifestDevModeSettingsV2PermissionDeniedParameters(typing_extensions.TypedDict): + """Could not setWidgetSetManifest the DevModeSettingsV2.""" __pydantic_config__ = {"extra": "allow"} # type: ignore @dataclass -class SetWidgetSetDevModeSettingsPermissionDenied(errors.PermissionDeniedError): - name: typing.Literal["SetWidgetSetDevModeSettingsPermissionDenied"] - parameters: SetWidgetSetDevModeSettingsPermissionDeniedParameters +class SetWidgetSetManifestDevModeSettingsV2PermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["SetWidgetSetManifestDevModeSettingsV2PermissionDenied"] + parameters: SetWidgetSetManifestDevModeSettingsV2PermissionDeniedParameters error_instance_id: str @@ -795,12 +753,10 @@ class WidgetSetNotFound(errors.NotFoundError): __all__ = [ "DeleteReleasePermissionDenied", - "DevModeSettingsNotFound", - "DisableDevModeSettingsPermissionDenied", "EnableDevModeSettingsPermissionDenied", + "EnableDevModeSettingsV2PermissionDenied", "FileCountLimitExceeded", "FileSizeLimitExceeded", - "GetDevModeSettingsPermissionDenied", "InvalidDevModeBaseHref", "InvalidDevModeEntrypointCssCount", "InvalidDevModeEntrypointJsCount", @@ -830,12 +786,11 @@ class WidgetSetNotFound(errors.NotFoundError): "InvalidWidgetId", "InvalidWidgetName", "OntologySdkNotFound", - "PauseDevModeSettingsPermissionDenied", "PublishReleasePermissionDenied", "ReleaseNotFound", "RepositoryNotFound", "SetWidgetSetDevModeSettingsByIdPermissionDenied", - "SetWidgetSetDevModeSettingsPermissionDenied", + "SetWidgetSetManifestDevModeSettingsV2PermissionDenied", "VersionAlreadyExists", "VersionLimitExceeded", "WidgetIdNotFound", diff --git a/foundry_sdk/v2/widgets/models.py b/foundry_sdk/v2/widgets/models.py index 3880ba401..3ea2c4e7e 100644 --- a/foundry_sdk/v2/widgets/models.py +++ b/foundry_sdk/v2/widgets/models.py @@ -31,6 +31,31 @@ class DevModeSettings(core.ModelBase): """The dev mode settings for each widget set, keyed by widget set RID.""" +class DevModeSettingsV2(core.ModelBase): + """DevModeSettingsV2""" + + status: DevModeStatus + snapshot: typing.Optional[DevModeSnapshot] = None + """The content-addressed snapshot of the current dev mode settings, if any.""" + + +class DevModeSnapshot(core.ModelBase): + """ + A content-addressed snapshot of the dev mode settings. Snapshots are immutable + and identified by their content-addressed ID. + """ + + snapshot_id: DevModeSnapshotId = pydantic.Field(alias=str("snapshotId")) # type: ignore[literal-required] + """The content-addressed identifier for this snapshot.""" + + widget_set_settings: typing.Dict[WidgetSetRid, WidgetSetDevModeSettingsV2] = pydantic.Field(alias=str("widgetSetSettings")) # type: ignore[literal-required] + """The dev mode settings for each widget set, keyed by widget set RID.""" + + +DevModeSnapshotId = str +"""A content-addressed identifier for a dev mode settings snapshot.""" + + DevModeStatus = typing.Literal["ENABLED", "PAUSED", "DISABLED"] """The user's global development mode status for widget sets.""" @@ -46,6 +71,24 @@ class ListReleasesResponse(core.ModelBase): next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] +class OntologySdkInputSpec(core.ModelBase): + """A specification of an Ontology SDK used by a widget set.""" + + sdk_package_rid: OntologySdkPackageRid = pydantic.Field(alias=str("sdkPackageRid")) # type: ignore[literal-required] + """The RID of the Ontology SDK package.""" + + sdk_version: OntologySdkVersion = pydantic.Field(alias=str("sdkVersion")) # type: ignore[literal-required] + """The version of the Ontology SDK.""" + + +OntologySdkPackageRid = core.RID +"""A Resource Identifier (RID) identifying an Ontology SDK package.""" + + +OntologySdkVersion = str +"""A limited semver version string of the format major.minor.patch.""" + + class Release(core.ModelBase): """Release""" @@ -126,11 +169,11 @@ class SetWidgetSetDevModeSettingsByIdRequest(core.ModelBase): settings: WidgetSetDevModeSettingsById -class SetWidgetSetDevModeSettingsRequest(core.ModelBase): - """SetWidgetSetDevModeSettingsRequest""" +class SetWidgetSetManifestDevModeSettingsV2Request(core.ModelBase): + """SetWidgetSetManifestDevModeSettingsV2Request""" widget_set_rid: WidgetSetRid = pydantic.Field(alias=str("widgetSetRid")) # type: ignore[literal-required] - settings: WidgetSetDevModeSettings + manifest: typing.Any class StylesheetEntrypoint(core.ModelBase): @@ -156,6 +199,22 @@ class WidgetDevModeSettings(core.ModelBase): """The entrypoint CSS files for the widget.""" +class WidgetDevModeSettingsV2(core.ModelBase): + """The settings for a given widget in development mode (v2).""" + + name: typing.Optional[str] = None + """The display name of the widget.""" + + description: typing.Optional[str] = None + """A description of the widget.""" + + script_entrypoints: typing.List[ScriptEntrypoint] = pydantic.Field(alias=str("scriptEntrypoints")) # type: ignore[literal-required] + """The entrypoint JavaScript files for the widget.""" + + stylesheet_entrypoints: typing.List[StylesheetEntrypoint] = pydantic.Field(alias=str("stylesheetEntrypoints")) # type: ignore[literal-required] + """The entrypoint CSS files for the widget.""" + + WidgetId = str """ Human readable ID for a widget. Must be unique within a widget set. @@ -205,15 +264,44 @@ class WidgetSetDevModeSettingsById(core.ModelBase): """The dev mode settings for each widget in the widget set, keyed by widget IDs.""" +class WidgetSetDevModeSettingsV2(core.ModelBase): + """The settings for a widget set in development mode (v2), keyed by widget ID.""" + + base_href: str = pydantic.Field(alias=str("baseHref")) # type: ignore[literal-required] + """The base path for the HTML file used to render the widget in dev mode.""" + + input_spec: typing.Optional[WidgetSetInputSpec] = pydantic.Field(alias=str("inputSpec"), default=None) # type: ignore[literal-required] + """The input spec for the widget set in dev mode.""" + + widget_settings: typing.Dict[WidgetId, WidgetDevModeSettingsV2] = pydantic.Field(alias=str("widgetSettings")) # type: ignore[literal-required] + """The dev mode settings for each widget in the widget set, keyed by widget IDs.""" + + +class WidgetSetInputSpec(core.ModelBase): + """ + A specification of the Foundry data inputs that a widget set uses. This restricts + the data access that a widget set has at runtime. + """ + + sdks: typing.List[OntologySdkInputSpec] + """The Ontology SDK specifications used by the widget set.""" + + WidgetSetRid = core.RID """A Resource Identifier (RID) identifying a widget set.""" __all__ = [ "DevModeSettings", + "DevModeSettingsV2", + "DevModeSnapshot", + "DevModeSnapshotId", "DevModeStatus", "FilePath", "ListReleasesResponse", + "OntologySdkInputSpec", + "OntologySdkPackageRid", + "OntologySdkVersion", "Release", "ReleaseLocator", "ReleaseVersion", @@ -223,13 +311,16 @@ class WidgetSetDevModeSettingsById(core.ModelBase): "ScriptEntrypoint", "ScriptType", "SetWidgetSetDevModeSettingsByIdRequest", - "SetWidgetSetDevModeSettingsRequest", + "SetWidgetSetManifestDevModeSettingsV2Request", "StylesheetEntrypoint", "WidgetDevModeSettings", + "WidgetDevModeSettingsV2", "WidgetId", "WidgetRid", "WidgetSet", "WidgetSetDevModeSettings", "WidgetSetDevModeSettingsById", + "WidgetSetDevModeSettingsV2", + "WidgetSetInputSpec", "WidgetSetRid", ] diff --git a/tests/test_resource_import.py b/tests/test_resource_import.py index 2a1e04b23..6606cd318 100644 --- a/tests/test_resource_import.py +++ b/tests/test_resource_import.py @@ -691,6 +691,12 @@ def test_widgets_v2_dev_mode_settings_import(): assert DevModeSettingsClient is not None +def test_widgets_v2_dev_mode_settings_v2_import(): + from foundry_sdk.v2.widgets.dev_mode_settings_v2 import DevModeSettingsV2Client + + assert DevModeSettingsV2Client is not None + + def test_widgets_v2_release_import(): from foundry_sdk.v2.widgets.release import ReleaseClient